nRF5 SDK for Mesh v3.2.0  08c60f6
Serial commands

Data Structures

struct  serial_cmd_device_echo_t
 Echo cmd parameters. More...
 
struct  serial_cmd_device_beacon_start_t
 Beacon start cmd parameters. More...
 
struct  serial_cmd_device_beacon_stop_t
 Beacon stop cmd parameters. More...
 
struct  serial_cmd_device_beacon_params_set_t
 Beacon params set cmd parameters. More...
 
struct  serial_cmd_device_beacon_params_get_t
 Beacon params get cmd parameters. More...
 
union  serial_cmd_device_t
 Union of all device command parameters. More...
 
struct  serial_cmd_config_adv_addr_t
 Advertisement address config command parameters. More...
 
struct  serial_cmd_config_channel_map_t
 Channel map config command parameters. More...
 
struct  serial_cmd_config_tx_power_t
 TX power config command parameters. More...
 
struct  serial_cmd_config_uuid_t
 UUID config command parameters. More...
 
union  serial_cmd_config_t
 Union of all config command parameters. More...
 
struct  serial_cmd_openmesh_dfu_data_t
 DFU data parameters. More...
 
union  serial_cmd_openmesh_t
 Union of all config command parameters. More...
 
struct  serial_cmd_prov_keypair_t
 Keypair cmd parameters. More...
 
struct  serial_cmd_prov_caps_t
 Provisioning set capabilities parameters. More...
 
struct  serial_cmd_prov_data_t
 Provisioning provision command parameters. More...
 
struct  serial_cmd_prov_oob_use_t
 OOB method selection parameters. More...
 
struct  serial_cmd_prov_auth_data_t
 Authentication data parameters. More...
 
struct  serial_cmd_prov_ecdh_data_t
 ECDH shared secret data parameters. More...
 
union  serial_cmd_prov_t
 Union of all provisioning command parameters. More...
 
struct  serial_cmd_mesh_subnet_add_t
 Mesh subnet add command parameters. More...
 
struct  serial_cmd_mesh_subnet_update_t
 Mesh subnet update command parameters. More...
 
struct  serial_cmd_mesh_subnet_delete_t
 Mesh subnet delete command parameters. More...
 
struct  serial_cmd_mesh_appkey_add_t
 Mesh appkey add command parameters. More...
 
struct  serial_cmd_mesh_appkey_update_t
 Mesh appkey update command parameters. More...
 
struct  serial_cmd_mesh_appkey_delete_t
 Mesh appkey delete command parameters. More...
 
struct  serial_cmd_mesh_appkey_get_all_t
 Mesh appkey get all command parameters. More...
 
struct  serial_cmd_mesh_devkey_add_t
 Mesh devkey add command parameters. More...
 
struct  serial_cmd_mesh_devkey_delete_t
 Mesh devkey delete command parameters. More...
 
struct  serial_cmd_mesh_addr_local_unicast_set_t
 Mesh local unicast address set command parameters. More...
 
struct  serial_cmd_mesh_addr_add_t
 Mesh address add command parameters. More...
 
struct  serial_cmd_mesh_addr_virtual_add_t
 Mesh address virtual add command parameters. More...
 
struct  serial_cmd_mesh_addr_get_t
 Mesh address get command parameters. More...
 
struct  serial_cmd_mesh_addr_subscription_add_t
 Mesh address subscription add command parameters. More...
 
struct  serial_cmd_mesh_addr_subscription_add_virtual_t
 Mes address subscription add virtual command parameters. More...
 
struct  serial_cmd_mesh_addr_subscription_remove_t
 Mesh address subscription remove command parameters. More...
 
struct  serial_cmd_mesh_addr_publication_add_t
 Mesh address publication add command parameters. More...
 
struct  serial_cmd_mesh_addr_publication_add_virtual_t
 Mesh address publication add virtual command parameters. More...
 
struct  serial_cmd_mesh_addr_publication_remove_t
 Mesh address publication remove command parameters. More...
 
struct  serial_cmd_mesh_packet_send_t
 Mesh packet send command parameters. More...
 
union  serial_cmd_mesh_t
 Mesh command parameters. More...
 
struct  serial_cmd_pb_remote_client_init_t
 Initialize PB-MESH Client. More...
 
