Bluetooth Mesh Silabs Configuration Client Vendor Model#

Bluetooth Mesh Silabs Configuration Client Vendor Model.

Silicon Labs Configuration Client vendor model. It is used to configure global and per-model specific settings of nodes such as Tx-PHY for long packets, usage of advertising extensions (AE) on per-model basis.

Modules#

sl_btmesh_evt_silabs_config_client_tx_status

sl_btmesh_evt_silabs_config_client_model_status

sl_btmesh_evt_silabs_config_client_network_pdu_status

Enumerations#

enum
sl_btmesh_silabs_config_client_status_t {
sl_btmesh_silabs_config_client_status_success = 0x0
sl_btmesh_silabs_config_client_status_unknown_cmd = 0x1
sl_btmesh_silabs_config_client_status_invalid_parameter = 0x2
sl_btmesh_silabs_config_client_status_does_not_exist = 0x3
}

The Silabs Configuration Client Status codes.

Functions#

sl_status_t
sl_btmesh_silabs_config_client_set_tx(uint16_t server_address, uint16_t appkey_index, uint8_t tx_phy, uint32_t tx_options_bitmap)
sl_status_t
sl_btmesh_silabs_config_client_get_tx(uint16_t server_address, uint16_t appkey_index)
sl_status_t
sl_btmesh_silabs_config_client_set_model_enable(uint16_t server_address, uint16_t appkey_index, uint16_t elem_index, uint16_t vendor_id, uint16_t model_id, uint8_t enable)
sl_status_t
sl_btmesh_silabs_config_client_get_model_enable(uint16_t server_address, uint16_t appkey_index, uint16_t elem_index, uint16_t vendor_id, uint16_t model_id)
sl_status_t
sl_btmesh_silabs_config_client_set_network_pdu(uint16_t server_address, uint16_t appkey_index, uint16_t pdu_max_size)
sl_status_t
sl_btmesh_silabs_config_client_get_network_pdu(uint16_t server_address, uint16_t appkey_index)

Macros#

Enumeration Documentation#

sl_btmesh_silabs_config_client_status_t#

sl_btmesh_silabs_config_client_status_t

The Silabs Configuration Client Status codes.

Enumerator
sl_btmesh_silabs_config_client_status_success

(0x0) The Client message was successfully processed by the Server.

sl_btmesh_silabs_config_client_status_unknown_cmd

(0x1) The command was not understood by the Server.

sl_btmesh_silabs_config_client_status_invalid_parameter

(0x2) A parameter in the Client message is outside of its valid range.

sl_btmesh_silabs_config_client_status_does_not_exist

(0x3) Resource specifed by the Client message does not exist.


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

Function Documentation#

sl_btmesh_silabs_config_client_init#

sl_status_t sl_btmesh_silabs_config_client_init ()

Initialize Silabs Configuration client model.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


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

sl_btmesh_silabs_config_client_set_tx#

sl_status_t sl_btmesh_silabs_config_client_set_tx (uint16_t server_address, uint16_t appkey_index, uint8_t tx_phy, uint32_t tx_options_bitmap)
Parameters
[in]server_address

Destination address of the message. It can be a unicast address, a group address, or a virtual address.

[in]appkey_index

The application key index used

[in]tx_phy

TX PHY for long packets (packets that would be segmented).

  • 1: LE 1M PHY

  • 2: LE 2M PHY

[in]tx_options_bitmap

TX options. NOTE: Currently not used: reserved for future use, set as 0.

Set node specific TX configuration.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


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

sl_btmesh_silabs_config_client_get_tx#

sl_status_t sl_btmesh_silabs_config_client_get_tx (uint16_t server_address, uint16_t appkey_index)
Parameters
[in]server_address

Destination address of the message. It can be a unicast address, a group address, or a virtual address.

[in]appkey_index

The application key index used

Get node specific TX configuration.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


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

sl_btmesh_silabs_config_client_set_model_enable#

sl_status_t sl_btmesh_silabs_config_client_set_model_enable (uint16_t server_address, uint16_t appkey_index, uint16_t elem_index, uint16_t vendor_id, uint16_t model_id, uint8_t enable)
Parameters
[in]server_address

Destination address of the message. It can be a unicast address, a group address, or a virtual address.

[in]appkey_index

The application key index used

[in]elem_index

The index of the server target element, 0 is the primary element.

[in]vendor_id

Vendor ID of the model to configure.

[in]model_id

Model ID of the server target.

[in]enable

Non zero - enable, otherwise disable

Set TX over AE on per-model basis enable/disable state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


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

