Package-level declarations

Types

Link copied to clipboard
enum AuthMode : Enum<AuthMode> , WireEnum
enum AuthMode : Enum<AuthMode> , WireEnum

Wi-Fi Authentication Mode.

Link copied to clipboard
enum Band : Enum<Band> , WireEnum
enum Band : Enum<Band> , WireEnum

Wi-Fi Band.

Link copied to clipboard

Connection failure reason.

Link copied to clipboard
class ConnectionInfo(val ip4_addr: ByteString? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<ConnectionInfo, Nothing>
class ConnectionInfo(val ip4_addr: ByteString? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<ConnectionInfo, Nothing>

Responses Information about the Wi-Fi connected state.

Link copied to clipboard

The state of Wi-Fi station.

Link copied to clipboard
class DeviceStatus(val state: ConnectionState? = null, val provisioning_info: WifiInfo? = null, val connection_info: ConnectionInfo? = null, val scan_info: ScanParams? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<DeviceStatus, Nothing>
class DeviceStatus(val state: ConnectionState? = null, val provisioning_info: WifiInfo? = null, val connection_info: ConnectionInfo? = null, val scan_info: ScanParams? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<DeviceStatus, Nothing>

Response payload for GET_STATUS request.

Link copied to clipboard
class Info(val version: Int, unknownFields: ByteString = ByteString.EMPTY) : Message<Info, Nothing>
class Info(val version: Int, unknownFields: ByteString = ByteString.EMPTY) : Message<Info, Nothing>

Response payload for returned from Version characteristic.

Link copied to clipboard
enum OpCode : Enum<OpCode> , WireEnum
enum OpCode : Enum<OpCode> , WireEnum

Common ENUMs The Op Code for requests.

Link copied to clipboard
class Request(val op_code: OpCode? = null, val scan_params: ScanParams? = null, val config: WifiConfig? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<Request, Nothing>
class Request(val op_code: OpCode? = null, val scan_params: ScanParams? = null, val config: WifiConfig? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<Request, Nothing>

The request type, sent to the device.

Link copied to clipboard
class Response(val request_op_code: OpCode? = null, val status: Status? = null, val device_status: DeviceStatus? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<Response, Nothing>
class Response(val request_op_code: OpCode? = null, val status: Status? = null, val device_status: DeviceStatus? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<Response, Nothing>

A response type which is sent back from the device.

Link copied to clipboard
class Result(val scan_record: ScanRecord? = null, val state: ConnectionState? = null, val reason: ConnectionFailureReason? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<Result, Nothing>
class Result(val scan_record: ScanRecord? = null, val state: ConnectionState? = null, val reason: ConnectionFailureReason? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<Result, Nothing>

This type is returned by the Data Out characteristic using notifications. Scan records are returned when WiFi scanning is enabled. WiFi state is notified whenever connection state changes, or during provisioning.

Link copied to clipboard
class ScanParams(val band: Band? = null, val passive: Boolean? = null, val period_ms: Int? = null, val group_channels: Int? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<ScanParams, Nothing>
class ScanParams(val band: Band? = null, val passive: Boolean? = null, val period_ms: Int? = null, val group_channels: Int? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<ScanParams, Nothing>

Scanning parameters.

Link copied to clipboard
class ScanRecord(val wifi: WifiInfo? = null, val rssi: Int? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<ScanRecord, Nothing>
class ScanRecord(val wifi: WifiInfo? = null, val rssi: Int? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<ScanRecord, Nothing>

States are sent over Data Out characteristic Single Wi-Fi scan result.

Link copied to clipboard
enum Status : Enum<Status> , WireEnum
enum Status : Enum<Status> , WireEnum

Response status code.

Link copied to clipboard
class WifiConfig(val wifi: WifiInfo? = null, val passphrase: ByteString? = null, val volatileMemory: Boolean? = null, val anyChannel: Boolean? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<WifiConfig, Nothing>
class WifiConfig(val wifi: WifiInfo? = null, val passphrase: ByteString? = null, val volatileMemory: Boolean? = null, val anyChannel: Boolean? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<WifiConfig, Nothing>

Requests Wi-Fi provisioning configuration for SET_CONFIG request.

Link copied to clipboard
class WifiInfo(val ssid: ByteString, val bssid: ByteString, val band: Band? = null, val channel: Int, val auth: AuthMode? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<WifiInfo, Nothing>
class WifiInfo(val ssid: ByteString, val bssid: ByteString, val band: Band? = null, val channel: Int, val auth: AuthMode? = null, unknownFields: ByteString = ByteString.EMPTY) : Message<WifiInfo, Nothing>

Wi-Fi details.