struct  serial_cmd_pb_remote_client_remote_scan_start_t
 Start remote scanning command. More...
 
struct  serial_cmd_pb_remote_client_remote_scan_cancel_t
 Cancel remote scanning command. More...
 
struct  serial_cmd_pb_remote_client_remote_provision_t
 Start remote provisioning command. More...
 
union  serial_cmd_pb_remote_t
 PB-Mesh client commands. More...
 
struct  serial_cmd_dfu_request_t
 DFU request command parameters. More...
 
struct  serial_cmd_dfu_relay_t
 DFU relay command parameters. More...
 
struct  serial_cmd_dfu_bank_info_get_t
 DFU bank info get command parameters. More...
 
struct  serial_cmd_dfu_bank_flash_t
 DFU bank flash command parameters. More...
 
union  serial_cmd_dfu_t
 DFU command parameters. More...
 
struct  serial_cmd_access_handle_pair_t
 Used by various access commands that work on address handles for a given model. More...
 
struct  serial_cmd_access_model_handle_t
 Used by access commands that only require the model handle. More...
 
struct  serial_cmd_access_element_loc_set_t
 Used to update the location field of an element. More...
 
struct  serial_cmd_access_model_pub_ttl_set_t
 Used to update the ttl value for the messages originating from a given model. More...
 
struct  serial_cmd_access_handle_get_t
 Used to get the handle value for a model instance. More...
 
struct  serial_cmd_access_pub_period_set_t
 Used to update the publish period of a model by updating resolution and number of steps. More...
 
struct  serial_cmd_access_element_index_t
 Used by access commands that only require the element index. More...
 
struct  serial_cmd_model_specific_init_t
 Used for initializing one of the available models. More...
 
struct  serial_cmd_model_specific_command_t
 Used for sending commands to one of the initialized models. More...
 
union  serial_cmd_access_t
 ACCESS layer command parameters. More...
 
struct  serial_cmd_application_t
 Application command parameters. More...
 
union  serial_cmd_t
 Union of all command parameters. More...
 

Macros

#define SERIAL_OPCODE_CMD_RANGE_DEVICE_START   (0x00)
 DEVICE range start.
 
#define SERIAL_OPCODE_CMD_DEVICE_ECHO   (0x02)
 Params: serial_cmd_device_echo_t.
 
#define SERIAL_OPCODE_CMD_DEVICE_INTERNAL_EVENTS_REPORT   (0x03)
 Params: None.
 
#define SERIAL_OPCODE_CMD_DEVICE_SERIAL_VERSION_GET   (0x09)
 Params: None.
 
#define SERIAL_OPCODE_CMD_DEVICE_FW_INFO_GET   (0x0A)
 Params: None.
 
#define SERIAL_OPCODE_CMD_DEVICE_RADIO_RESET   (0x0E)
 Params: None.
 
#define SERIAL_OPCODE_CMD_DEVICE_BEACON_START   (0x10)
 Params: serial_cmd_device_beacon_start_t.
 
#define SERIAL_OPCODE_CMD_DEVICE_BEACON_STOP   (0x11)
 Params: serial_cmd_device_beacon_stop_t.
 
#define SERIAL_OPCODE_CMD_DEVICE_BEACON_PARAMS_SET   (0x12)
 Params: serial_cmd_device_beacon_params_set_t.
 
#define SERIAL_OPCODE_CMD_DEVICE_BEACON_PARAMS_GET   (0x13)
 Params: serial_cmd_device_beacon_params_get_t.
 
#define SERIAL_OPCODE_CMD_DEVICE_HOUSEKEEPING_DATA_GET   (0x14)
 Params: None.
 
#define SERIAL_OPCODE_CMD_DEVICE_HOUSEKEEPING_DATA_CLEAR   (0x15)
 Params: None.
 
#define SERIAL_OPCODE_CMD_RANGE_DEVICE_END   (0x1F)
 DEVICE range end.
 
#define SERIAL_OPCODE_CMD_RANGE_APP_START   (0x20)
 APP range start.
 
#define SERIAL_OPCODE_CMD_APP_APPLICATION   (0x20)
 Params: serial_cmd_application_t.
 