sl_btmesh_silabs_config_client_get_model_enable#

sl_status_t sl_btmesh_silabs_config_client_get_model_enable (uint16_t server_address, uint16_t appkey_index, uint16_t elem_index, uint16_t vendor_id, uint16_t model_id)
Parameters
[in]server_address

Destination address of the message. It can be a unicast address, a group address, or a virtual address.

[in]appkey_index

The application key index used

[in]elem_index

The index of the server target element, 0 is the primary element.

[in]vendor_id

Vendor ID of the model to configure.

[in]model_id

Model ID of the server target.

Get TX over AE on per-model basis enable/disable state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


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

sl_btmesh_silabs_config_client_set_network_pdu#

sl_status_t sl_btmesh_silabs_config_client_set_network_pdu (uint16_t server_address, uint16_t appkey_index, uint16_t pdu_max_size)
Parameters
[in]server_address

Destination address of the message. It can be a unicast address, a group address, or a virtual address.

[in]appkey_index

The application key index used

[in]pdu_max_size

Network PDU max size. Valid range: 29 - 398.

Set network PDU state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


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

sl_btmesh_silabs_config_client_get_network_pdu#

sl_status_t sl_btmesh_silabs_config_client_get_network_pdu (uint16_t server_address, uint16_t appkey_index)
Parameters
[in]server_address

Destination address of the message. It can be a unicast address, a group address, or a virtual address.

[in]appkey_index

The application key index used

Get network PDU state.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


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

sl_btmesh_silabs_config_client_deinit#

sl_status_t sl_btmesh_silabs_config_client_deinit ()

Deinitialize Silabs Configuration Client model. After this call, the model cannot be used until it is initialized again. See sl_btmesh_silabs_config_client_init.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


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

Macro Definition Documentation#

sl_btmesh_cmd_silabs_config_client_init_id#

#define sl_btmesh_cmd_silabs_config_client_init_id
Value:
0x00010028

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

sl_btmesh_cmd_silabs_config_client_set_tx_id#

#define sl_btmesh_cmd_silabs_config_client_set_tx_id
Value:
0x01010028

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

sl_btmesh_cmd_silabs_config_client_get_tx_id#

#define sl_btmesh_cmd_silabs_config_client_get_tx_id
Value:
0x02010028

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

sl_btmesh_cmd_silabs_config_client_set_model_enable_id#

#define sl_btmesh_cmd_silabs_config_client_set_model_enable_id
Value:
0x03010028

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

sl_btmesh_cmd_silabs_config_client_get_model_enable_id#

#define sl_btmesh_cmd_silabs_config_client_get_model_enable_id
Value:
0x04010028

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

sl_btmesh_cmd_silabs_config_client_set_network_pdu_id#

#define sl_btmesh_cmd_silabs_config_client_set_network_pdu_id
Value:
0x05010028

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

sl_btmesh_cmd_silabs_config_client_get_network_pdu_id#

#define sl_btmesh_cmd_silabs_config_client_get_network_pdu_id
Value:
0x06010028

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

sl_btmesh_cmd_silabs_config_client_deinit_id#

#define sl_btmesh_cmd_silabs_config_client_deinit_id
Value:
0x07010028

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

sl_btmesh_rsp_silabs_config_client_init_id#

#define sl_btmesh_rsp_silabs_config_client_init_id
Value:
0x00010028

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

sl_btmesh_rsp_silabs_config_client_set_tx_id#

#define sl_btmesh_rsp_silabs_config_client_set_tx_id
Value:
0x01010028

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

sl_btmesh_rsp_silabs_config_client_get_tx_id#

#define sl_btmesh_rsp_silabs_config_client_get_tx_id
Value:
0x02010028

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

sl_btmesh_rsp_silabs_config_client_set_model_enable_id#

#define sl_btmesh_rsp_silabs_config_client_set_model_enable_id
Value:
0x03010028

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

sl_btmesh_rsp_silabs_config_client_get_model_enable_id#

#define sl_btmesh_rsp_silabs_config_client_get_model_enable_id
Value:
0x04010028

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

sl_btmesh_rsp_silabs_config_client_set_network_pdu_id#

#define sl_btmesh_rsp_silabs_config_client_set_network_pdu_id
Value:
0x05010028

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

sl_btmesh_rsp_silabs_config_client_get_network_pdu_id#

#define sl_btmesh_rsp_silabs_config_client_get_network_pdu_id
Value:
0x06010028

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

sl_btmesh_rsp_silabs_config_client_deinit_id#

#define sl_btmesh_rsp_silabs_config_client_deinit_id
Value:
0x07010028

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