Documentation
¶
Index ¶
Constants ¶
View Source
const ( ConnectModeSTA = iota // Connect as Wifi station (default) ConnectModeAP // Connect as Wifi Access Point )
Connect modes
View Source
const ( AuthTypeWPA2 = iota // WPA2 authorization (default) AuthTypeOpen // No authorization required (open) AuthTypeWPA // WPA authorization AuthTypeWPA2Mixed // WPA2/WPA mixed authorization )
Wifi authorization types. Used when setting up an access point, or connecting to an access point
View Source
const DefaultConnectTimeout = 10 * time.Second
Variables ¶
View Source
var ( ErrConnected = errors.New("Already connected") ErrConnectFailed = errors.New("Connect failed") ErrConnectTimeout = errors.New("Connect timed out") ErrMissingSSID = errors.New("Missing WiFi SSID") ErrShortPassphrase = errors.New("Invalid Wifi Passphrase < 8 chars") ErrAuthFailure = errors.New("Wifi authentication failure") ErrAuthTypeNoGood = errors.New("Wifi authorization type not supported") ErrConnectModeNoGood = errors.New("Connect mode not supported") ErrNotSupported = errors.New("Not supported") )
Functions ¶
This section is empty.
Types ¶
type ConnectMode ¶
type ConnectMode int
type ConnectParams ¶
type ConnectParams struct { // Connect mode ConnectMode // SSID of Wifi AP Ssid string // Passphrase of Wifi AP Passphrase string // Wifi authorization type AuthType // Wifi country code as two-char string. E.g. "XX" for world-wide, // "US" for USA, etc. Country string // Retries is how many attempts to connect before returning with a // "Connect failed" error. Zero means infinite retries. Retries int // Timeout duration for each connection attempt. The default zero // value means 10sec. ConnectTimeout time.Duration // Watchdog ticker duration. On tick, the watchdog will check for // downed connection or hardware fault and try to recover the // connection. Set to zero to disable watchodog. WatchdogTimeout time.Duration }
type Netlinker ¶
type Netlinker interface { // Connect device to network NetConnect(params *ConnectParams) error // Disconnect device from network NetDisconnect() // Notify to register callback for network events NetNotify(cb func(Event)) // GetHardwareAddr returns device MAC address GetHardwareAddr() (net.HardwareAddr, error) }
Click to show internal directories.
Click to hide internal directories.