Infineon Logo AIROC BTSDK v4.4 - Documentation
 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Mesh Provisioning Library API

Mesh provisioning is split into two parts. More...

Data Structures

struct  wiced_bt_mesh_local_device_set_data_t
 
struct  wiced_bt_mesh_set_dev_key_data_t
 
struct  wiced_bt_mesh_add_vendor_model_data_t
 
struct  wiced_bt_mesh_proxy_device_network_data_t
 This structure contains information sent to the provisioner application from the provisioner library with information from the proxy device advertisements while device advertises network identity. More...
 
struct  wiced_bt_mesh_provision_scan_capabilities_status_data_t
 
struct  wiced_bt_mesh_provision_scan_start_data_t
 
struct  wiced_bt_mesh_provision_scan_extended_start_t
 
struct  wiced_bt_mesh_provision_scan_status_data_t
 
struct  wiced_bt_mesh_provision_scan_report_data_t
 
struct  wiced_bt_mesh_provision_scan_extended_report_data_t
 
struct  wiced_bt_mesh_provision_link_status_data_t
 
struct  wiced_bt_mesh_provision_link_report_data_t
 
struct  wiced_bt_mesh_provision_outbound_pdu_report_data_t
 
struct  wiced_bt_mesh_provision_inbound_pdu_report_data_t
 
struct  wiced_bt_mesh_provision_connect_data_t
 
struct  wiced_bt_mesh_connect_status_data_t
 
struct  wiced_bt_mesh_proxy_connect_data_t
 
struct  wiced_bt_mesh_provision_start_data_t
 
struct  wiced_bt_mesh_provision_capabilities_data_t
 
struct  wiced_bt_mesh_provision_status_data_t
 
struct  wiced_bt_mesh_provision_device_capabilities_data_t
 
struct  wiced_bt_mesh_provision_device_record_fragment_data_t
 
struct  wiced_bt_mesh_provision_device_oob_request_data_t
 

Macros

#define WICED_BT_MESH_KEY_LEN   16
 
#define WICED_BT_MESH_TX_TO_FRIEND_COMPLETE   252
 Transmission to friend completed.
 
#define WICED_BT_MESH_RAW_MODEL_DATA   253
 Raw model data for the apps that handle model layer.
 
#define WICED_BT_MESH_PROXY_CONNECTION_STATUS   254
 Proxy connection status.
 
#define WICED_BT_MESH_TX_COMPLETE   255
 Transmission completed, or timeout waiting for peer ack. More...
 
#define WICED_BT_MESH_CONFIG_PRIVATE_BEACON_STATUS   262
 Private Beacon Status.
 
#define WICED_BT_MESH_CONFIG_PRIVATE_GATT_PROXY_STATUS   263
 Private GATT Proxy Status.
 
#define WICED_BT_MESH_CONFIG_PRIVATE_NODE_IDENTITY_STATUS   264
 Private Node Identity Status.
 
#define WICED_BT_MESH_CONFIG_ON_DEMAND_PRIVATE_PROXY_STATUS   265
 On-Demand Private Proxy Status.
 
#define WICED_BT_MESH_SOLICITATION_PDU_RPL_ITEMS_STATUS   266
 Solicitation PDU RPL Items Status.
 
#define WICED_BT_MESH_NETWORK_FILTER_STATUS   267
 Network Filter Status.
 
#define WICED_BT_MESH_DF_DIRECTED_CONTROL_STATUS   268
 
#define WICED_BT_MESH_DF_PATH_METRIC_STATUS   269
 
#define WICED_BT_MESH_DF_DISCOVERY_TABLE_CAPABILITIES_STATUS   270
 
#define WICED_BT_MESH_DF_FORWARDING_TABLE_STATUS   271
 
#define WICED_BT_MESH_DF_FORWARDING_TABLE_DEPENDENTS_STATUS   272
 
#define WICED_BT_MESH_DF_FORWARDING_TABLE_DEPENDENTS_GET_STATUS   273
 
#define WICED_BT_MESH_DF_FORWARDING_TABLE_ENTRIES_COUNT_STATUS   274
 
#define WICED_BT_MESH_DF_FORWARDING_TABLE_ENTRIES_STATUS   275
 
#define WICED_BT_MESH_DF_WANTED_LANES_STATUS   276
 
#define WICED_BT_MESH_DF_TWO_WAY_PATH_STATUS   277
 
#define WICED_BT_MESH_DF_PATH_ECHO_INTERVAL_STATUS   278
 
#define WICED_BT_MESH_DF_DIRECTED_NETWORK_TRANSMIT_STATUS   279
 
#define WICED_BT_MESH_DF_DIRECTED_RELAY_RETRANSMIT_STATUS   280
 
#define WICED_BT_MESH_DF_RSSI_THRESHOLD_STATUS   281
 
#define WICED_BT_MESH_DF_DIRECTED_PATHS_STATUS   282
 
#define WICED_BT_MESH_DF_DIRECTED_PUBLISH_POLICY_STATUS   283
 
#define WICED_BT_MESH_DF_PATH_DISCOVERY_TIMING_CONTROL_STATUS   284
 
#define WICED_BT_MESH_DF_DIRECTED_CONTROL_NETWORK_TRANSMIT_STATUS   285
 
#define WICED_BT_MESH_DF_DIRECTED_CONTROL_RELAY_RETRANSMIT_STATUS   286
 
#define WICED_BT_MESH_CONFIG_LARGE_COMPOS_DATA_STATUS   287
 
#define WICED_BT_MESH_CONFIG_MODELS_METADATA_STATUS   288
 
#define WICED_BT_MESH_CONFIG_SAR_TRANSMITTER_STATUS   289
 
#define WICED_BT_MESH_CONFIG_SAR_RECEIVER_STATUS   290
 
#define OPERATION_ADD   0
 Subscription change: Add.
 
#define OPERATION_DELETE   1
 Subscription change: Delete.
 
#define OPERATION_OVERWRITE   2
 Subscription change: Overwrite.
 
#define OPERATION_UPDATE   2
 Subscription change: Update network key.
 
#define OPERATION_DELETE_ALL   3
 Subscription change: Delete.
 

Typedefs

struct {
   uint16_t   net_key_idx
 Index of the NetKey.
 
wiced_bt_mesh_config_node_identity_get_data_t
 
struct {
   uint16_t   net_key_idx
 Index of the NetKey.
 
   uint8_t   identity
 New Node Identity state.
 
wiced_bt_mesh_config_node_identity_set_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   net_key_idx
 Index of the NetKey.
 
   uint8_t   identity
 Node Identity state.
 
wiced_bt_mesh_config_node_identity_status_data_t
 
struct {
   uint8_t   state
 Target secure beacon state (see MESH_BEACON_STATES)
 
wiced_bt_mesh_config_beacon_set_data_t
 
struct {
   uint8_t   state
 Current secure beacon state (see MESH_BEACON_STATES)
 
wiced_bt_mesh_config_beacon_status_data_t
 
struct {
   uint8_t   page_number
 page number of composition data to get
 
wiced_bt_mesh_config_composition_data_get_data_t
 
struct {
   uint8_t   page_number
 page number of composition data
 
   uint16_t   data_len
 composition data len
 
   uint8_t   data [1]
 first byte of the composition data
 
wiced_bt_mesh_config_composition_data_status_data_t
 
struct {
   uint8_t   ttl
 New Default TTL value.
 
wiced_bt_mesh_config_default_ttl_set_data_t
 
struct {
   uint8_t   ttl
 New Default TTL value.
 