#define SERIAL_OPCODE_CMD_RANGE_APP_END   (0x20)
 APP range end.
 
#define SERIAL_OPCODE_CMD_RANGE_SAR_START   (0x21)
 SAR range start.
 
#define SERIAL_OPCODE_CMD_SAR_START   (0x21)
 Params: None.
 
#define SERIAL_OPCODE_CMD_SAR_CONTINUE   (0x22)
 Params: None.
 
#define SERIAL_OPCODE_CMD_RANGE_SAR_END   (0x22)
 SAR range end.
 
#define SERIAL_OPCODE_CMD_RANGE_CONFIG_START   (0x40)
 CONFIG range start.
 
#define SERIAL_OPCODE_CMD_CONFIG_ADV_ADDR_SET   (0x40)
 Params: serial_cmd_config_adv_addr_t.
 
#define SERIAL_OPCODE_CMD_CONFIG_ADV_ADDR_GET   (0x41)
 Params: None.
 
#define SERIAL_OPCODE_CMD_CONFIG_CHANNEL_MAP_SET   (0x42)
 Params: serial_cmd_config_channel_map_t.
 
#define SERIAL_OPCODE_CMD_CONFIG_CHANNEL_MAP_GET   (0x43)
 Params: None.
 
#define SERIAL_OPCODE_CMD_CONFIG_TX_POWER_SET   (0x44)
 Params: serial_cmd_config_tx_power_t.
 
#define SERIAL_OPCODE_CMD_CONFIG_TX_POWER_GET   (0x45)
 Params: None.
 
#define SERIAL_OPCODE_CMD_CONFIG_UUID_SET   (0x53)
 Params: serial_cmd_config_uuid_t.
 
#define SERIAL_OPCODE_CMD_CONFIG_UUID_GET   (0x54)
 Params: None.
 
#define SERIAL_OPCODE_CMD_RANGE_CONFIG_END   (0x5F)
 CONFIG range end.
 
#define SERIAL_OPCODE_CMD_RANGE_PROV_START   (0x60)
 PROVISIONING range start.
 
#define SERIAL_OPCODE_CMD_PROV_SCAN_START   (0x61)
 Params: None.
 
#define SERIAL_OPCODE_CMD_PROV_SCAN_STOP   (0x62)
 Params: None.
 
#define SERIAL_OPCODE_CMD_PROV_PROVISION   (0x63)
 Params: serial_cmd_prov_data_t.
 
#define SERIAL_OPCODE_CMD_PROV_LISTEN   (0x64)
 Params: None.
 
#define SERIAL_OPCODE_CMD_PROV_OOB_USE   (0x66)
 Params: serial_cmd_prov_oob_use_t.
 
#define SERIAL_OPCODE_CMD_PROV_AUTH_DATA   (0x67)
 Params: serial_cmd_prov_auth_data_t.
 
#define SERIAL_OPCODE_CMD_PROV_ECDH_SECRET   (0x68)
 Params: serial_cmd_prov_ecdh_data_t.
 
#define SERIAL_OPCODE_CMD_PROV_KEYPAIR_SET   (0x69)
 Params: serial_cmd_prov_keypair_t.
 
#define SERIAL_OPCODE_CMD_PROV_CAPABILITIES_SET   (0x6A)
 Params: serial_cmd_prov_caps_t.
 
#define SERIAL_OPCODE_CMD_RANGE_PROV_END   (0x6F)
 PROVISIONING range end.
 
#define SERIAL_OPCODE_CMD_RANGE_OPENMESH_START   (0x70)
 OPENMESH range start.
 
#define SERIAL_OPCODE_CMD_OPENMESH_INIT   (0x70)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_VALUE_SET   (0x71)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_VALUE_ENABLE   (0x72)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_VALUE_DISABLE   (0x73)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_START   (0x74)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_STOP   (0x75)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_FLAG_SET   (0x76)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_FLAG_GET   (0x77)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_DFU_DATA   (0x78)
 Params: serial_cmd_openmesh_dfu_data_t.
 
#define SERIAL_OPCODE_CMD_OPENMESH_VALUE_GET   (0x7A)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_BUILD_VERSION_GET   (0x7B)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_ACCESS_ADDR_GET   (0x7C)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_CHANNEL_GET   (0x7D)
 Params: None.
 
