Border Router Message API#

Wi-SUN Border Router Message API contains messages for Border Router specific functionality for Network Co-Processor (NCP) use-cases.

The API is functionally equivalent of Border Router API. It's an extension, not a replacement of Message API. An application implementing Border Router capability may utilize functions from both APIs. See API availability for further information.

Modules#

sl_wisun_br_msg_header_t

sl_wisun_br_msg_generic

sl_wisun_br_msg_start

sl_wisun_br_msg_stop

sl_wisun_br_msg_set_get

sl_wisun_br_msg_set_network_size

sl_wisun_br_msg_get_ip_address

sl_wisun_br_msg_get_gak

sl_wisun_br_msg_get_state

sl_wisun_br_msg_set_device_certificate

sl_wisun_br_msg_set_broadcast_settings

sl_wisun_br_msg_set_connection_params

sl_wisun_br_msg_set_lfn_params

sl_wisun_br_msg_set_lfn_support

sl_wisun_br_msg_set_dhcp_vendor_data

sl_wisun_br_msg_pan_defect_advertise

sl_wisun_br_msg_set_ipv6_prefix

sl_wisun_br_trigger_global_repair

sl_wisun_br_msg_get_routing_table_entry_count

sl_wisun_br_msg_get_routing_table

sl_wisun_br_msg_get_routing_table_from_index

sl_wisun_br_msg_revoke_pairwise_keys

sl_wisun_br_msg_revoke_gtks

Enumerations#

enum
SL_WISUN_BR_MSG_START_CNF_ID = 0x7F
SL_WISUN_BR_MSG_STOP_CNF_ID = 0x7E
SL_WISUN_BR_MSG_SET_NETWORK_SIZE_CNF_ID = 0x7D
SL_WISUN_BR_MSG_SET_GTK_CNF_ID = 0x7C
SL_WISUN_BR_MSG_GET_IP_ADDR_CNF_ID = 0x7B
SL_WISUN_BR_MSG_GET_GAK_CNF_ID = 0x7A
SL_WISUN_BR_MSG_GET_STATE_CNF_ID = 0x79
SL_WISUN_BR_MSG_SET_DEVICE_CERTIFICATE_CNF_ID = 0x78
SL_WISUN_BR_MSG_SET_BROADCAST_SETTINGS_CNF_ID = 0x77
SL_WISUN_BR_MSG_SET_CONNECTION_PARAMS_CNF_ID = 0x76
SL_WISUN_BR_MSG_SET_LFN_PARAMS_CNF_ID = 0x75
SL_WISUN_BR_MSG_SET_LFN_SUPPORT_CNF_ID = 0x74
UNUSED_0x73_CNF_ID = 0x73
SL_WISUN_BR_MSG_PAN_DEFECT_ADVERTISE_CNF_ID = 0x72
SL_WISUN_BR_MSG_SET_IPV6_PREFIX_CNF_ID = 0x71
SL_WISUN_BR_MSG_TRIGGER_GLOBAL_REPAIR_CNF_ID = 0x70
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_ENTRY_COUNT_CNF_ID = 0x6F
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_CNF_ID = 0x6E
SL_WISUN_BR_MSG_REVOKE_PAIRWISE_KEYS_CNF_ID = 0x6D
SL_WISUN_BR_MSG_REVOKE_GTKS_CNF_ID = 0x6C
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_FROM_INDEX_CNF_ID = 0x6B
}

Wi-SUN BR Message API confirmation IDs.

enum
SL_WISUN_BR_MSG_START_REQ_ID = 0x7F
SL_WISUN_BR_MSG_STOP_REQ_ID = 0x7E
SL_WISUN_BR_MSG_SET_NETWORK_SIZE_REQ_ID = 0x7D
SL_WISUN_BR_MSG_SET_GTK_REQ_ID = 0x7C
SL_WISUN_BR_MSG_GET_IP_ADDR_REQ_ID = 0x7B
SL_WISUN_BR_MSG_GET_GAK_REQ_ID = 0x7A
SL_WISUN_BR_MSG_GET_STATE_REQ_ID = 0x79
SL_WISUN_BR_MSG_SET_DEVICE_CERTIFICATE_REQ_ID = 0x78
SL_WISUN_BR_MSG_SET_BROADCAST_SETTINGS_REQ_ID = 0x77
SL_WISUN_BR_MSG_SET_CONNECTION_PARAMS_REQ_ID = 0x76
SL_WISUN_BR_MSG_SET_LFN_PARAMS_REQ_ID = 0x75
SL_WISUN_BR_MSG_SET_LFN_SUPPORT_REQ_ID = 0x74
UNUSED_0x73_REQ_ID = 0x73
SL_WISUN_BR_MSG_PAN_DEFECT_ADVERTISE_REQ_ID = 0x72
SL_WISUN_BR_MSG_SET_IPV6_PREFIX_REQ_ID = 0x71
SL_WISUN_BR_MSG_TRIGGER_GLOBAL_REPAIR_REQ_ID = 0x70
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_ENTRY_COUNT_REQ_ID = 0x6F
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_REQ_ID = 0x6E
SL_WISUN_BR_MSG_REVOKE_PAIRWISE_KEYS_REQ_ID = 0x6D
SL_WISUN_BR_MSG_REVOKE_GTKS_REQ_ID = 0x6C
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_FROM_INDEX_REQ_ID = 0x6B
}

