# Protocol Documentation
## Table of Contents
- [cellular.proto](#cellular-proto)
- [AccessPoint](#particle-ctrl-cellular-AccessPoint)
- [GetAccessPointReply](#particle-ctrl-cellular-GetAccessPointReply)
- [GetAccessPointRequest](#particle-ctrl-cellular-GetAccessPointRequest)
- [GetActiveSimReply](#particle-ctrl-cellular-GetActiveSimReply)
- [GetActiveSimRequest](#particle-ctrl-cellular-GetActiveSimRequest)
- [GetIccidReply](#particle-ctrl-cellular-GetIccidReply)
- [GetIccidRequest](#particle-ctrl-cellular-GetIccidRequest)
- [SetAccessPointReply](#particle-ctrl-cellular-SetAccessPointReply)
- [SetAccessPointRequest](#particle-ctrl-cellular-SetAccessPointRequest)
- [SetActiveSimReply](#particle-ctrl-cellular-SetActiveSimReply)
- [SetActiveSimRequest](#particle-ctrl-cellular-SetActiveSimRequest)
- [SimType](#particle-ctrl-cellular-SimType)
- [cloud.proto](#cloud-proto)
- [ConnectReply](#particle-ctrl-cloud-ConnectReply)
- [ConnectRequest](#particle-ctrl-cloud-ConnectRequest)
- [DisconnectReply](#particle-ctrl-cloud-DisconnectReply)
- [DisconnectRequest](#particle-ctrl-cloud-DisconnectRequest)
- [GetConnectionStatusReply](#particle-ctrl-cloud-GetConnectionStatusReply)
- [GetConnectionStatusRequest](#particle-ctrl-cloud-GetConnectionStatusRequest)
- [ConnectionStatus](#particle-ctrl-cloud-ConnectionStatus)
- [common.proto](#common-proto)
- [IPAddress](#particle-ctrl-IPAddress)
- [IpAddress](#particle-ctrl-IpAddress)
- [Ipv4Address](#particle-ctrl-Ipv4Address)
- [Ipv6Address](#particle-ctrl-Ipv6Address)
- [IPAddress.Protocol](#particle-ctrl-IPAddress-Protocol)
- [ResultCode](#particle-ctrl-ResultCode)
- [config.proto](#config-proto)
- [GetDeviceIdReply](#particle-ctrl-GetDeviceIdReply)
- [GetDeviceIdRequest](#particle-ctrl-GetDeviceIdRequest)
- [GetDeviceModeReply](#particle-ctrl-GetDeviceModeReply)
- [GetDeviceModeRequest](#particle-ctrl-GetDeviceModeRequest)
- [GetFeatureReply](#particle-ctrl-GetFeatureReply)
- [GetFeatureRequest](#particle-ctrl-GetFeatureRequest)
- [GetNcpFirmwareVersionReply](#particle-ctrl-GetNcpFirmwareVersionReply)
- [GetNcpFirmwareVersionRequest](#particle-ctrl-GetNcpFirmwareVersionRequest)
- [GetSecurityKeyReply](#particle-ctrl-GetSecurityKeyReply)
- [GetSecurityKeyRequest](#particle-ctrl-GetSecurityKeyRequest)
- [GetSerialNumberReply](#particle-ctrl-GetSerialNumberReply)
- [GetSerialNumberRequest](#particle-ctrl-GetSerialNumberRequest)
- [GetServerAddressReply](#particle-ctrl-GetServerAddressReply)
- [GetServerAddressRequest](#particle-ctrl-GetServerAddressRequest)
- [GetServerProtocolReply](#particle-ctrl-GetServerProtocolReply)
- [GetServerProtocolRequest](#particle-ctrl-GetServerProtocolRequest)
- [GetSystemCapabilitiesReply](#particle-ctrl-GetSystemCapabilitiesReply)
- [GetSystemCapabilitiesRequest](#particle-ctrl-GetSystemCapabilitiesRequest)
- [GetSystemVersionReply](#particle-ctrl-GetSystemVersionReply)
- [GetSystemVersionRequest](#particle-ctrl-GetSystemVersionRequest)
- [IsClaimedReply](#particle-ctrl-IsClaimedReply)
- [IsClaimedRequest](#particle-ctrl-IsClaimedRequest)
- [IsDeviceSetupDoneReply](#particle-ctrl-IsDeviceSetupDoneReply)
- [IsDeviceSetupDoneRequest](#particle-ctrl-IsDeviceSetupDoneRequest)
- [SetClaimCodeReply](#particle-ctrl-SetClaimCodeReply)
- [SetClaimCodeRequest](#particle-ctrl-SetClaimCodeRequest)
- [SetDeviceSetupDoneReply](#particle-ctrl-SetDeviceSetupDoneReply)
- [SetDeviceSetupDoneRequest](#particle-ctrl-SetDeviceSetupDoneRequest)
- [SetFeatureReply](#particle-ctrl-SetFeatureReply)
- [SetFeatureRequest](#particle-ctrl-SetFeatureRequest)
- [SetSecurityKeyReply](#particle-ctrl-SetSecurityKeyReply)
- [SetSecurityKeyRequest](#particle-ctrl-SetSecurityKeyRequest)
- [SetServerAddressReply](#particle-ctrl-SetServerAddressReply)
- [SetServerAddressRequest](#particle-ctrl-SetServerAddressRequest)
- [SetServerProtocolReply](#particle-ctrl-SetServerProtocolReply)
- [SetServerProtocolRequest](#particle-ctrl-SetServerProtocolRequest)
- [SetSoftApSsidReply](#particle-ctrl-SetSoftApSsidReply)
- [SetSoftApSsidRequest](#particle-ctrl-SetSoftApSsidRequest)
- [SetStartupModeReply](#particle-ctrl-SetStartupModeReply)
- [SetStartupModeRequest](#particle-ctrl-SetStartupModeRequest)
- [StartListeningModeReply](#particle-ctrl-StartListeningModeReply)
- [StartListeningModeRequest](#particle-ctrl-StartListeningModeRequest)
- [StartNyanSignalReply](#particle-ctrl-StartNyanSignalReply)
- [StartNyanSignalRequest](#particle-ctrl-StartNyanSignalRequest)
- [StopListeningModeReply](#particle-ctrl-StopListeningModeReply)
- [StopListeningModeRequest](#particle-ctrl-StopListeningModeRequest)
- [StopNyanSignalReply](#particle-ctrl-StopNyanSignalReply)
- [StopNyanSignalRequest](#particle-ctrl-StopNyanSignalRequest)
- [SystemResetReply](#particle-ctrl-SystemResetReply)
- [SystemResetRequest](#particle-ctrl-SystemResetRequest)
- [DeviceMode](#particle-ctrl-DeviceMode)
- [Feature](#particle-ctrl-Feature)
- [SecurityKeyType](#particle-ctrl-SecurityKeyType)
- [ServerProtocolType](#particle-ctrl-ServerProtocolType)
- [SystemCapabilityFlag](#particle-ctrl-SystemCapabilityFlag)
- [extensions.proto](#extensions-proto)
- [File-level Extensions](#extensions-proto-extensions)
- [File-level Extensions](#extensions-proto-extensions)
- [network.proto](#network-proto)
- [DNSConfiguration](#particle-ctrl-DNSConfiguration)
- [GetInterfaceListReply](#particle-ctrl-GetInterfaceListReply)
- [GetInterfaceListRequest](#particle-ctrl-GetInterfaceListRequest)
- [GetInterfaceReply](#particle-ctrl-GetInterfaceReply)
- [GetInterfaceRequest](#particle-ctrl-GetInterfaceRequest)
- [IPConfiguration](#particle-ctrl-IPConfiguration)
- [Interface](#particle-ctrl-Interface)
- [InterfaceAddress](#particle-ctrl-InterfaceAddress)
- [InterfaceEntry](#particle-ctrl-InterfaceEntry)
- [Ipv4Config](#particle-ctrl-Ipv4Config)
- [Ipv6Config](#particle-ctrl-Ipv6Config)
- [NetworkConfiguration](#particle-ctrl-NetworkConfiguration)
- [NetworkGetConfigurationReply](#particle-ctrl-NetworkGetConfigurationReply)
- [NetworkGetConfigurationRequest](#particle-ctrl-NetworkGetConfigurationRequest)
- [NetworkGetStatusReply](#particle-ctrl-NetworkGetStatusReply)
- [NetworkGetStatusRequest](#particle-ctrl-NetworkGetStatusRequest)
- [NetworkSetConfigurationReply](#particle-ctrl-NetworkSetConfigurationReply)
- [NetworkSetConfigurationRequest](#particle-ctrl-NetworkSetConfigurationRequest)
- [IPConfiguration.Type](#particle-ctrl-IPConfiguration-Type)
- [InterfaceExtFlag](#particle-ctrl-InterfaceExtFlag)
- [InterfaceFlag](#particle-ctrl-InterfaceFlag)
- [InterfaceType](#particle-ctrl-InterfaceType)
- [NetworkState](#particle-ctrl-NetworkState)
- [storage.proto](#storage-proto)
- [CancelFirmwareUpdateReply](#particle-ctrl-CancelFirmwareUpdateReply)
- [CancelFirmwareUpdateRequest](#particle-ctrl-CancelFirmwareUpdateRequest)
- [ClearSectionDataReply](#particle-ctrl-ClearSectionDataReply)
- [ClearSectionDataRequest](#particle-ctrl-ClearSectionDataRequest)
- [DescribeStorageReply](#particle-ctrl-DescribeStorageReply)
- [DescribeStorageReply.Section](#particle-ctrl-DescribeStorageReply-Section)
- [DescribeStorageReply.Section.FirmwareModule](#particle-ctrl-DescribeStorageReply-Section-FirmwareModule)
- [DescribeStorageReply.Storage](#particle-ctrl-DescribeStorageReply-Storage)
- [DescribeStorageRequest](#particle-ctrl-DescribeStorageRequest)
- [FinishFirmwareUpdateReply](#particle-ctrl-FinishFirmwareUpdateReply)
- [FinishFirmwareUpdateRequest](#particle-ctrl-FinishFirmwareUpdateRequest)
- [FirmwareUpdateDataReply](#particle-ctrl-FirmwareUpdateDataReply)
- [FirmwareUpdateDataRequest](#particle-ctrl-FirmwareUpdateDataRequest)
- [GetModuleInfoReply](#particle-ctrl-GetModuleInfoReply)
- [GetModuleInfoReply.Dependency](#particle-ctrl-GetModuleInfoReply-Dependency)
- [GetModuleInfoReply.Module](#particle-ctrl-GetModuleInfoReply-Module)
- [GetModuleInfoRequest](#particle-ctrl-GetModuleInfoRequest)
- [GetSectionDataSizeReply](#particle-ctrl-GetSectionDataSizeReply)
- [GetSectionDataSizeRequest](#particle-ctrl-GetSectionDataSizeRequest)
- [ReadSectionDataReply](#particle-ctrl-ReadSectionDataReply)
- [ReadSectionDataRequest](#particle-ctrl-ReadSectionDataRequest)
- [StartFirmwareUpdateReply](#particle-ctrl-StartFirmwareUpdateReply)
- [StartFirmwareUpdateRequest](#particle-ctrl-StartFirmwareUpdateRequest)
- [WriteSectionDataReply](#particle-ctrl-WriteSectionDataReply)
- [WriteSectionDataRequest](#particle-ctrl-WriteSectionDataRequest)
- [FileFormat](#particle-ctrl-FileFormat)
- [FirmwareModuleType](#particle-ctrl-FirmwareModuleType)
- [FirmwareModuleValidityFlag](#particle-ctrl-FirmwareModuleValidityFlag)
- [SectionFlag](#particle-ctrl-SectionFlag)
- [SectionType](#particle-ctrl-SectionType)
- [StorageType](#particle-ctrl-StorageType)
- [wifi_new.proto](#wifi_new-proto)
- [ClearKnownNetworksReply](#particle-ctrl-wifi-ClearKnownNetworksReply)
- [ClearKnownNetworksRequest](#particle-ctrl-wifi-ClearKnownNetworksRequest)
- [Credentials](#particle-ctrl-wifi-Credentials)
- [GetCurrentNetworkReply](#particle-ctrl-wifi-GetCurrentNetworkReply)
- [GetCurrentNetworkRequest](#particle-ctrl-wifi-GetCurrentNetworkRequest)
- [GetKnownNetworksReply](#particle-ctrl-wifi-GetKnownNetworksReply)
- [GetKnownNetworksReply.Network](#particle-ctrl-wifi-GetKnownNetworksReply-Network)
- [GetKnownNetworksRequest](#particle-ctrl-wifi-GetKnownNetworksRequest)
- [JoinKnownNetworkReply](#particle-ctrl-wifi-JoinKnownNetworkReply)
- [JoinKnownNetworkRequest](#particle-ctrl-wifi-JoinKnownNetworkRequest)
- [JoinNewNetworkReply](#particle-ctrl-wifi-JoinNewNetworkReply)
- [JoinNewNetworkRequest](#particle-ctrl-wifi-JoinNewNetworkRequest)
- [RemoveKnownNetworkReply](#particle-ctrl-wifi-RemoveKnownNetworkReply)
- [RemoveKnownNetworkRequest](#particle-ctrl-wifi-RemoveKnownNetworkRequest)
- [ScanNetworksReply](#particle-ctrl-wifi-ScanNetworksReply)
- [ScanNetworksReply.Network](#particle-ctrl-wifi-ScanNetworksReply-Network)
- [ScanNetworksRequest](#particle-ctrl-wifi-ScanNetworksRequest)
- [CredentialsType](#particle-ctrl-wifi-CredentialsType)
- [Security](#particle-ctrl-wifi-Security)
- [Scalar Value Types](#scalar-value-types)
Top
## cellular.proto
### AccessPoint
Access point settings for 3rd party SIM credentials for the Cellular network.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| apn | [string](#string) | | APN |
| user | [string](#string) | | Username |
| password | [string](#string) | | Password |
| use_defaults | [bool](#bool) | | If `true`, it will restore the defaules |
### GetAccessPointReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| access_point | [AccessPoint](#particle-ctrl-cellular-AccessPoint) | | |
### GetAccessPointRequest
Get access point settings.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| sim_type | [SimType](#particle-ctrl-cellular-SimType) | | |
### GetActiveSimReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| sim_type | [SimType](#particle-ctrl-cellular-SimType) | | |
### GetActiveSimRequest
Get active SIM card.
### GetIccidReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| iccid | [string](#string) | | SIM ICCID |
### GetIccidRequest
Get ICCID.
### SetAccessPointReply
### SetAccessPointRequest
Set access point settings.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| sim_type | [SimType](#particle-ctrl-cellular-SimType) | | |
| access_point | [AccessPoint](#particle-ctrl-cellular-AccessPoint) | | |
### SetActiveSimReply
### SetActiveSimRequest
Set active SIM card.
Note: The device needs to be reset in order for the settings to take effect.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| sim_type | [SimType](#particle-ctrl-cellular-SimType) | | |
### SimType
SIM card types.
The Boron 2G/3G and Boron LTE can use either the built-in MFF2 embedded Particle SIM card or an external nano SIM card in the SIM card connector.
Note: The values of this enum should match the values defined by the `SimType` enum in the firmware.
| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID_SIM_TYPE | 0 | Invalid |
| INTERNAL | 1 | Built-in MFF2 embedded Particle SIM |
| EXTERNAL | 2 | External nano SIM card |
Top
## cloud.proto
### ConnectReply
### ConnectRequest
Connect to the cloud
### DisconnectReply
### DisconnectRequest
Disconnect from the cloud
### GetConnectionStatusReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| status | [ConnectionStatus](#particle-ctrl-cloud-ConnectionStatus) | | |
### GetConnectionStatusRequest
Get the cloud connection status
### ConnectionStatus
Make sure values of this enum match the values defined for the diagnostic info
| Name | Number | Description |
| ---- | ------ | ----------- |
| DISCONNECTED | 0 | |
| CONNECTING | 1 | |
| CONNECTED | 2 | |
| DISCONNECTING | 3 | |
Top
## common.proto
### IPAddress
Deprecated, IpAddress should be used instead
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| protocol | [IPAddress.Protocol](#particle-ctrl-IPAddress-Protocol) | | |
| address | [bytes](#bytes) | | |
### IpAddress
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| v4 | [Ipv4Address](#particle-ctrl-Ipv4Address) | | IP v4 address |
| v6 | [Ipv6Address](#particle-ctrl-Ipv6Address) | | IP v6 address |
### Ipv4Address
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [fixed32](#fixed32) | | |
### Ipv6Address
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [bytes](#bytes) | | |
### IPAddress.Protocol
| Name | Number | Description |
| ---- | ------ | ----------- |
| NONE | 0 | |
| IPv4 | 1 | |
| IPv6 | 2 | |
### ResultCode
The field numbers here are just protobuf details. The value to pay attention to
is the "int_value" option, which corresponds to the numeric value that will
be set in reply frames (which itself ultimately comes from the numeric values
in the system_error_t enum in the firmware code).
| Name | Number | Description |
| ---- | ------ | ----------- |
| OK | 0 | |
| NOT_ALLOWED | 1 | |
| TIMEOUT | 2 | |
| NOT_FOUND | 3 | |
| ALREADY_EXIST | 4 | |
| INVALID_STATE | 5 | |
| NO_MEMORY | 6 | |
| INVALID_PARAM | 7 | |
Top
## config.proto
### GetDeviceIdReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [string](#string) | | Device ID (hex-encoded) |
### GetDeviceIdRequest
Get the device ID
### GetDeviceModeReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| mode | [DeviceMode](#particle-ctrl-DeviceMode) | | |
### GetDeviceModeRequest
Get the current device mode
### GetFeatureReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| enabled | [bool](#bool) | | |
### GetFeatureRequest
Check if the system feature is enabled or disabled
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| feature | [Feature](#particle-ctrl-Feature) | | |
### GetNcpFirmwareVersionReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| version | [string](#string) | | NCP version in SemVer format |
| module_version | [uint32](#uint32) | | NCP module version |
### GetNcpFirmwareVersionRequest
Get the NCP (network coprocessor) firmware version
### GetSecurityKeyReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| data | [bytes](#bytes) | | Key data in DER format |
### GetSecurityKeyRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [SecurityKeyType](#particle-ctrl-SecurityKeyType) | | Key type |
### GetSerialNumberReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| serial | [string](#string) | | Device serial ID |
### GetSerialNumberRequest
Get the device's serial number
### GetServerAddressReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [string](#string) | | Server address |
| port | [int32](#int32) | | Port number |
### GetServerAddressRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| protocol | [ServerProtocolType](#particle-ctrl-ServerProtocolType) | | Protocol type |
### GetServerProtocolReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| protocol | [ServerProtocolType](#particle-ctrl-ServerProtocolType) | | Protocol type |
### GetServerProtocolRequest
### GetSystemCapabilitiesReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| flags | [fixed32](#fixed32) | | SystemCapabilityFlag flags |
### GetSystemCapabilitiesRequest
Get system capabilities
### GetSystemVersionReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| version | [string](#string) | | Device OS version in SemVer format |
### GetSystemVersionRequest
Get the firmware version
### IsClaimedReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| claimed | [bool](#bool) | | `true` if device is claimed |
### IsClaimedRequest
### IsDeviceSetupDoneReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| done | [bool](#bool) | | |
### IsDeviceSetupDoneRequest
Get the flag indicating if the device has been set up
### SetClaimCodeReply
### SetClaimCodeRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| code | [string](#string) | | Claim code |
### SetDeviceSetupDoneReply
### SetDeviceSetupDoneRequest
Set flag for setup being done
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| done | [bool](#bool) | | |
### SetFeatureReply
### SetFeatureRequest
Enable/disable system features
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| feature | [Feature](#particle-ctrl-Feature) | | |
| enabled | [bool](#bool) | | |
### SetSecurityKeyReply
### SetSecurityKeyRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [SecurityKeyType](#particle-ctrl-SecurityKeyType) | | Key type |
| data | [bytes](#bytes) | | Key data in DER format |
### SetServerAddressReply
### SetServerAddressRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| protocol | [ServerProtocolType](#particle-ctrl-ServerProtocolType) | | Protocol type |
| address | [string](#string) | | Server address |
| port | [int32](#int32) | | Port number |
### SetServerProtocolReply
### SetServerProtocolRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| protocol | [ServerProtocolType](#particle-ctrl-ServerProtocolType) | | Protocol type |
### SetSoftApSsidReply
### SetSoftApSsidRequest
Set the SoftAP SSID prefix and suffix
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| prefix | [string](#string) | | SSID prefix |
| suffix | [string](#string) | | SSID sufix |
### SetStartupModeReply
### SetStartupModeRequest
Set the mode to enter when in safe mode
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| mode | [DeviceMode](#particle-ctrl-DeviceMode) | | |
### StartListeningModeReply
### StartListeningModeRequest
Put the device into listening mode
### StartNyanSignalReply
### StartNyanSignalRequest
Make the device's status LED display a rainbow pattern aka Nyan mode
### StopListeningModeReply
### StopListeningModeRequest
Put the device into normal mode
### StopNyanSignalReply
### StopNyanSignalRequest
Exit the Nyan mode
### SystemResetReply
### SystemResetRequest
Resets the device, just like hitting the reset button or powering down and back up
### DeviceMode
Device mode
| Name | Number | Description |
| ---- | ------ | ----------- |
| NORMAL_MODE | 0 | Normal mode |
| LISTENING_MODE | 1 | Listening mode |
### Feature
System features
| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID_FEATURE | 0 | Invalid feature |
| ETHERNET_DETECTION | 1 | Ethernet FeatherWing detection on boot |
### SecurityKeyType
Note: Use the same values as defined by the security_key_type enum
| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID_SECURITY_KEY | 0 | Invalid key |
| TCP_DEVICE_PRIVATE_KEY | 1 | TCP device private key |
| TCP_DEVICE_PUBLIC_KEY | 2 | TCP device public key |
| TCP_SERVER_PUBLIC_KEY | 3 | TCP server public key |
| UDP_DEVICE_PRIVATE_KEY | 4 | UDP device private key |
| UDP_DEVICE_PUBLIC_KEY | 5 | UDP device public key |
| UDP_SERVER_PUBLIC_KEY | 6 | UDP server public key |
### ServerProtocolType
Note: Use the same values as defined by the server_protocol_type enum
| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID_PROTOCOL | 0 | |
| TCP_PROTOCOL | 1 | TCP |
| UDP_PROTOCOL | 2 | UDP |
### SystemCapabilityFlag
System capability flags
| Name | Number | Description |
| ---- | ------ | ----------- |
| NO_SYSTEM_CAPABILITY_FLAGS | 0 | |
| COMPRESSED_OTA | 1 | |
Top
## extensions.proto
### File-level Extensions
| Extension | Type | Base | Number | Description |
| --------- | ---- | ---- | ------ | ----------- |
| int_value | int32 | .google.protobuf.EnumValueOptions | 50002 | |
| type_id | int32 | .google.protobuf.MessageOptions | 50001 | |
Top
## network.proto
### DNSConfiguration
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| servers | [IPAddress](#particle-ctrl-IPAddress) | repeated | |
### GetInterfaceListReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| interfaces | [InterfaceEntry](#particle-ctrl-InterfaceEntry) | repeated | |
### GetInterfaceListRequest
### GetInterfaceReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| interface | [Interface](#particle-ctrl-Interface) | | |
### GetInterfaceRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| index | [uint32](#uint32) | | |
### IPConfiguration
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [IPConfiguration.Type](#particle-ctrl-IPConfiguration-Type) | | |
| address | [IPAddress](#particle-ctrl-IPAddress) | | |
| netmask | [IPAddress](#particle-ctrl-IPAddress) | | |
| gateway | [IPAddress](#particle-ctrl-IPAddress) | | |
| dhcp_server | [IPAddress](#particle-ctrl-IPAddress) | | |
| hostname | [string](#string) | | |
### Interface
Operation state of the interface
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| index | [uint32](#uint32) | | |
| name | [string](#string) | | |
| type | [InterfaceType](#particle-ctrl-InterfaceType) | | |
| flags | [uint32](#uint32) | | InterfaceFlag |
| ext_flags | [uint32](#uint32) | | InterfaceExtFlag |
| ipv4_config | [Ipv4Config](#particle-ctrl-Ipv4Config) | | |
| ipv6_config | [Ipv6Config](#particle-ctrl-Ipv6Config) | | |
| hw_address | [bytes](#bytes) | | |
| mtu | [uint32](#uint32) | | |
| metric | [uint32](#uint32) | | |
### InterfaceAddress
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| address | [IpAddress](#particle-ctrl-IpAddress) | | |
| prefix_length | [uint32](#uint32) | | TODO: state, scope, lifetimes, etc. |
### InterfaceEntry
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| index | [uint32](#uint32) | | |
| name | [string](#string) | | |
| type | [InterfaceType](#particle-ctrl-InterfaceType) | | |
### Ipv4Config
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| addresses | [InterfaceAddress](#particle-ctrl-InterfaceAddress) | repeated | |
| peer | [Ipv4Address](#particle-ctrl-Ipv4Address) | | On P2P links |
| gateway | [Ipv4Address](#particle-ctrl-Ipv4Address) | | Temporary, will be moved to routing table |
### Ipv6Config
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| addresses | [InterfaceAddress](#particle-ctrl-InterfaceAddress) | repeated | |
### NetworkConfiguration
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| interface | [int32](#int32) | | |
| state | [NetworkState](#particle-ctrl-NetworkState) | | |
| name | [string](#string) | | |
| mac | [bytes](#bytes) | | |
| ipconfig | [IPConfiguration](#particle-ctrl-IPConfiguration) | | |
| dnsconfig | [DNSConfiguration](#particle-ctrl-DNSConfiguration) | | |
### NetworkGetConfigurationReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| config | [NetworkConfiguration](#particle-ctrl-NetworkConfiguration) | | |
### NetworkGetConfigurationRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| interface | [int32](#int32) | | |
### NetworkGetStatusReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| config | [NetworkConfiguration](#particle-ctrl-NetworkConfiguration) | | |
### NetworkGetStatusRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| interface | [int32](#int32) | | |
### NetworkSetConfigurationReply
### NetworkSetConfigurationRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| config | [NetworkConfiguration](#particle-ctrl-NetworkConfiguration) | | |
### IPConfiguration.Type
| Name | Number | Description |
| ---- | ------ | ----------- |
| NONE | 0 | |
| DHCP | 1 | |
| STATIC | 2 | |
### InterfaceExtFlag
Direct mapping to if_xflags_t
| Name | Number | Description |
| ---- | ------ | ----------- |
| IFXF_NONE | 0 | |
| IFXF_WOL | 16 | |
| IFXF_AUTOCONF6 | 32 | |
| IFXF_DHCP | 65536 | |
| IFXF_DHCP6 | 131072 | |
| IFXF_AUTOIP | 262144 | |
### InterfaceFlag
Direct mapping to if_flags_t
| Name | Number | Description |
| ---- | ------ | ----------- |
| IFF_NONE | 0 | |
| IFF_UP | 1 | |
| IFF_BROADCAST | 2 | |
| IFF_DEBUG | 4 | |
| IFF_LOOPBACK | 8 | |
| IFF_POINTTOPOINT | 16 | |
| IFF_RUNNING | 64 | |
| IFF_LOWER_UP | 64 | |
| IFF_NOARP | 128 | |
| IFF_PROMISC | 256 | |
| IFF_ALLMULTI | 512 | |
| IFF_MULTICAST | 32768 | |
| IFF_NOND6 | 65536 | |
### InterfaceType
| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID_INTERFACE_TYPE | 0 | |
| LOOPBACK | 1 | |
| THREAD | 2 | |
| ETHERNET | 4 | |
| WIFI | 8 | |
| PPP | 16 | |
### NetworkState
| Name | Number | Description |
| ---- | ------ | ----------- |
| NETWORK_STATUS_NONE | 0 | |
| DOWN | 1 | |
| UP | 2 | |
Top
## storage.proto
### CancelFirmwareUpdateReply
### CancelFirmwareUpdateRequest
Cancel the firmware update
### ClearSectionDataReply
### ClearSectionDataRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| storage | [uint32](#uint32) | | Storage index |
| section | [uint32](#uint32) | | Section index |
### DescribeStorageReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| storage | [DescribeStorageReply.Storage](#particle-ctrl-DescribeStorageReply-Storage) | repeated | Storages |
### DescribeStorageReply.Section
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [SectionType](#particle-ctrl-SectionType) | | Section type |
| size | [uint32](#uint32) | | Section size |
| flags | [uint32](#uint32) | | SectionFlag flags |
| firmware_module | [DescribeStorageReply.Section.FirmwareModule](#particle-ctrl-DescribeStorageReply-Section-FirmwareModule) | | Firmware module |
### DescribeStorageReply.Section.FirmwareModule
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [FirmwareModuleType](#particle-ctrl-FirmwareModuleType) | | Firmware module type |
| index | [uint32](#uint32) | | Section index |
### DescribeStorageReply.Storage
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [StorageType](#particle-ctrl-StorageType) | | Storage type |
| flags | [uint32](#uint32) | | SectionFlag flags |
| sections | [DescribeStorageReply.Section](#particle-ctrl-DescribeStorageReply-Section) | repeated | Storage sections |
### DescribeStorageRequest
Describe the built-in storage
### FinishFirmwareUpdateReply
### FinishFirmwareUpdateRequest
Finish the firmware update process
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| validate_only | [bool](#bool) | | When `true` it will only validate the integity of the update but won't write it to flash |
### FirmwareUpdateDataReply
### FirmwareUpdateDataRequest
Send the firmware update file
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| data | [bytes](#bytes) | | |
### GetModuleInfoReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| modules | [GetModuleInfoReply.Module](#particle-ctrl-GetModuleInfoReply-Module) | repeated | Firmware modules |
### GetModuleInfoReply.Dependency
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [FirmwareModuleType](#particle-ctrl-FirmwareModuleType) | | Module type |
| index | [uint32](#uint32) | | Module index |
| version | [uint32](#uint32) | | Module version |
### GetModuleInfoReply.Module
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [FirmwareModuleType](#particle-ctrl-FirmwareModuleType) | | Module type |
| index | [uint32](#uint32) | | Module index |
| version | [uint32](#uint32) | | Module version |
| size | [uint32](#uint32) | | Module size |
| validity | [uint32](#uint32) | | Validity flags (see FirmwareModuleValidityFlag) |
| dependencies | [GetModuleInfoReply.Dependency](#particle-ctrl-GetModuleInfoReply-Dependency) | repeated | Module dependencies |
### GetModuleInfoRequest
Get firmware module info.
### GetSectionDataSizeReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| size | [uint32](#uint32) | | Section data size |
### GetSectionDataSizeRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| storage | [uint32](#uint32) | | Storage index |
| section | [uint32](#uint32) | | Section index |
### ReadSectionDataReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| data | [bytes](#bytes) | | Section data |
### ReadSectionDataRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| storage | [uint32](#uint32) | | Storage index |
| section | [uint32](#uint32) | | Section index |
| offset | [uint32](#uint32) | | Offset |
| size | [uint32](#uint32) | | Size |
### StartFirmwareUpdateReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| chunk_size | [uint32](#uint32) | | Maximum chunk size |
### StartFirmwareUpdateRequest
Start the firmware update process
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| size | [uint32](#uint32) | | Size of the firmware binary |
| format | [FileFormat](#particle-ctrl-FileFormat) | | Format of the firmware binary |
### WriteSectionDataReply
### WriteSectionDataRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| storage | [uint32](#uint32) | | Storage index |
| section | [uint32](#uint32) | | Section index |
| offset | [uint32](#uint32) | | Offset |
| data | [bytes](#bytes) | | Size |
### FileFormat
| Name | Number | Description |
| ---- | ------ | ----------- |
| BIN | 0 | Binary |
| MINIZ | 1 | miniz compressed |
### FirmwareModuleType
| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID_FIRMWARE_MODULE | 0 | |
| BOOTLOADER | 1 | Bootloader |
| SYSTEM_PART | 2 | System part |
| USER_PART | 3 | User part |
| MONO_FIRMWARE | 4 | Monolithic firmware |
| NCP_FIRMWARE | 5 | NCP firmware |
| RADIO_STACK | 6 | Radio stack binary |
### FirmwareModuleValidityFlag
| Name | Number | Description |
| ---- | ------ | ----------- |
| NO_VALIDATION_ERRORS | 0 | |
| INTEGRITY_CHECK_FAILED | 1 | Integrity check failed |
| DEPENDENCY_CHECK_FAILED | 2 | Dependency check failed |
### SectionFlag
| Name | Number | Description |
| ---- | ------ | ----------- |
| NO_SECTION_FLAGS | 0 | |
| CAN_READ | 1 | Section data is readable |
| CAN_WRITE | 2 | Section data is writable |
| CAN_CLEAR | 4 | Section can be cleared |
| CAN_GET_SIZE | 8 | Actual size of the section data can be determined |
| NEED_CLEAR | 16 | Section needs to be cleared before writing |
### SectionType
| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID_SECTION | 0 | |
| FIRMWARE | 1 | Firmware module |
| OTA_BACKUP | 2 | OTA backup |
| FACTORY_BACKUP | 3 | Factory backup |
| CONFIG | 4 | Device configuration |
| EEPROM | 5 | Emulated EEPROM |
### StorageType
| Name | Number | Description |
| ---- | ------ | ----------- |
| INVALID_STORAGE | 0 | |
| INTERNAL | 1 | Internal flash |
Top
## wifi_new.proto
### ClearKnownNetworksReply
### ClearKnownNetworksRequest
Remove all known networks.
### Credentials
Network credentials.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| type | [CredentialsType](#particle-ctrl-wifi-CredentialsType) | | |
| password | [string](#string) | | |
### GetCurrentNetworkReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ssid | [string](#string) | | Network SSID |
| bssid | [bytes](#bytes) | | Network address |
| channel | [int32](#int32) | | Network channel |
| rssi | [int32](#int32) | | Network signal strength |
### GetCurrentNetworkRequest
Get the current network.
This request gets the network which the device is currently connected to.
### GetKnownNetworksReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| networks | [GetKnownNetworksReply.Network](#particle-ctrl-wifi-GetKnownNetworksReply-Network) | repeated | All known networks |
### GetKnownNetworksReply.Network
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ssid | [string](#string) | | Network SSID |
| security | [Security](#particle-ctrl-wifi-Security) | | Network security |
| credentials_type | [CredentialsType](#particle-ctrl-wifi-CredentialsType) | | Network credentials |
### GetKnownNetworksRequest
Get the list of known networks.
### JoinKnownNetworkReply
### JoinKnownNetworkRequest
Join a known network.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ssid | [string](#string) | | Network SSID |
### JoinNewNetworkReply
### JoinNewNetworkRequest
Join a new network.
On success, the network credentials get saved to a persistent storage.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ssid | [string](#string) | | Network SSID |
| bssid | [bytes](#bytes) | | Network address |
| security | [Security](#particle-ctrl-wifi-Security) | | Network security |
| credentials | [Credentials](#particle-ctrl-wifi-Credentials) | | Network credentials |
### RemoveKnownNetworkReply
### RemoveKnownNetworkRequest
Remove the network from the list of known networks.
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ssid | [string](#string) | | Network SSID |
### ScanNetworksReply
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| networks | [ScanNetworksReply.Network](#particle-ctrl-wifi-ScanNetworksReply-Network) | repeated | All found networks |
### ScanNetworksReply.Network
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| ssid | [string](#string) | | Network SSID |
| bssid | [bytes](#bytes) | | Network address |
| security | [Security](#particle-ctrl-wifi-Security) | | Network security |
| channel | [int32](#int32) | | Network channel |
| rssi | [int32](#int32) | | Network signal strength |
### ScanNetworksRequest
Scan for networks.
### CredentialsType
Network credential types.
Note: The values of this enum should match the values defined by the `WiFiCredentials::Type` enum
in the firmware.
| Name | Number | Description |
| ---- | ------ | ----------- |
| NO_CREDENTIALS | 0 | No WiFi credentials |
| PASSWORD | 1 | WiFi password |
### Security
WiFi security types.
Note: The values of this enum should match the values defined by the `WifiSecurity` enum in
the firmware.
| Name | Number | Description |
| ---- | ------ | ----------- |
| NO_SECURITY | 0 | No security |
| WEP | 1 | WEP |
| WPA_PSK | 2 | WPA PSK |
| WPA2_PSK | 3 | WPA2 PSK |
| WPA_WPA2_PSK | 4 | WPA/WPA2 PSK |
## Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
| double | | double | double | float | float64 | double | float | Float |
| float | | float | float | float | float32 | float | float | Float |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |