Bluetooth Mesh Private Beacon Client Model#

Bluetooth Mesh Private Beacon Client Model.

This class provides the commands and messages to interface with the Private Beacon Client Model.

Modules#

sl_btmesh_evt_private_beacon_client_beacon_status

sl_btmesh_evt_private_beacon_client_gatt_proxy_status

sl_btmesh_evt_private_beacon_client_identity_status

Functions#

sl_status_t
sl_btmesh_private_beacon_client_get_beacon(uint16_t enc_netkey_index, uint16_t server_address, uint32_t *handle)
sl_status_t
sl_btmesh_private_beacon_client_set_beacon(uint16_t enc_netkey_index, uint16_t server_address, uint8_t state, uint16_t random_update_steps, uint32_t *handle)
sl_status_t
sl_btmesh_private_beacon_client_get_gatt_proxy(uint16_t enc_netkey_index, uint16_t server_address, uint32_t *handle)
sl_status_t
sl_btmesh_private_beacon_client_set_gatt_proxy(uint16_t enc_netkey_index, uint16_t server_address, uint8_t state, uint32_t *handle)
sl_status_t
sl_btmesh_private_beacon_client_get_identity(uint16_t enc_netkey_index, uint16_t server_address, uint16_t netkey_index, uint32_t *handle)
sl_status_t
sl_btmesh_private_beacon_client_set_identity(uint16_t enc_netkey_index, uint16_t server_address, uint16_t netkey_index, uint8_t state, uint32_t *handle)

Macros#

#define
sl_btmesh_cmd_private_beacon_client_init_id 0x01640028
#define
sl_btmesh_cmd_private_beacon_client_deinit_id 0x02640028
#define
sl_btmesh_cmd_private_beacon_client_get_beacon_id 0x03640028
#define
sl_btmesh_cmd_private_beacon_client_set_beacon_id 0x04640028
#define
sl_btmesh_cmd_private_beacon_client_get_gatt_proxy_id 0x05640028
#define
sl_btmesh_cmd_private_beacon_client_set_gatt_proxy_id 0x06640028
#define
sl_btmesh_cmd_private_beacon_client_get_identity_id 0x07640028
#define
sl_btmesh_cmd_private_beacon_client_set_identity_id 0x08640028
#define
sl_btmesh_rsp_private_beacon_client_init_id 0x01640028
#define
sl_btmesh_rsp_private_beacon_client_deinit_id 0x02640028
#define
sl_btmesh_rsp_private_beacon_client_get_beacon_id 0x03640028
#define
sl_btmesh_rsp_private_beacon_client_set_beacon_id 0x04640028
#define
sl_btmesh_rsp_private_beacon_client_get_gatt_proxy_id 0x05640028
#define
sl_btmesh_rsp_private_beacon_client_set_gatt_proxy_id 0x06640028
#define
sl_btmesh_rsp_private_beacon_client_get_identity_id 0x07640028
#define
sl_btmesh_rsp_private_beacon_client_set_identity_id 0x08640028

Function Documentation#

sl_btmesh_private_beacon_client_init#

sl_status_t sl_btmesh_private_beacon_client_init ()

Initialize the private beacon client.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 21431 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_private_beacon_client_deinit#

sl_status_t sl_btmesh_private_beacon_client_deinit ()

Deinitialize the private beacon client.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 21441 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_private_beacon_client_get_beacon#

sl_status_t sl_btmesh_private_beacon_client_get_beacon (uint16_t enc_netkey_index, uint16_t server_address, uint32_t * handle)
Parameters
[in]enc_netkey_index

Network key used to encrypt the request on the network layer

[in]server_address

Destination node primary element address

[out]handle

Request handle.

Get the node's private network beacon state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 21458 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_private_beacon_client_set_beacon#

sl_status_t sl_btmesh_private_beacon_client_set_beacon (uint16_t enc_netkey_index, uint16_t server_address, uint8_t state, uint16_t random_update_steps, uint32_t * handle)
Parameters
[in]enc_netkey_index

Network key used to encrypt the request on the network layer

[in]server_address

Destination node primary element address

[in]state

Secure network beacon value to set. Valid values are:

  • 0: Node is not broadcasting private network beacons

  • 1: Node is broadcasting private network beacons

[in]random_update_steps

Number of beacons that are to be sent before changing the random of obfuscation. Valid step values are from 0x00 to 0xff. 0x00 means that the random is updated for every beacon send. and 0x01-0xff tells how often random is updated in multiples of 10 seconds. Update of random will also trigger update of random address used in sending. Value 0x100 is used to indicate that no change in this parameter is desired.

[out]handle

Request handle

Set node private network beacon state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 21487 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_private_beacon_client_get_gatt_proxy#

sl_status_t sl_btmesh_private_beacon_client_get_gatt_proxy (uint16_t enc_netkey_index, uint16_t server_address, uint32_t * handle)
Parameters
[in]enc_netkey_index

Network key used to encrypt the request on the network layer

[in]server_address

Destination node primary element address

[out]handle

Request handle.

Get the node's private gatt proxy beacon state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 21508 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_private_beacon_client_set_gatt_proxy#

sl_status_t sl_btmesh_private_beacon_client_set_gatt_proxy (uint16_t enc_netkey_index, uint16_t server_address, uint8_t state, uint32_t * handle)
Parameters
[in]enc_netkey_index

Network key used to encrypt the request on the network layer

[in]server_address

Destination node primary element address

[in]state

Secure network beacon value to set. Valid values are:

  • 0: Node is not broadcasting private gatt proxy beacons

  • 1: Node is broadcasting private gatt proxy beacons

[out]handle

Request handle

Set the node's private gatt proxy beacon state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 21530 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_private_beacon_client_get_identity#

sl_status_t sl_btmesh_private_beacon_client_get_identity (uint16_t enc_netkey_index, uint16_t server_address, uint16_t netkey_index, uint32_t * handle)
Parameters
[in]enc_netkey_index

Network key used to encrypt the request on the network layer

[in]server_address

Destination node primary element address

[in]netkey_index

Network key index for which the state is queried

[out]handle

Request handle.

Get the node's private identity beacon state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 21551 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_private_beacon_client_set_identity#

sl_status_t sl_btmesh_private_beacon_client_set_identity (uint16_t enc_netkey_index, uint16_t server_address, uint16_t netkey_index, uint8_t state, uint32_t * handle)
Parameters
[in]enc_netkey_index

Network key used to encrypt the request on the network layer

[in]server_address

Destination node primary element address

[in]netkey_index

Network key index for which the state is configured

[in]state

Node private beacon value to set. Valid values are:

  • 0: Node is not broadcasting private identity beacons

  • 1: Node is broadcasting private identity beacons

[out]handle

Request handle

Set the node's private node identity beacon state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 21575 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h