   uint8_t   received_ttl
 Value of the TTL that this message has been received.Client can calculate number of hops to the SRC compairing this and default TTL values. More...
 
wiced_bt_mesh_config_default_ttl_status_data_t
 
struct {
   uint8_t   state
 New GATT Proxy state value (see MESH_GATT_PROXY_STATES)
 
wiced_bt_mesh_config_gatt_proxy_set_data_t
 
struct {
   uint8_t   state
 Current GATT Proxy state value (see MESH_GATT_PROXY_STATES)
 
wiced_bt_mesh_config_gatt_proxy_status_data_t
 
struct {
   uint8_t   state
 New Friend state value (see MESH_FRIEND_STATES)
 
wiced_bt_mesh_config_friend_set_data_t
 
struct {
   uint8_t   state
 Current Friend state value (see MESH_FRIEND_STATES)
 
wiced_bt_mesh_config_friend_status_data_t
 
struct {
   uint16_t   net_key_idx
 NetKey Index.
 
wiced_bt_mesh_config_key_refresh_phase_get_data_t
 
struct {
   uint16_t   net_key_idx
 NetKey Index.
 
   uint8_t   transition
 New Key Refresh Phase Transition (see MESH_KEY_REFRESH_PHASES)
 
wiced_bt_mesh_config_key_refresh_phase_set_data_t
 
struct {
   uint8_t   status
 status
 
   uint16_t   net_key_idx
 NetKey Index.
 
   uint8_t   phase
 Key Refresh Phase State (see MESH_KEY_REFRESH_PHASES)
 
wiced_bt_mesh_config_key_refresh_phase_status_data_t
 
struct {
   uint8_t   state
 New Relay state.
 
   uint8_t   retransmit_count
 Number of retransmissions on advertising bearer for each Network PDU relayed by the node.
 
   uint16_t   retransmit_interval
 Interval in milliseconds between retransmissions.
 
wiced_bt_mesh_config_relay_set_data_t
 
struct {
   uint8_t   state
 Current Relay state.
 
   uint8_t   retransmit_count
 Number of retransmissions on advertising bearer for each Network PDU relayed by the node.
 
   uint16_t   retransmit_interval
 Interval in milliseconds between retransmissions.
 
wiced_bt_mesh_config_relay_status_data_t
 
struct {
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
wiced_bt_mesh_config_model_publication_get_data_t
 
struct {
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
   uint8_t   publish_addr [16]
 Value of the publish address.
 
   uint16_t   app_key_idx
 Index of the application key.
 
   uint8_t   credential_flag
 Value of the Friendship Credential Flag.
 
   uint8_t   publish_ttl
 Default TTL value for the outgoing messages.
 
   uint32_t   publish_period
 Period for periodic status publishing.
 
   uint8_t   publish_retransmit_count
 Number of retransmissions for each published message.
 
   uint16_t   publish_retransmit_interval
 Interval in milliseconds between retransmissions.
 
wiced_bt_mesh_config_model_publication_set_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
   uint16_t   publish_addr
 Value of the publish address.
 
   uint16_t   app_key_idx
 Index of the application key.
 
   uint8_t   credential_flag
 Value of the Friendship Credential Flag.
 
   uint8_t   publish_ttl
 Default TTL value for the outgoing messages.
 
   uint32_t   publish_period
 Period for periodic status publishing.
 
   uint8_t   publish_retransmit_count
 Number of retransmissions for each published message.
 
   uint16_t   publish_retransmit_interval
 Interval in milliseconds between retransmissions.
 
wiced_bt_mesh_config_model_publication_status_data_t
 
struct {
   uint8_t   operation
 Request operation.
 
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
   uint8_t   addr [16]
 Value of the Address.
 
wiced_bt_mesh_config_model_subscription_change_data_t
 
struct {
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
wiced_bt_mesh_config_model_subscription_get_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
   uint16_t   addr
 Value of the address.
 
wiced_bt_mesh_config_model_subscription_status_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
   uint8_t   num_addr
 Number of addresses in the subscription list.
 
   uint16_t   addr [1]
 Value of the first address.
 
wiced_bt_mesh_config_model_subscription_list_data_t
 
struct {
   uint8_t   operation
 Request operation.
 
   uint16_t   net_key_idx
 NetKey Index.
 
   uint8_t   net_key [16]
 Value of the NetKey.
 
wiced_bt_mesh_config_netkey_change_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   net_key_idx
 Index of the NetKey.
 
wiced_bt_mesh_config_netkey_status_data_t
 
struct {
   uint8_t   num_keys
 Number of keys in the list.
 
   uint16_t   net_key_idx [1]
 Value of the netkey index.
 
wiced_bt_mesh_config_netkey_list_data_t
 
struct {
   uint8_t   operation
 Request operation.
 
   uint16_t   net_key_idx
 NetKey Index.
 
   uint16_t   app_key_idx
 AppKey Index.
 
   uint8_t   app_key [16]
 Value of the NetKey.
 
wiced_bt_mesh_config_appkey_change_data_t
 
struct {
   uint16_t   net_key_idx
 NetKey Index.
 
wiced_bt_mesh_config_appkey_get_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   net_key_idx
 Index of the NetKey.
 
   uint16_t   app_key_idx
 Index of the AppKey.
 
wiced_bt_mesh_config_appkey_status_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   net_key_idx
 Index of the NetKey.
 
   uint8_t   num_keys
 Number of keys in the list.
 
   uint16_t   app_key_idx [1]
 Value of the Appkey indexes.
 
wiced_bt_mesh_config_appkey_list_data_t
 
struct {
   uint8_t   operation
 Request operation.
 
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
   uint16_t   app_key_idx
 AppKey Index.
 
wiced_bt_mesh_config_model_app_bind_data_t
 
struct {
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
wiced_bt_mesh_config_model_app_get_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
   uint16_t   app_key_idx
 AppKey Index.
 
wiced_bt_mesh_config_model_app_bind_status_data_t
 
struct {
   uint8_t   status
 Status Code for the requesting message.
 
   uint16_t   element_addr
 Address of the element.
 
   uint16_t   company_id
 Company ID.
 
   uint16_t   model_id
 Model ID.
 
   uint8_t   num_keys
 Number of keys in the list.
 
   uint16_t   app_key_idx [1]
 Value of the model_app indexes.
 
wiced_bt_mesh_config_model_app_list_data_t
 
struct {
   uint16_t   subscription_src
 Source address for Heartbeat messages.
 
   uint16_t   subscription_dst
 Destination address for Heartbeat messages.
 
   uint32_t   period
 Period in seconds for receiving Heartbeat messages.
 
wiced_bt_mesh_config_heartbeat_subscription_set_data_t
 
struct {
   uint8_t   status
 status code for the requesting message
 
   uint16_t   subscription_src
 Source address for Heartbeat messages.
 
   uint16_t   subscription_dst
 Destination address for Heartbeat messages.
 
   uint32_t   period
 Remaining Period in seconds for receiving Heartbeat messages.
 
   uint16_t   count
 Number of hearbeat messages received.
 
   uint8_t   min_hops
 Minimum hops when receiving Heartbeat messages.
 
   uint8_t   max_hops
 Maximum hops when receiving Heartbeat messages.
 
wiced_bt_mesh_config_heartbeat_subscription_status_data_t
 
struct {
   uint16_t   publication_dst
 Destination address for Heartbeat messages.
 
   uint32_t   count
 Number of Heartbeat messages to be sent.
 
   uint32_t   period
 Period in seconds for sending Heartbeat messages.
 
   uint8_t   ttl
 TTL to be used when sending Heartbeat messages.
 
   uint8_t   feature_relay
 Relay feature change triggers a Heartbeat message: 0 = False, 1 = True.
 
   uint8_t   feature_proxy
 Proxy feature change triggers a Heartbeat message: 0 = False, 1 = True.
 
   uint8_t   feature_friend
 Friend feature change triggers a Heartbeat message: 0 = False, 1 = True.
 