#define SERIAL_OPCODE_CMD_OPENMESH_INTERVAL_MIN_MS_GET   (0x7F)
 Params: None.
 
#define SERIAL_OPCODE_CMD_RANGE_OPENMESH_END   (0x8F)
 OPENMESH range end.
 
#define SERIAL_OPCODE_CMD_RANGE_MESH_START   (0x90)
 MESH range start.
 
#define SERIAL_OPCODE_CMD_MESH_ENABLE   (0x90)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_DISABLE   (0x91)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_SUBNET_ADD   (0x92)
 Params: serial_cmd_mesh_subnet_add_t.
 
#define SERIAL_OPCODE_CMD_MESH_SUBNET_UPDATE   (0x93)
 Params: serial_cmd_mesh_subnet_update_t.
 
#define SERIAL_OPCODE_CMD_MESH_SUBNET_DELETE   (0x94)
 Params: serial_cmd_mesh_subnet_delete_t.
 
#define SERIAL_OPCODE_CMD_MESH_SUBNET_GET_ALL   (0x95)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_SUBNET_COUNT_MAX_GET   (0x96)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_APPKEY_ADD   (0x97)
 Params: serial_cmd_mesh_appkey_add_t.
 
#define SERIAL_OPCODE_CMD_MESH_APPKEY_UPDATE   (0x98)
 Params: serial_cmd_mesh_appkey_update_t.
 
#define SERIAL_OPCODE_CMD_MESH_APPKEY_DELETE   (0x99)
 Params: serial_cmd_mesh_appkey_delete_t.
 
#define SERIAL_OPCODE_CMD_MESH_APPKEY_GET_ALL   (0x9A)
 Params: serial_cmd_mesh_appkey_get_all_t.
 
#define SERIAL_OPCODE_CMD_MESH_APPKEY_COUNT_MAX_GET   (0x9B)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_DEVKEY_ADD   (0x9C)
 Params: serial_cmd_mesh_devkey_add_t.
 
#define SERIAL_OPCODE_CMD_MESH_DEVKEY_DELETE   (0x9D)
 Params: serial_cmd_mesh_devkey_delete_t.
 
#define SERIAL_OPCODE_CMD_MESH_DEVKEY_COUNT_MAX_GET   (0x9E)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_LOCAL_UNICAST_SET   (0x9F)
 Params: serial_cmd_mesh_addr_local_unicast_set_t.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_LOCAL_UNICAST_GET   (0xA0)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_SUBSCRIPTION_ADD   (0xA1)
 Params: serial_cmd_mesh_addr_subscription_add_t.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_SUBSCRIPTION_ADD_VIRTUAL   (0xA2)
 Params: serial_cmd_mesh_addr_subscription_add_virtual_t.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_SUBSCRIPTION_REMOVE   (0xA3)
 Params: serial_cmd_mesh_addr_subscription_remove_t.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_PUBLICATION_ADD   (0xA4)
 Params: serial_cmd_mesh_addr_publication_add_t.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_PUBLICATION_ADD_VIRTUAL   (0xA5)
 Params: serial_cmd_mesh_addr_publication_add_virtual_t.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_PUBLICATION_REMOVE   (0xA6)
 Params: serial_cmd_mesh_addr_publication_remove_t.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_GET   (0xA7)
 Params: serial_cmd_mesh_addr_get_t.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_GET_ALL   (0xA8)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_NONVIRTUAL_COUNT_MAX_GET   (0xA9)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_ADDR_VIRTUAL_COUNT_MAX_GET   (0xAA)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MESH_PACKET_SEND   (0xAB)
 Params: serial_cmd_mesh_packet_send_t.
 
#define SERIAL_OPCODE_CMD_MESH_STATE_CLEAR   (0xAC)
 Params: None.
 
#define SERIAL_OPCODE_CMD_RANGE_MESH_END   (0xAF)
 MESH range end.
 
#define SERIAL_OPCODE_CMD_RANGE_DFU_START   (0xD0)
 DFU range start.
 
#define SERIAL_OPCODE_CMD_DFU_JUMP_TO_BOOTLOADER   (0xD0)
 Params: None.
 
