Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: WiFiConfigPayload

(message has no fields)

Used in: WiFiConfigPayload

(message has no fields)

Used in: WiFiScanPayload

• uint32 start_index = 1

• uint32 count = 2

Used in: WiFiScanPayload

• bool blocking = 1

• bool passive = 2

• uint32 group_channels = 3

• uint32 period_ms = 4

Used in: WiFiScanPayload

(message has no fields)

Used in: WiFiConfigPayload

• bytes ssid = 1

• bytes passphrase = 2

• bytes bssid = 3

• int32 channel = 4

Used in: WiFiConfigPayload

• Status status = 1

Used in: WiFiConfigPayload

• Status status = 1

• WifiStationState sta_state = 2

• oneof state

  • WifiConnectFailedReason fail_reason = 10

  • WifiConnectedState connected = 11

Used in: WiFiScanPayload

• repeated WiFiScanResult entries = 1

Used in: WiFiScanPayload

(message has no fields)

Used in: WiFiScanPayload

• bool scan_finished = 1

• uint32 result_count = 2

Used in: WiFiConfigPayload

• Status status = 1

Data structure of Session command/request packet

Used in: Sec0Payload

(message has no fields)

Data structure of Session response packet

Used in: Sec0Payload

• Status status = 1

A message must be of type Cmd or Resp

Used in: Sec0Payload

• S0_Session_Command = 0

• S0_Session_Response = 1

Payload structure of session data

Used in: SessionData

• Sec0MsgType msg = 1

  !< Type of message

• oneof payload

  • S0SessionCmd sc = 20

    !< Payload data interpreted as Cmd

  • S0SessionResp sr = 21

    !< Payload data interpreted as Resp

A message must be of type Cmd0 / Cmd1 / Resp0 / Resp1

Used in: Sec1Payload

• Session_Command0 = 0

• Session_Response0 = 1

• Session_Command1 = 2

• Session_Response1 = 3

Payload structure of session data

Used in: SessionData

• Sec1MsgType msg = 1

  !< Type of message

• oneof payload

  • SessionCmd0 sc0 = 20

    !< Payload data interpreted as Cmd0

  • SessionResp0 sr0 = 21

    !< Payload data interpreted as Resp0

  • SessionCmd1 sc1 = 22

    !< Payload data interpreted as Cmd1

  • SessionResp1 sr1 = 23

    !< Payload data interpreted as Resp1

Allowed values for the type of security being used in a protocomm session

Used in: SessionData

• SecScheme0 = 0

  !< Unsecured - plaintext communication

• SecScheme1 = 1

  !< Security scheme 1 - Curve25519 + AES-256-CTR

Data structure of Session command0 packet

Used in: Sec1Payload

• bytes client_pubkey = 1

Data structure of Session command1 packet

Used in: Sec1Payload

• bytes client_verify_data = 2

Data structure exchanged when establishing secure session between Host and Client

• SecSchemeVersion sec_ver = 2

  !< Type of security

• oneof proto

  • Sec0Payload sec0 = 10

    !< Payload data in case of security 0

  • Sec1Payload sec1 = 11

    !< Payload data in case of security 1

Data structure of Session response0 packet

Used in: Sec1Payload

• Status status = 1

• bytes device_pubkey = 2

• bytes device_random = 3

Data structure of Session response1 packet

Used in: Sec1Payload

• Status status = 1

• bytes device_verify_data = 3

Allowed values for the status of a protocomm instance

Used in: RespApplyConfig, RespGetStatus, RespSetConfig, S0SessionResp, SessionResp0, SessionResp1, WiFiScanPayload

• Success = 0

• InvalidSecScheme = 1

• InvalidProto = 2

• TooManySessions = 3

• InvalidArgument = 4

• InternalError = 5

• CryptoError = 6

• InvalidSession = 7

Used in: WiFiConfigPayload

• TypeCmdGetStatus = 0

• TypeRespGetStatus = 1

• TypeCmdSetConfig = 2

• TypeRespSetConfig = 3

• TypeCmdApplyConfig = 4

• TypeRespApplyConfig = 5

• WiFiConfigMsgType msg = 1

• oneof payload

  • CmdGetStatus cmd_get_status = 10

  • RespGetStatus resp_get_status = 11

  • CmdSetConfig cmd_set_config = 12

  • RespSetConfig resp_set_config = 13

  • CmdApplyConfig cmd_apply_config = 14

  • RespApplyConfig resp_apply_config = 15

Used in: WiFiScanPayload

• TypeCmdScanStart = 0

• TypeRespScanStart = 1

• TypeCmdScanStatus = 2

• TypeRespScanStatus = 3

• TypeCmdScanResult = 4

• TypeRespScanResult = 5

• WiFiScanMsgType msg = 1

• Status status = 2

• oneof payload

  • CmdScanStart cmd_scan_start = 10

  • RespScanStart resp_scan_start = 11

  • CmdScanStatus cmd_scan_status = 12

  • RespScanStatus resp_scan_status = 13

  • CmdScanResult cmd_scan_result = 14

  • RespScanResult resp_scan_result = 15

Used in: RespScanResult

• bytes ssid = 1

• uint32 channel = 2

• int32 rssi = 3

Used in: WifiConnectedState

• Open = 0

• WEP = 1

• WPA_PSK = 2

• WPA2_PSK = 3

• WPA_WPA2_PSK = 4

• WPA2_ENTERPRISE = 5

Used in: RespGetStatus

• AuthError = 0

• NetworkNotFound = 1

Used in: RespGetStatus

• string ip4_addr = 1

• WifiAuthMode auth_mode = 2

• bytes ssid = 3

• bytes bssid = 4

• int32 channel = 5

Used in: RespGetStatus

• Connected = 0

• Connecting = 1

• Disconnected = 2

• ConnectionFailed = 3