   uint8_t   feature_low_power
 Low Power feature change triggers a Heartbeat message: 0 = False, 1 = True.
 
   uint16_t   net_key_idx
 NetKey Index.
 
wiced_bt_mesh_config_heartbeat_publication_set_data_t
 
struct {
   uint8_t   status
 status code for the requesting message
 
   uint16_t   publication_dst
 Destination address for Heartbeat messages.
 
   uint16_t   count
 Number of heartbeat messages received.
 
   uint32_t   period
 Remaining Period in seconds for receiving Heartbeat messages.
 
   uint8_t   ttl
 TTL to be used when sending Heartbeat messages.
 
   uint8_t   feature_relay
 Relay feature change triggers a Heartbeat message: 0 = False, 1 = True.
 
   uint8_t   feature_proxy
 Proxy feature change triggers a Heartbeat message: 0 = False, 1 = True.
 
   uint8_t   feature_friend
 Friend feature change triggers a Heartbeat message: 0 = False, 1 = True.
 
   uint8_t   feature_low_power
 Low Power feature change triggers a Heartbeat message: 0 = False, 1 = True.
 
   uint16_t   net_key_idx
 NetKey Index.
 
wiced_bt_mesh_config_heartbeat_publication_status_data_t
 
struct {
   uint8_t   count
 Number of transmissions for each Network PDU originating from the node.
 
   uint16_t   interval
 Interval between transmissions in milliseconds.
 
wiced_bt_mesh_config_network_transmit_set_data_t
 
struct {
   uint8_t   count
 Number of transmissions for each Network PDU originating from the node.
 
   uint32_t   interval
 Interval between transmissions in milliseconds.
 
wiced_bt_mesh_config_network_transmit_status_data_t
 
struct {
   uint16_t   app_key_idx
 application key to use
 
   uint8_t   test_id
 Identifier of a most recently performed test.
 
   uint16_t   company_id
 16-bit Bluetooth assigned Company Identifier
 
   uint8_t   count
 Number of elements in the fault array.
 
   uint8_t   fault_array [10]
 a sequence of 1-octet fault values
 
wiced_bt_mesh_health_status_data_t
 
struct {
   uint16_t   company_id
 16-bit Bluetooth assigned Company Identifier
 
wiced_bt_mesh_health_fault_get_data_t
 
struct {
   uint16_t   company_id
 16-bit Bluetooth assigned Company Identifier
 
wiced_bt_mesh_health_fault_clear_data_t
 
struct {
   uint8_t   id
 Identifier of a specific test to be performed.
 
   uint16_t   company_id
 16-bit Bluetooth assigned Company Identifier
 
wiced_bt_mesh_health_fault_test_data_t
 
struct {
   uint16_t   app_key_idx
 application key to use
 
   uint8_t   test_id
 Identifier of a most recently performed test.
 
   uint16_t   company_id
 16-bit Bluetooth assigned Company Identifier
 
   uint8_t   count
 Number of elements in the fault array.
 
   uint8_t   fault_array [10]
 a sequence of 1-octet fault values
 
wiced_bt_mesh_health_fault_status_data_t
 
struct {
   uint8_t   divisor
 Divider for the Publish Period. More...
 
wiced_bt_mesh_health_period_set_data_t
 
struct {
   uint16_t   app_key_idx
 application key to use
 
   uint8_t   divisor
 Divider for the Publish Period. More...
 
wiced_bt_mesh_health_period_status_data_t
 
struct {
   uint8_t   timer
 Value of the Attention Timer state.
 
wiced_bt_mesh_health_attention_set_data_t
 
struct {
   uint8_t   timer
 Value of the Attention Timer state.
 
wiced_bt_mesh_health_attention_status_data_t
 
struct {
   uint16_t   lpn_addr
 The unicast address of the Low Power node.
 
wiced_bt_mesh_lpn_poll_timeout_get_data_t
 
struct {
   uint16_t   lpn_addr
 The unicast address of the Low Power node.
 
   uint32_t   poll_timeout
 The current value of the PollTimeout timer of the Low Power node.
 
wiced_bt_mesh_lpn_poll_timeout_status_data_t
 
struct {
   uint8_t   type
 The proxy filter type (0-accept list, 1-reject list). More...
 
wiced_bt_mesh_proxy_filter_set_type_data_t
 
struct {
   uint8_t   addr_num
 Number of addresses in the array.
 
   uint16_t   addr [1]
 First address to delete.
 
wiced_bt_mesh_proxy_filter_change_addr_data_t
 
struct {
   uint8_t   type
 The proxy filter type (0-accept list, 1-reject list). More...
 