#define SERIAL_OPCODE_CMD_DFU_REQUEST   (0xD1)
 Params: serial_cmd_dfu_request_t.
 
#define SERIAL_OPCODE_CMD_DFU_RELAY   (0xD2)
 Params: serial_cmd_dfu_relay_t.
 
#define SERIAL_OPCODE_CMD_DFU_ABORT   (0xD3)
 Params: None.
 
#define SERIAL_OPCODE_CMD_DFU_BANK_INFO_GET   (0xD4)
 Params: serial_cmd_dfu_bank_info_get_t.
 
#define SERIAL_OPCODE_CMD_DFU_BANK_FLASH   (0xD5)
 Params: serial_cmd_dfu_bank_flash_t.
 
#define SERIAL_OPCODE_CMD_DFU_STATE_GET   (0xD6)
 Params: None.
 
#define SERIAL_OPCODE_CMD_RANGE_DFU_END   (0xDF)
 DFU range end.
 
#define SERIAL_OPCODE_CMD_RANGE_ACCESS_START   (0xE0)
 Start of ACCESS command range.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_PUB_ADDR_SET   (0xE0)
 Params: serial_cmd_access_handle_pair_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_PUB_ADDR_GET   (0xE1)
 Params: serial_cmd_access_model_handle_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_PUB_PERIOD_SET   (0xE2)
 Params: serial_cmd_access_pub_period_set_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_PUB_PERIOD_GET   (0xE3)
 Params: serial_cmd_access_model_handle_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_SUBS_ADD   (0xE4)
 Params: serial_cmd_access_handle_pair_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_SUBS_REMOVE   (0xE5)
 Params: serial_cmd_access_handle_pair_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_SUBS_GET   (0xE6)
 Params: serial_cmd_access_model_handle_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_APP_BIND   (0xE7)
 Params: serial_cmd_access_handle_pair_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_APP_UNBIND   (0xE8)
 Params: serial_cmd_access_handle_pair_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_APP_GET   (0xE9)
 Params: serial_cmd_access_model_handle_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_PUB_APP_SET   (0xEA)
 Params: serial_cmd_access_handle_pair_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_PUB_APP_GET   (0xEB)
 Params: serial_cmd_access_model_handle_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_PUB_TTL_SET   (0xEC)
 Params: serial_cmd_access_model_pub_ttl_set_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_PUB_TTL_GET   (0xED)
 Params: serial_cmd_access_model_handle_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_ELEM_LOC_SET   (0xEE)
 Params: serial_cmd_access_element_loc_set_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_ELEM_LOC_GET   (0xEF)
 Params: serial_cmd_access_element_index_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_ELEM_SIG_MODEL_COUNT_GET   (0xF0)
 Params: serial_cmd_access_element_index_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_ELEM_VENDOR_MODEL_COUNT_GET   (0xF1)
 Params: serial_cmd_access_element_index_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_MODEL_ID_GET   (0xF2)
 Params: serial_cmd_access_model_handle_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_HANDLE_GET   (0xF3)
 Params: serial_cmd_access_handle_get_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_ELEM_MODELS_GET   (0xF4)
 Params: serial_cmd_access_element_index_t.
 
#define SERIAL_OPCODE_CMD_ACCESS_ACCESS_FLASH_STORE   (0xF5)
 Params: None.
 
#define SERIAL_OPCODE_CMD_RANGE_ACCESS_END   (0xF5)
 End of ACCESS command range.
 
#define SERIAL_OPCODE_CMD_RANGE_MODEL_SPECIFIC_START   (0xFC)
 Start of MODEL specific command range.
 
#define SERIAL_OPCODE_CMD_MODEL_SPECIFIC_MODELS_GET   (0xFC)
 Params: None.
 
#define SERIAL_OPCODE_CMD_MODEL_SPECIFIC_INIT   (0xFD)
 Params: serial_cmd_model_specific_init_t.
 
#define SERIAL_OPCODE_CMD_MODEL_SPECIFIC_COMMAND   (0xFE)
 Params: serial_cmd_model_specific_command_t.
 
#define SERIAL_OPCODE_CMD_RANGE_MODEL_SPECIFIC_END   (0xFE)
 End of MODEL specific command range.
 

Detailed Description