Wi-SUN BR Message API request IDs.

Enumeration Documentation#

sl_wisun_br_msg_cnf_id_t#

sl_wisun_br_msg_cnf_id_t

Wi-SUN BR Message API confirmation IDs.

Enumerator
SL_WISUN_BR_MSG_START_CNF_ID
SL_WISUN_BR_MSG_STOP_CNF_ID
SL_WISUN_BR_MSG_SET_NETWORK_SIZE_CNF_ID
SL_WISUN_BR_MSG_SET_GTK_CNF_ID
SL_WISUN_BR_MSG_GET_IP_ADDR_CNF_ID
SL_WISUN_BR_MSG_GET_GAK_CNF_ID
SL_WISUN_BR_MSG_GET_STATE_CNF_ID
SL_WISUN_BR_MSG_SET_DEVICE_CERTIFICATE_CNF_ID
SL_WISUN_BR_MSG_SET_BROADCAST_SETTINGS_CNF_ID
SL_WISUN_BR_MSG_SET_CONNECTION_PARAMS_CNF_ID
SL_WISUN_BR_MSG_SET_LFN_PARAMS_CNF_ID
SL_WISUN_BR_MSG_SET_LFN_SUPPORT_CNF_ID
UNUSED_0x73_CNF_ID
SL_WISUN_BR_MSG_PAN_DEFECT_ADVERTISE_CNF_ID
SL_WISUN_BR_MSG_SET_IPV6_PREFIX_CNF_ID
SL_WISUN_BR_MSG_TRIGGER_GLOBAL_REPAIR_CNF_ID
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_ENTRY_COUNT_CNF_ID
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_CNF_ID
SL_WISUN_BR_MSG_REVOKE_PAIRWISE_KEYS_CNF_ID
SL_WISUN_BR_MSG_REVOKE_GTKS_CNF_ID
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_FROM_INDEX_CNF_ID

sl_wisun_br_msg_req_id_t#

sl_wisun_br_msg_req_id_t

Wi-SUN BR Message API request IDs.

Enumerator
SL_WISUN_BR_MSG_START_REQ_ID
SL_WISUN_BR_MSG_STOP_REQ_ID
SL_WISUN_BR_MSG_SET_NETWORK_SIZE_REQ_ID
SL_WISUN_BR_MSG_SET_GTK_REQ_ID
SL_WISUN_BR_MSG_GET_IP_ADDR_REQ_ID
SL_WISUN_BR_MSG_GET_GAK_REQ_ID
SL_WISUN_BR_MSG_GET_STATE_REQ_ID
SL_WISUN_BR_MSG_SET_DEVICE_CERTIFICATE_REQ_ID
SL_WISUN_BR_MSG_SET_BROADCAST_SETTINGS_REQ_ID
SL_WISUN_BR_MSG_SET_CONNECTION_PARAMS_REQ_ID
SL_WISUN_BR_MSG_SET_LFN_PARAMS_REQ_ID
SL_WISUN_BR_MSG_SET_LFN_SUPPORT_REQ_ID
UNUSED_0x73_REQ_ID
SL_WISUN_BR_MSG_PAN_DEFECT_ADVERTISE_REQ_ID
SL_WISUN_BR_MSG_SET_IPV6_PREFIX_REQ_ID
SL_WISUN_BR_MSG_TRIGGER_GLOBAL_REPAIR_REQ_ID
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_ENTRY_COUNT_REQ_ID
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_REQ_ID
SL_WISUN_BR_MSG_REVOKE_PAIRWISE_KEYS_REQ_ID
SL_WISUN_BR_MSG_REVOKE_GTKS_REQ_ID
SL_WISUN_BR_MSG_GET_ROUTING_TABLE_FROM_INDEX_REQ_ID