   uint16_t   list_size
 Number of addresses in the proxy filter list. More...
 
wiced_bt_mesh_proxy_filter_status_data_t
 
typedef void( wiced_bt_mesh_provision_server_callback_t )(uint16_t event, void *p_data)
 Provision Server callback. More...
 
typedef void( wiced_bt_mesh_provision_client_callback_t )(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)
 Provision Client callback. More...
 
typedef void( wiced_bt_mesh_config_client_callback_t )(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)
 Config Client callback. More...
 
typedef void( wiced_bt_mesh_health_client_callback_t )(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)
 Health Client callback. More...
 
typedef void( wiced_bt_mesh_proxy_client_callback_t )(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)
 Proxy Client callback. More...
 

Functions

void wiced_bt_mesh_app_provision_server_init (uint8_t *pb_priv_key, wiced_bt_mesh_provision_server_callback_t *p_callback)
 Provision Server initialization. More...
 
void wiced_bt_mesh_app_provision_server_configure (wiced_bt_mesh_provision_capabilities_data_t *p_config)
 Provision Server Configuration. More...
 
wiced_bool_t wiced_bt_mesh_provision_set_oob (uint8_t *p_oob, uint8_t len)
 Provision Set Out of Band data. More...
 
wiced_bool_t wiced_bt_mesh_provision_client_set_oob (wiced_bt_mesh_event_t *p_event, uint8_t *p_oob, uint32_t len)
 Provision Set Out of Band data. More...
 
void wiced_bt_mesh_provision_client_init (wiced_bt_mesh_provision_client_callback_t *p_callback, wiced_bool_t is_provisioned)
 Provision Client Model initialization. More...
 
wiced_bool_t wiced_bt_mesh_provision_local_device_set (wiced_bt_mesh_local_device_set_data_t *p_data)
 Provision Local Device. More...
 
void wiced_bt_mesh_provision_set_dev_key (wiced_bt_mesh_set_dev_key_data_t *p_data)
 Set Device Key. More...
 
void wiced_bt_mesh_add_vendor_model (wiced_bt_mesh_add_vendor_model_data_t *p_data)
 Add Vendor Model. More...
 
void wiced_bt_mesh_adv_tx_power_set (uint8_t adv_tx_power)
 Set ADV Tx Power. More...
 
wiced_bool_t wiced_bt_mesh_provision_scan_unprovisioned_devices (wiced_bool_t start)
 Scan Unprovisioned Devices. More...
 
wiced_bool_t wiced_bt_mesh_provision_connect (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_provision_connect_data_t *p_data, uint8_t use_gatt)
 Provision Connect. More...
 
wiced_bool_t wiced_bt_mesh_provision_disconnect (wiced_bt_mesh_event_t *p_event)
 Provision Disconnect. More...
 
wiced_bool_t wiced_bt_mesh_provision_start (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_provision_start_data_t *p_data)
 Provision Start. More...
 
wiced_bool_t wiced_bt_mesh_client_proxy_connect (wiced_bt_mesh_proxy_connect_data_t *p_data)
 Proxy Connect. More...
 
wiced_bool_t wiced_bt_mesh_client_proxy_disconnect (void)
 Proxy Disconnect. More...
 
void wiced_bt_mesh_config_client_init (wiced_bt_mesh_config_client_callback_t *p_callback, wiced_bool_t is_provisioned)
 Config Client Model initialization. More...
 
void wiced_bt_mesh_config_client_connection_state_change (wiced_bool_t is_connected)
 Connection status change notification. More...
 
wiced_bool_t wiced_bt_mesh_config_client_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
 Config Client Model Message Handler. More...
 
wiced_bool_t wiced_bt_mesh_config_node_reset (wiced_bt_mesh_event_t *p_event)
 Node Reset. More...
 
wiced_bool_t wiced_bt_mesh_config_beacon_get (wiced_bt_mesh_event_t *p_event)
 Get Secure Beacon state. More...
 
wiced_bool_t wiced_bt_mesh_config_beacon_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_beacon_set_data_t *p_set)
 Set Secure Beacon state. More...
 
wiced_bool_t wiced_bt_mesh_config_composition_data_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_composition_data_get_data_t *p_get)
 Get Composition Data of the device. More...
 
wiced_bool_t wiced_bt_mesh_config_default_ttl_get (wiced_bt_mesh_event_t *p_event)
 Get Default TTL. More...
 
wiced_bool_t wiced_bt_mesh_config_default_ttl_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_default_ttl_set_data_t *p_set)
 Set Default TTL. More...
 
wiced_bool_t wiced_bt_mesh_config_relay_get (wiced_bt_mesh_event_t *p_event)
 Get Relay Status. More...
 
wiced_bool_t wiced_bt_mesh_config_relay_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_relay_set_data_t *p_set)
 Set Relay Status. More...
 
wiced_bool_t wiced_bt_mesh_config_gatt_proxy_get (wiced_bt_mesh_event_t *p_event)
 Get GATT Proxy State. More...
 
wiced_bool_t wiced_bt_mesh_config_gatt_proxy_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_gatt_proxy_set_data_t *p_set)
 Set GATT Proxy State. More...
 
wiced_bool_t wiced_bt_mesh_config_friend_get (wiced_bt_mesh_event_t *p_event)
 Get Friend State. More...
 
wiced_bool_t wiced_bt_mesh_config_friend_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_friend_set_data_t *p_set)
 Set Friend State. More...
 
wiced_bool_t wiced_bt_mesh_config_key_refresh_phase_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_key_refresh_phase_get_data_t *p_get)
 Get Key Refresh Phase. More...
 
wiced_bool_t wiced_bt_mesh_config_key_refresh_phase_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_key_refresh_phase_set_data_t *p_set)
 Set Key Refresh Phase. More...
 
wiced_bool_t wiced_bt_mesh_config_node_identity_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_node_identity_get_data_t *p_get)
 Get Node Identity State. More...
 
wiced_bool_t wiced_bt_mesh_config_node_identity_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_node_identity_set_data_t *p_set)
 Set Node Identity State. More...
 
wiced_bool_t wiced_bt_mesh_config_model_publication_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_model_publication_get_data_t *p_get)
 Get Model Publication Information. More...
 
wiced_bool_t wiced_bt_mesh_config_model_publication_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_model_publication_set_data_t *p_set)
 Set Model Publication. More...
 
wiced_bool_t wiced_bt_mesh_config_model_subscription_change (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_model_subscription_change_data_t *p_data)
 Change Model Subscription. More...
 
wiced_bool_t wiced_bt_mesh_config_model_subscription_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_model_subscription_get_data_t *p_data)
 Get Model Subscription. More...
 
wiced_bool_t wiced_bt_mesh_config_netkey_change (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_netkey_change_data_t *p_data)
 Change Network Key. More...
 
wiced_bool_t wiced_bt_mesh_config_netkey_get (wiced_bt_mesh_event_t *p_event)
 Get Network Keys. More...
 
wiced_bool_t wiced_bt_mesh_config_appkey_change (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_appkey_change_data_t *p_data)
 Change Application Key. More...
 
wiced_bool_t wiced_bt_mesh_config_appkey_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_appkey_get_data_t *p_data)
 Get Application Keys. More...
 
wiced_bool_t wiced_bt_mesh_config_model_app_bind (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_model_app_bind_data_t *p_data)
 Change Model to Application Key Binding. More...
 
wiced_bool_t wiced_bt_mesh_config_model_app_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_model_app_get_data_t *p_data)
 Get Application Keys the Model is bound to. More...
 
wiced_bool_t wiced_bt_mesh_config_heartbeat_subscription_get (wiced_bt_mesh_event_t *p_event)
 Heartbeat Subscription Get. More...
 
wiced_bool_t wiced_bt_mesh_config_heartbeat_subscription_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_heartbeat_subscription_set_data_t *p_set)
 Heartbeat Subscription Set. More...
 
wiced_bool_t wiced_bt_mesh_config_heartbeat_publication_get (wiced_bt_mesh_event_t *p_event)
 Heartbeat Publication Get. More...
 
wiced_bool_t wiced_bt_mesh_config_heartbeat_publication_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_heartbeat_publication_set_data_t *p_set)
 Heartbeat Publication Set. More...
 
wiced_bool_t wiced_bt_mesh_config_network_transmit_params_get (wiced_bt_mesh_event_t *p_event)
 Network Transmit Parameters Get. More...
 
wiced_bool_t wiced_bt_mesh_config_network_transmit_params_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_config_network_transmit_set_data_t *p_set)
 Network Transmit Parameters Set. More...
 
void wiced_bt_mesh_health_client_init (wiced_bt_mesh_health_client_callback_t *p_callback, wiced_bool_t is_provisioned)
 Health Client Model initialization. More...
 
wiced_bool_t wiced_bt_mesh_model_health_client_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
 Health Client Model Message Handler. More...
 
wiced_bool_t wiced_bt_mesh_health_fault_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_health_fault_get_data_t *p_get)
 Health Fault Get. More...
 
wiced_bool_t wiced_bt_mesh_health_fault_clear (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_health_fault_clear_data_t *p_clear)
 Health Fault Clear. More...
 
wiced_bool_t wiced_bt_mesh_health_fault_test (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_health_fault_test_data_t *p_clear)
 Health Fault Test. More...
 
wiced_bool_t wiced_bt_mesh_health_period_get (wiced_bt_mesh_event_t *p_event)
 Health Period Get. More...
 
wiced_bool_t wiced_bt_mesh_health_period_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_health_period_set_data_t *p_set)
 Health Period Set. More...
 
wiced_bool_t wiced_bt_mesh_health_attention_get (wiced_bt_mesh_event_t *p_event)
 Health Attention Get. More...
 
wiced_bool_t wiced_bt_mesh_health_attention_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_health_attention_set_data_t *p_set)
 Health Attention Set. More...
 
wiced_bool_t wiced_bt_mesh_lpn_poll_timeout_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_lpn_poll_timeout_get_data_t *p_get)
 LPN Poll Timeout Get. More...
 
void wiced_bt_mesh_client_init (wiced_bt_mesh_provision_client_callback_t *p_callback, wiced_bool_t is_provisioned)
 Mesh GATT client initialization. More...
 
void wiced_bt_mesh_gatt_client_process_connectable_adv (uint8_t *bd_addr, uint8_t ble_addr_type, int8_t rssi, uint8_t *p_adv_data)
 Process connectable advertisement. More...
 
void wiced_bt_mesh_proxy_client_init (wiced_bt_mesh_proxy_client_callback_t *p_callback, wiced_bool_t is_provisioned)
 Proxy Client Model initialization. More...
 
wiced_bool_t wiced_bt_mesh_proxy_client_message_handler (wiced_bt_mesh_event_t *p_event, const uint8_t *p_data, uint16_t data_len)
 Proxy Client Message Handler. More...
 
wiced_bool_t wiced_bt_mesh_proxy_set_filter_type (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_proxy_filter_set_type_data_t *p_set)
 Proxy Client Set Filter Type. More...
 
wiced_bool_t wiced_bt_mesh_proxy_filter_change_addr (wiced_bt_mesh_event_t *p_event, wiced_bool_t is_add, wiced_bt_mesh_proxy_filter_change_addr_data_t *p_addr)
 Proxy Client Change Filter. More...
 
wiced_bool_t wiced_bt_mesh_remote_provisioning_server_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
 Remote Provisioning Server Model Message Handler. More...
 
wiced_bool_t wiced_bt_mesh_provision_scan_capabilities_get (wiced_bt_mesh_event_t *p_event)
 Scan Capabilities Get. More...
 
wiced_bool_t wiced_bt_mesh_provision_scan_get (wiced_bt_mesh_event_t *p_event)
 Scan Info Get. More...
 
wiced_bool_t wiced_bt_mesh_provision_scan_start (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_provision_scan_start_data_t *p_data)
 Scan Start. More...
 
wiced_bool_t wiced_bt_mesh_provision_scan_extended_start (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_provision_scan_extended_start_t *p_data)
 Extended Scan Info Get. More...
 
wiced_bool_t wiced_bt_mesh_provision_scan_stop (wiced_bt_mesh_event_t *p_event)
 Scan Stop. More...
 
wiced_bool_t wiced_bt_mesh_provision_retrieve_record (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_provision_device_record_fragment_data_t *p_data)
 Retrieve fragment of the provisioning record from the peer device. More...
 
wiced_bool_t wiced_bt_mesh_provision_send_invite (wiced_bt_mesh_event_t *p_event)
 The function can be called by application triggering Remote Provisioning Server to send invite PDU to device. More...
 

Variables

uint8_t wiced_bt_mesh_provision_dev_key_max_num
 

Definition for messages exchanged between the Provisioner Library and the Provisioner Client Application

#define WICED_BT_MESH_COMMAND_STATUS   200
 Local device processed command from the MCU.
 
#define WICED_BT_MESH_PROVISION_CONNECT_STATUS   202
 Provision Link established or dropped.
 
#define WICED_BT_MESH_PROVISION_STARTED   203
 Provisioning started.
 
#define WICED_BT_MESH_PROVISION_END   204
 Provisioning completed.
 
#define WICED_BT_MESH_PROVISION_DEVICE_CAPABILITIES   205
 Provisioning device capabilities.
 
#define WICED_BT_MESH_PROVISION_GET_OOB_DATA   206
 Provisioning get out of band data request.
 
#define WICED_BT_MESH_PROXY_DEVICE   207
 Proxy device info.
 
#define WICED_BT_MESH_DEVICE_PROVISIONING_RECORD_LIST   208
 List of provisioning record.
 
#define WICED_BT_MESH_DEVICE_PROVISIONING_RECORD_RESP   209
 Provisioning record response.
 

Definition for the mesh config messages exchanged between the Provisioner Library and the Provisioner Client Application

#define WICED_BT_MESH_CONFIG_NODE_RESET_STATUS   210
 Config Node Reset Status.
 
#define WICED_BT_MESH_CONFIG_FRIEND_STATUS   211
 Config Friend Status.
 
#define WICED_BT_MESH_CONFIG_GATT_PROXY_STATUS   212
 Config GATT Proxy Status.
 
#define WICED_BT_MESH_CONFIG_RELAY_STATUS   213
 Config Relay Status.
 
#define WICED_BT_MESH_CONFIG_BEACON_STATUS   214
 Config Beacon Status.
 
#define WICED_BT_MESH_CONFIG_DEFAULT_TTL_STATUS   215
 Config Default TTL Status.
 
#define WICED_BT_MESH_CONFIG_NODE_IDENTITY_STATUS   216
 Config Node Identity Status.
 
#define WICED_BT_MESH_CONFIG_MODEL_PUBLICATION_STATUS   217
 Config Model Publication Status.
 
#define WICED_BT_MESH_CONFIG_MODEL_SUBSCRIPTION_STATUS   218
 Config Model Subscription Status.
 
#define WICED_BT_MESH_CONFIG_MODEL_SUBSCRIPTION_LIST   219
 Config Model Subscription List.
 
#define WICED_BT_MESH_CONFIG_NETKEY_STATUS   220
 Config Network Key Status.
 
#define WICED_BT_MESH_CONFIG_NETKEY_LIST   221
 Config Network Key List.
 
#define WICED_BT_MESH_CONFIG_APPKEY_STATUS   222
 Config Application Key Status.
 
#define WICED_BT_MESH_CONFIG_APPKEY_LIST   223
 Config Application List.
 
#define WICED_BT_MESH_CONFIG_MODEL_APP_BIND_STATUS   224
 Config Model Application Bind Status.
 
#define WICED_BT_MESH_CONFIG_MODEL_APP_BIND_LIST   225
 Config Model Application Bind List.
 
#define WICED_BT_MESH_CONFIG_COMPOSITION_DATA_STATUS   226
 Config Composition Data Status.
 
#define WICED_BT_MESH_CONFIG_HEARBEAT_SUBSCRIPTION_STATUS   227
 Config Heartbeat Subscription Status.
 
#define WICED_BT_MESH_CONFIG_HEARBEAT_PUBLICATION_STATUS   228
 Config Heartbeat Publication Status.
 
#define WICED_BT_MESH_CONFIG_NETWORK_TRANSMIT_STATUS   229
 Config Network Transmit Parameters Status.
 
#define WICED_BT_MESH_CONFIG_LPN_POLL_TIMEOUT_STATUS   230
 Low Power Node Poll Timeout Status.
 
#define WICED_BT_MESH_CONFIG_KEY_REFRESH_PHASE_STATUS   231
 Config Network Transmit Parameters Status.
 

Definition for the mesh health messages exchanged between the Provisioner Library and the Provisioner Client Application

#define WICED_BT_MESH_HEALTH_CURRENT_STATUS   232
 Current Health state of an element.
 
#define WICED_BT_MESH_HEALTH_FAULT_STATUS   233
 Registered Fault state of an element.
 
#define WICED_BT_MESH_HEALTH_PERIOD_STATUS   234
 Registered Fault state of an element.
 
#define WICED_BT_MESH_HEALTH_ATTENTION_STATUS   235
 Registered Fault state of an element.
 

Definition for the mesh filter messages exchanged between the Provisioner Library and the Provisioner Client Application

#define WICED_BT_MESH_PROXY_FILTER_STATUS   237
 Current filter status of the proxy.
 

Definition for the mesh core messages exchanged between the Core Library and the Provisioner Client Application

#define WICED_BT_MESH_SEQ_CHANGED   238
 Sequence number changed.
 
#define WICED_BT_MESH_IV_CHANGED   239
 IV Index or/and IV_UPDATE flag changed.
 

Definition for the mesh provisioning messages exchanged between the Provisioner Library and the Provisioner Client Application

#define WICED_BT_MESH_PROVISION_SCAN_CAPABILITIES_STATUS   240
 Scan Info Status.
 
#define WICED_BT_MESH_PROVISION_SCAN_STATUS   241
 Scan Status.
 
#define WICED_BT_MESH_PROVISION_SCAN_REPORT   242
 Scan Report.
 
#define WICED_BT_MESH_PROVISION_SCAN_EXTENDED_REPORT   243
 Scan Extended Report.
 
#define WICED_BT_MESH_PROVISION_LINK_STATUS   244
 Link Status.
 
#define WICED_BT_MESH_PROVISION_LINK_REPORT   245
 Link Report.
 
#define WICED_BT_MESH_PROVISION_PDU_OUTBOUND_REPORT   247
 PDU Outbound Report.
 
#define WICED_BT_MESH_PROVISION_PDU_REPORT   248
 PDU Report.
 

Detailed Description

Mesh provisioning is split into two parts.

The server side applies to all devices and allows a provisioner to add this device to a mesh network. It is implemented in the Mesh application library so that each mesh application can easily link this functionality in. The client part is implemented in the Mesh Provisioning library of the AIROC BTSDK which provide a simple method for an application to integrate functionality to add other devices to the mesh network.

Macro Definition Documentation

#define WICED_BT_MESH_TX_COMPLETE   255

Transmission completed, or timeout waiting for peer ack.

Typedef Documentation

typedef void( wiced_bt_mesh_config_client_callback_t)(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)

Config Client callback.

The Config Client callback is called by the Mesh Core library on receiving a Foundation Model Configuration Status messages from the peer

Parameters
eventEvent that the application should process (see Mesh Config Events)
p_dataParsed data received in the status message.
Returns
None
typedef void( wiced_bt_mesh_health_client_callback_t)(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)

Health Client callback.

The Health Client callback is called by the Mesh Core library on receiving a Foundation Model Health Status messages from the peer

Parameters
eventEvent that the application should process (see Mesh Health Events)
p_eventMesh event with information about received message or failed tx message.
p_dataParsed data received in the status message.
Returns
None
typedef void( wiced_bt_mesh_provision_client_callback_t)(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)

Provision Client callback.

The Provision Client callback is called by the Mesh Provision library during the provisioning of a peer device

Parameters
eventEvent that the application should process (see Mesh Provisioner Events)
p_eventPointer to the data structure identifying the source of the message
p_dataData with provisioning information.
Returns
None
typedef void( wiced_bt_mesh_provision_server_callback_t)(uint16_t event, void *p_data)

Provision Server callback.

The Provision Server callback is called by the Mesh Application library during the provisioning of this device. Application does not need to implement this callback if the public key is not shared out of band and if out of band authentication is not used

Parameters
eventEvent that the application should process (see Mesh Provisioner Events)
p_dataData with provisioning information.
Returns
None
typedef void( wiced_bt_mesh_proxy_client_callback_t)(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)

Proxy Client callback.

The Proxy Client callback is called by the Mesh Core library on receiving a Proxy Status messages from the peer

Parameters
eventEvent that the application should process (see Proxy Events)
p_eventMesh event with information about received message or failed tx message.
p_dataParsed data received in the status message.
Returns
None

Function Documentation

void wiced_bt_mesh_add_vendor_model ( wiced_bt_mesh_add_vendor_model_data_t p_data)

Add Vendor Model.

The application can call this function to add vendor model to mesh core. Once added, mesh core forwards all vendor specific messages/event to vendor client message handler.

Parameters
[in]p_dataPointer to the data structure with vendor model information.
Returns
None
void wiced_bt_mesh_adv_tx_power_set ( uint8_t  adv_tx_power)

Set ADV Tx Power.

The application can call this function to set ADV Tx Power in the mesh core. Once set, mesh core will use updated Tx power for subsequent advertisements.

Parameters
[in]adv_tx_powerADV Tx Power value to set (0:min - 4:max).
Returns
None
void wiced_bt_mesh_app_provision_server_configure ( wiced_bt_mesh_provision_capabilities_data_t p_config)

Provision Server Configuration.

By default an application does not expose provisioning public key and does not use any of the provisioning authentication methods. A real application should call this function to provide device out of band provisioning capabilities.

Parameters
p_configOut of band provisioning information
Returns
None
void wiced_bt_mesh_app_provision_server_init ( uint8_t *  pb_priv_key,
wiced_bt_mesh_provision_server_callback_t p_callback 
)

Provision Server initialization.

This function should be called by every Mesh Application during startup. If the device is capable of sharing its public key out of band: The pointer callback is required if the device provides an out of band method to share the public key with the Provisioner or if there is an out of band method to perform authentication.

Parameters
pb_priv_keyDevice private key
p_callbackThe application callback function that will be executed when the application library needs out of band information.
Returns
None
void wiced_bt_mesh_client_init ( wiced_bt_mesh_provision_client_callback_t p_callback,
wiced_bool_t  is_provisioned 
)

Mesh GATT client initialization.

The Provisioner Application should call this function during startup to register a callback which will be executed when a proxy status message is received.

Parameters
p_callbackThe application callback function that will be executed by the Mesh Model library when application action is required, or when a reply for the application request has been received.
is_provisionedis_provisioned If TRUE, the application is being restarted after being provisioned or after a power loss. If FALSE the model cleans up NVRAM on startup.
Returns
None
wiced_bool_t wiced_bt_mesh_client_proxy_connect ( wiced_bt_mesh_proxy_connect_data_t p_data)

Proxy Connect.

The application can call this function to establish GATT Proxy connection. Depending on the parameters the connection should be establishing either to a device advertising it's identity, or a device advertising a mesh network

Parameters
p_dataPointer to the data structure with the node identity or network.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_client_proxy_disconnect ( void  )

Proxy Disconnect.

The application can call this function to terminate GATT Proxy connection.

Parameters
None
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_appkey_change ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_appkey_change_data_t *  p_data 
)

Change Application Key.

The application can call this function to change a device application key by sending a Config AppKey Add, Delete, or Update message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_dataPointer to the data structure of Change Application Key.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_appkey_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_appkey_get_data_t *  p_data 
)

Get Application Keys.

The application can call this function to get current application keys list by sending a Config AppKey Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_dataPointer to the data structure of Get Application Key.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_beacon_get ( wiced_bt_mesh_event_t p_event)

Get Secure Beacon state.

The application can call this function to send a Config Beacon Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_beacon_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_beacon_set_data_t *  p_set 
)

Set Secure Beacon state.

The application can call this function to send a Config Beacon Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Config Beacon Set message.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
void wiced_bt_mesh_config_client_connection_state_change ( wiced_bool_t  is_connected)

Connection status change notification.

The Provisioner Application should call this function to indicate when connection to the proxy goes up or down.

Parameters
is_connectedIf TRUE, Connection to the application has been established.
Returns
None
void wiced_bt_mesh_config_client_init ( wiced_bt_mesh_config_client_callback_t p_callback,
wiced_bool_t  is_provisioned 
)

Config Client Model initialization.

The Provisioner Application should call this function during startup to register a callback which will be executed when a configuration status message is received.

Parameters
p_callbackThe application callback function that will be executed by the Mesh Model library when application action is required, or when a reply for the application request has been received.
is_provisionedis_provisioned If TRUE, the application is being restarted after being provisioned or after a power loss. If FALSE the model cleans up NVRAM on startup.
Returns
None
wiced_bool_t wiced_bt_mesh_config_client_message_handler ( wiced_bt_mesh_event_t p_event,
uint8_t *  p_data,
uint16_t  data_len 
)

Config Client Model Message Handler.

Application Library typically calls this function when function to process a message received from the Config Server. The function parses the message and if appropriate calls the application back to perform functionality.

Parameters
p_eventMesh event with information about received message.
p_dataPointer to the data portion of the message
data_lenLength of the data in the message
Returns
WICED_TRUE if the message is for this company ID/Model combination, WICED_FALSE otherwise.
wiced_bool_t wiced_bt_mesh_config_composition_data_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_composition_data_get_data_t *  p_get 
)

Get Composition Data of the device.

The application can call this function to send a Composition Data Get message to a peer device.

Parameters
[in]p_dataPointer to the data structure with the address of the peer device.
[in]p_getPointer to the data structure of Composition Data .
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_default_ttl_get ( wiced_bt_mesh_event_t p_event)

Get Default TTL.

The application can call this function to send a Config Default TTL Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_default_ttl_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_default_ttl_set_data_t *  p_set 
)

Set Default TTL.

The application can call this function to send a Config Default TTL Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of new Default TTL value.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_friend_get ( wiced_bt_mesh_event_t p_event)

Get Friend State.

The application can call this function to send a Config Friend Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_friend_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_friend_set_data_t *  p_set 
)

Set Friend State.

The application can call this function to send a Config Friend Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Set Friend State.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_gatt_proxy_get ( wiced_bt_mesh_event_t p_event)

Get GATT Proxy State.

The application can call this function to send a Config GATT Proxy Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_gatt_proxy_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_gatt_proxy_set_data_t *  p_set 
)

Set GATT Proxy State.

The application can call this function to send a Config GATT Proxy Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Set GATT Proxy State..
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_heartbeat_publication_get ( wiced_bt_mesh_event_t p_event)

Heartbeat Publication Get.

The application can call the Heartbeat Publication Get to send Heartbeat Publication Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_heartbeat_publication_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_heartbeat_publication_set_data_t *  p_set 
)

Heartbeat Publication Set.

The application can call the Heartbeat Publication Set to send Heartbeat Publication Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Heartbeat Publication Set information
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_heartbeat_subscription_get ( wiced_bt_mesh_event_t p_event)

Heartbeat Subscription Get.

The application can call the Heartbeat Subscription Get to send Heartbeat Subscription Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_heartbeat_subscription_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_heartbeat_subscription_set_data_t *  p_set 
)

Heartbeat Subscription Set.

The application can call the Heartbeat Subscription Set to send Heartbeat Subscription Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Get Application Keys the Model is bound to.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_key_refresh_phase_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_key_refresh_phase_get_data_t *  p_get 
)

Get Key Refresh Phase.

The application can call this function to to get the current Key Refresh Phase state of the identified network key.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_getPointer to the data structure of Get Key Refresh Phase.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_key_refresh_phase_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_key_refresh_phase_set_data_t *  p_set 
)

Set Key Refresh Phase.

The application can call this function to set the Key Refresh Phase state of the identified network key.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Set Key Refresh Phase.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_model_app_bind ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_model_app_bind_data_t *  p_data 
)

Change Model to Application Key Binding.

The application can call this function to change a a model to application key binding by sending a Config Model App Bind o Unbind message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_dataPointer to the data structure of Change Model to Application Key Binding.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_model_app_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_model_app_get_data_t *  p_data 
)

Get Application Keys the Model is bound to.

The application can call this function to get current application keys list bound to a specific Model by sending a Config Model App Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_dataPointer to the data structure of Get Application Keys the Model is bound to.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_model_publication_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_model_publication_get_data_t *  p_get 
)

Get Model Publication Information.

The application can call this function to send a Config Model Publication Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_getPointer to the data structure of Get Model Publication Information.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_model_publication_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_model_publication_set_data_t *  p_set 
)

Set Model Publication.

The application can call this function to send a Config Model Publication Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Set Model Publication.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_model_subscription_change ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_model_subscription_change_data_t *  p_data 
)

Change Model Subscription.

The application can call this function to change a model subscription data by sending a Config Model Subscription Add, Virtual Address Add, Delete, Virtual Address Delete, Overwrite, Virtual Address Overwrite, or Delete All message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_dataPointer to the data structure of Set Model Publication.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_model_subscription_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_model_subscription_get_data_t *  p_data 
)

Get Model Subscription.

The application can call this function to get current model subscription list by sending a Config Model Subscription Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_dataPointer to the data structure of Get Model Publication.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_netkey_change ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_netkey_change_data_t *  p_data 
)

Change Network Key.

The application can call this function to change a device network keys by sending a Config NetKey Add, Delete, or Update message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_dataPointer to the data structure of Change Network Key.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_netkey_get ( wiced_bt_mesh_event_t p_event)

Get Network Keys.

The application can call this function to get current network keys list by sending a Config NetKey Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_network_transmit_params_get ( wiced_bt_mesh_event_t p_event)

Network Transmit Parameters Get.

The application can call this function to send a Config Network Transmit Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_network_transmit_params_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_network_transmit_set_data_t *  p_set 
)

Network Transmit Parameters Set.

The application can call this function to send a Config Network Transmit Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Network Transmit Parameters Set.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_node_identity_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_node_identity_get_data_t *  p_get 
)

Get Node Identity State.

The application can call this function to send a Config Node Identity Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_getPointer to the data structure of Get Node Identity State.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_node_identity_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_node_identity_set_data_t *  p_set 
)

Set Node Identity State.

The application can call this function to send a Config Node Identity message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Set Node Identity State.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_node_reset ( wiced_bt_mesh_event_t p_event)

Node Reset.

The application can call this function to send a Config Node Reset message to a peer device.

Parameters
[in]p_dataPointer to the data structure with the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_relay_get ( wiced_bt_mesh_event_t p_event)

Get Relay Status.

The application can call this function to send a Config Relay Get message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_config_relay_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_config_relay_set_data_t *  p_set 
)

Set Relay Status.

The application can call this function to send a Config Relay Set message to a peer device.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Set Relay Status.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
void wiced_bt_mesh_gatt_client_process_connectable_adv ( uint8_t *  bd_addr,
uint8_t  ble_addr_type,
int8_t  rssi,
uint8_t *  p_adv_data 
)

Process connectable advertisement.

Process connectable advertisement packet.

Parameters
bd_addrAdvertiser device address
ble_addr_typeAdvertiser device address type
rssiRSSI of received advertisements
p_adv_dataPointer to advertising data
Returns
None
wiced_bool_t wiced_bt_mesh_health_attention_get ( wiced_bt_mesh_event_t p_event)

Health Attention Get.

The application can call this function to get the Attention Timer state of an element.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_health_attention_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_health_attention_set_data_t *  p_set 
)

Health Attention Set.

LPN Poll Timeout Set.

The application can call this function to set the Attention Timer state of an element.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Health Attention Set.
Returns
WICED_TRUE/WICED_FALSE - success/failed.

The application can call this function to set the Attention Timer state of an element.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of LPN Poll Timeout Set.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
void wiced_bt_mesh_health_client_init ( wiced_bt_mesh_health_client_callback_t p_callback,
wiced_bool_t  is_provisioned 
)

Health Client Model initialization.

The Provisioner Application should call this function during startup to register a callback which will be executed when a health status message is received.

Parameters
p_callbackThe application callback function that will be executed by the Mesh Model library when application action is required, or when a reply for the application request has been received.
is_provisionedis_provisioned If TRUE, the application is being restarted after being provisioned or after a power loss. If FALSE the model cleans up NVRAM on startup.
Returns
None
wiced_bool_t wiced_bt_mesh_health_fault_clear ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_health_fault_clear_data_t *  p_clear 
)

Health Fault Clear.

The application can call this function to clear the current Registered Fault state identified by Company ID of an element.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_clearPointer to the data structure of Health Fault Clear.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_health_fault_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_health_fault_get_data_t *  p_get 
)

Health Fault Get.

The application can call this function to get the current Registered Fault state identified by Company ID of an element.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_getPointer to the data structure of Health Fault Get.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_health_fault_test ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_health_fault_test_data_t *  p_clear 
)

Health Fault Test.

The application can call this function to invoke a self-test procedure of an element.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_clearPointer to the data structure of Health Fault Test.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_health_period_get ( wiced_bt_mesh_event_t p_event)

Health Period Get.

The application can call this function to get the current Health Period state of an element.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_health_period_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_health_period_set_data_t *  p_set 
)

Health Period Set.

The application can call this function to set the current Health Period state of an element.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure of Health Period Set.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_lpn_poll_timeout_get ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_lpn_poll_timeout_get_data_t *  p_get 
)

LPN Poll Timeout Get.

The application can call this function to get the LPN Poll Timeout value.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_getPointer to the data structure of LPN Poll Timeout Get.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_model_health_client_message_handler ( wiced_bt_mesh_event_t p_event,
uint8_t *  p_data,
uint16_t  data_len 
)

Health Client Model Message Handler.

Application Library typically calls this function when function to process a message received from the Health Server. The function parses the message and if appropriate calls the application back to perform functionality.

Parameters
p_eventMesh event with information about received message.
p_dataPointer to the data portion of the message
data_lenLength of the data in the message
Returns
WICED_TRUE if the message is for this company ID/Model combination, WICED_FALSE otherwise.
void wiced_bt_mesh_provision_client_init ( wiced_bt_mesh_provision_client_callback_t p_callback,
wiced_bool_t  is_provisioned 
)

Provision Client Model initialization.

The Provisioner Application should call this function during the startup to register a callback which will be executed during provisioning.

Parameters
p_callbackThe application callback function that will be executed by the Mesh Provisioning library when application action is required, or when a reply for the application request has been received.
is_provisionedis_provisioned If TRUE, the application is being restarted after being provisioned or after a power loss. If FALSE the model cleans up NVRAM on startup.
Returns
None
wiced_bool_t wiced_bt_mesh_provision_client_set_oob ( wiced_bt_mesh_event_t p_event,
uint8_t *  p_oob,
uint32_t  len 
)

Provision Set Out of Band data.

Application should call this function to setup OOB data used during provisioning

Parameters
p_eventPointer to the mesh event which identifies remote provisioning server
p_oobOut of band data
lenOut of band data length
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_connect ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_provision_connect_data_t p_data,
uint8_t  use_gatt 
)

Provision Connect.

The application can call this function to establish provisioning link.

Parameters
p_eventPointer to the event structure which identified the remote provisioning server.
p_dataPointer to the data structure with the uuid and address of the peer device.
use_gattIf 1, provision over PB-GATT.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_disconnect ( wiced_bt_mesh_event_t p_event)

Provision Disconnect.

The application can call this function to disconnect provisioning link.

Parameters
p_eventPointer to the event structure which identified the remote provisioning server.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_local_device_set ( wiced_bt_mesh_local_device_set_data_t p_data)

Provision Local Device.

The application can call this function to setup local device to be a part of the network.

Parameters
[in]p_dataPointer to the data structure with provisioning information.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_retrieve_record ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_provision_device_record_fragment_data_t p_data 
)

Retrieve fragment of the provisioning record from the peer device.

Parameters
p_eventmesh event
p_datapointer to the fragment descriptor to get
Returns
wiced_bool_t WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_scan_capabilities_get ( wiced_bt_mesh_event_t p_event)

Scan Capabilities Get.

The function can be called by the application to Send Remote Provisioning Scan Capabilities Get to Remote Provisioning Server.

Parameters
[in]p_eventMesh event with information about contains information about destination address and transmission parameters.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_scan_extended_start ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_provision_scan_extended_start_t p_data 
)

Extended Scan Info Get.

The function can be called by the application to Send Remote Provisioning Extended Scan Info Get message to Remote Provisioning Server.

Parameters
[in]p_eventMesh event with information about contains information about destination address and transmission parameters.
[in]p_dataExtended Scan Info Get Parameters
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_scan_get ( wiced_bt_mesh_event_t p_event)

Scan Info Get.

The function can be called by the application to Send Remote Provisioning Scan Get to Remote Provisioning Server.

Parameters
[in]p_eventMesh event with information about contains information about destination address and transmission parameters.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_scan_start ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_provision_scan_start_data_t p_data 
)

Scan Start.

The function can be called by the application to Send Remote Provisioning Scan Start to Remote Provisioning Server.

Parameters
[in]p_eventMesh event with information about contains information about destination address and transmission parameters.
[in]p_dataScan Parameters
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_scan_stop ( wiced_bt_mesh_event_t p_event)

Scan Stop.

The function can be called by the application to Send Remote Provisioning Scan Stop to Remote Provisioning Server.

Parameters
[in]p_eventMesh event with information about contains information about destination address and transmission parameters.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_scan_unprovisioned_devices ( wiced_bool_t  start)

Scan Unprovisioned Devices.

The application can call this function to start scanning for unprovisioned devices.

Parameters
[in]startSet to 1 to start scan or 0 to stop scan.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_send_invite ( wiced_bt_mesh_event_t p_event)

The function can be called by application triggering Remote Provisioning Server to send invite PDU to device.

Parameters
p_eventmesh event
Returns
wiced_bool_t WICED_TRUE/WICED_FALSE - success/failed.
void wiced_bt_mesh_provision_set_dev_key ( wiced_bt_mesh_set_dev_key_data_t p_data)

Set Device Key.

The application can call this function to setup device key. Application can setup a key once and then send multiple configuration messages. When application decides to configure another device, it needs to change associated device key.

Parameters
[in]p_dataPointer to the data structure with device key information.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_set_oob ( uint8_t *  p_oob,
uint8_t  len 
)

Provision Set Out of Band data.

Application should call this function to setup OOB data used during provisioning of the local device

Parameters
p_oobOut of band data
lenOut of band data length
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_provision_start ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_provision_start_data_t p_data 
)

Provision Start.

The application can call this function to start provisioning of the device over established provisioning link.

Parameters
p_eventPointer to the event structure which identified the remote provisioning server.
p_dataPointer to the data structure with parameters that the application selected for provisioning.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
void wiced_bt_mesh_proxy_client_init ( wiced_bt_mesh_proxy_client_callback_t p_callback,
wiced_bool_t  is_provisioned 
)

Proxy Client Model initialization.

The Provisioner Application should call this function during startup to register a callback which will be executed when a proxy status message is received.

Parameters
p_callbackThe application callback function that will be executed by the Mesh Model library when application action is required, or when a reply for the application request has been received.
is_provisionedis_provisioned If TRUE, the application is being restarted after being provisioned or after a power loss. If FALSE the model cleans up NVRAM on startup.
Returns
None
wiced_bool_t wiced_bt_mesh_proxy_client_message_handler ( wiced_bt_mesh_event_t p_event,
const uint8_t *  p_data,
uint16_t  data_len 
)

Proxy Client Message Handler.

Application Library typically calls this function when function to process a message received from the Proxy Server. The function parses the message and if appropriate calls the application back to perform functionality.

Parameters
p_eventMesh event with information about received message.
p_dataPointer to the data portion of the message
data_lenLength of the data in the message
Returns
WICED_TRUE if the message is for this company ID/Model combination, WICED_FALSE otherwise.
wiced_bool_t wiced_bt_mesh_proxy_filter_change_addr ( wiced_bt_mesh_event_t p_event,
wiced_bool_t  is_add,
wiced_bt_mesh_proxy_filter_change_addr_data_t *  p_addr 
)

Proxy Client Change Filter.

The function can be called by the application to add or delete addresses from the proxy filter list.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]is_addTrue: add address, False: delete address
[in]p_addrPointer to the data structure of filter addresses
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_proxy_set_filter_type ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_proxy_filter_set_type_data_t *  p_set 
)

Proxy Client Set Filter Type.

The application can call this function to change the proxy filter type and clear the proxy filter list.

Parameters
[in]p_eventMesh event with information about received message which contain the address of the peer device.
[in]p_setPointer to the data structure with the type of the filter to set.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_remote_provisioning_server_message_handler ( wiced_bt_mesh_event_t p_event,
uint8_t *  p_data,
uint16_t  data_len 
)

Remote Provisioning Server Model Message Handler.

Application Library typically calls this function to process a message received from the Remote Provisioning Client. The function parses the message and if appropriate calls the application back to perform functionality.

Parameters
[in]p_eventMesh event with information about received message.
[in]p_dataPointer to the data portion of the message
[in]data_lenLength of the data in the message
Returns
WICED_TRUE if the message is for this company ID/Model combination, WICED_FALSE otherwise.