Bluetooth Mesh SAR Configuration Client Model#
Bluetooth Mesh SAR Configuration Client Model.
SAR Configuration Client model, used to configure the behavior of the lower transport layer of a node that that supports the SAR Configuration Server
Modules#
sl_btmesh_evt_sar_config_client_sar_transmitter_status
sl_btmesh_evt_sar_config_client_sar_receiver_status
Functions#
Macros#
Function Documentation#
sl_btmesh_sar_config_client_init#
sl_status_t sl_btmesh_sar_config_client_init ()
Initialize the SAR Configuration Client model
Returns
SL_STATUS_OK if successful. Error code otherwise.
20623
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_sar_config_client_deinit#
sl_status_t sl_btmesh_sar_config_client_deinit ()
Deinitialize the SAR Configuration Client model
Returns
SL_STATUS_OK if successful. Error code otherwise.
20633
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_sar_config_client_get_sar_transmitter#
sl_status_t sl_btmesh_sar_config_client_get_sar_transmitter (uint16_t enc_netkey_index, uint16_t server_address, uint32_t * handle)
[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 |
Query the SAR Transmitter state of a node
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
20650
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_sar_config_client_set_sar_transmitter#
sl_status_t sl_btmesh_sar_config_client_set_sar_transmitter (uint16_t enc_netkey_index, uint16_t server_address, uint8_t segment_interval_step, uint8_t unicast_retrans_count, uint8_t unicast_retrans_wo_progress_count, uint16_t unicast_retrans_interval_step, uint16_t unicast_retrans_interval_increment, uint8_t multicast_retrans_count, uint16_t multicast_retrans_interval_step, uint32_t * handle)
[in] | enc_netkey_index | Network key used to encrypt the request on the network layer |
[in] | server_address | Destination node primary element address |
[in] | segment_interval_step | SAR Segment Interval Step The Segment Interval Step controls the interval between transmissions of segments of a segmented message in milliseconds. The value is the range of 10ms to 160ms in 10ms steps, intermediate values are rounded down to the nearest multiple of 10. Default value is 20ms. |
[in] | unicast_retrans_count | SAR Unicast Retransmissions Count The SAR Unicast Retransmission Count controls the maximum number of transmissions of segments of segmented messages to a unicast destination. Valid range is 0 - 15, where 0 represents a single transmission. The default value is 7, resulting in 8 transmissions total. |
[in] | unicast_retrans_wo_progress_count | SAR Unicast Retransmissions Without Progress Count The SAR Unicase Retransmissions Without Progress Count controls the maximum number of retransmissions of segments of segmented messages to a unicast destination without progress (without marking newly marking any segments acknowledged). Valid range is 0 - 15, where 0 represents a single transmission. The default value is 2, resulting in 3 transmissions. The value of this state should be set to a value greater by two or more than the value of the SAR Acknowledgement Retransmissions Count on a peer node. This helps prevent the SAR transmitter from abandoning the SAR prematurely. |
[in] | unicast_retrans_interval_step | SAR Unicast Retransmissions Interval Step The SAR Unicast Retransmissions Interval Step state controls the minimum interval between retransmissions of segments of a segmented message for a destination that is a unicast address in 25ms steps. Valid range is 25 - 400ms, intermediate values are rounded down to the nearest multiple of 25. Default value is 200ms. |
[in] | unicast_retrans_interval_increment | SAR Unicast Retransmissions Interval Increment The SAR Unicast Retransmissions Interval Increment state controls the incremental component of the interval between retransmissions of segments of a segmented message for a destination that is a unicast address in 25ms steps. Valid range is 25 - 400ms, intermediate values are rounded down to the nearest multiple of 25. Default value is 50ms. |
[in] | multicast_retrans_count | SAR Multicast Retransmissions Count The SAR Multicast Retransmissions Count state controls the maximum number of transmissions of segments of segmented messages to a group address or a virtual address. Valid range is 0 - 15, where 0 represents a single transmission. The default value is 1, resulting in 2 transmissions. |
[in] | multicast_retrans_interval_step | SAR Multicast Retransmissions Interval The SAR Multicast Retransmissions Interval Step state controls the interval between retransmissions of segments of a segmented message for a destination that is a group address or a virtual address in 25ms steps. Valid range is 25-400ms, intermediate values are rounded down to the nearest multiple of 25. Default values is 100ms. |
[out] | handle | Request handle |
Set the SAR Tranmitter state of a node
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
20732
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_sar_config_client_get_sar_receiver#
sl_status_t sl_btmesh_sar_config_client_get_sar_receiver (uint16_t enc_netkey_index, uint16_t server_address, uint32_t * handle)
[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 |
Query the SAR Receiver state of a node
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
20758
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_sar_config_client_set_sar_receiver#
sl_status_t sl_btmesh_sar_config_client_set_sar_receiver (uint16_t enc_netkey_index, uint16_t server_address, uint8_t segments_threshold, uint8_t ack_delay_increment, uint32_t discard_timeout, uint8_t segment_interval_step, uint8_t ack_retrans_count, uint32_t * handle)
[in] | enc_netkey_index | Network key used to encrypt the request on the network layer |
[in] | server_address | Destination node primary element address |
[in] | segments_threshold | SAR Segments Threshold The SAR Segments Threshold state represents the size of a segmented message in number of segments above which the Segment Acknowledgment messages are enabled. Valid range is 0 - 31, the default value is 3. |
[in] | ack_delay_increment | SAR Acknowledgment Delay Increment The SAR Acknowledgment Delay Increment state control the interval between the reception of a new segment of a segmented message for a destination that is a unicast address and the transmission of the Segment Acknowledgment for that message. Valid range is 0 - 7, default is 2. |
[in] | discard_timeout | SAR Discard Timeout The SAR Discard Timeout state controls the time that the lower transport layer waits after receiving unique segments of a segmented message before discarding that segmented message in 5s steps. Valid range is 5000 - 80000ms, intermediate values are rounded down to the nearest multiple of 5s. The default value is 10000ms. |
[in] | segment_interval_step | SAR Discard Timeout The SAR Discard Timeout state controls the time that the lower transport layer waits after receiving unique segments of a segmented message before discarding that segmented message in 5s steps. Valid range is 5000 - 80000ms, intermediate values are rounded down to the nearest multiple of 5s. The default value is 10000ms. |
[in] | ack_retrans_count | SAR Acknowledgment Retransmissions Count The SAR Acknowledgment Retransmissions Count state controls the maximum number of retransmissions of Segment Acknowledgment messages sent by the lower transport layer. Valid range is 0 - 3. The default value is 2, representing 2 retransmissions or 3 in total. |
[out] | handle | Request handle |
Set the SAR Receiver state of a node
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
20818
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
Macro Definition Documentation#
sl_btmesh_cmd_sar_config_client_init_id#
#define sl_btmesh_cmd_sar_config_client_init_idValue:
0x01620028
20385
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_cmd_sar_config_client_deinit_id#
#define sl_btmesh_cmd_sar_config_client_deinit_idValue:
0x02620028
20386
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_cmd_sar_config_client_get_sar_transmitter_id#
#define sl_btmesh_cmd_sar_config_client_get_sar_transmitter_idValue:
0x03620028
20387
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_cmd_sar_config_client_set_sar_transmitter_id#
#define sl_btmesh_cmd_sar_config_client_set_sar_transmitter_idValue:
0x04620028
20388
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_cmd_sar_config_client_get_sar_receiver_id#
#define sl_btmesh_cmd_sar_config_client_get_sar_receiver_idValue:
0x05620028
20389
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_cmd_sar_config_client_set_sar_receiver_id#
#define sl_btmesh_cmd_sar_config_client_set_sar_receiver_idValue:
0x06620028
20390
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_rsp_sar_config_client_init_id#
#define sl_btmesh_rsp_sar_config_client_init_idValue:
0x01620028
20391
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_rsp_sar_config_client_deinit_id#
#define sl_btmesh_rsp_sar_config_client_deinit_idValue:
0x02620028
20392
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_rsp_sar_config_client_get_sar_transmitter_id#
#define sl_btmesh_rsp_sar_config_client_get_sar_transmitter_idValue:
0x03620028
20393
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_rsp_sar_config_client_set_sar_transmitter_id#
#define sl_btmesh_rsp_sar_config_client_set_sar_transmitter_idValue:
0x04620028
20394
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_rsp_sar_config_client_get_sar_receiver_id#
#define sl_btmesh_rsp_sar_config_client_get_sar_receiver_idValue:
0x05620028
20395
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h
sl_btmesh_rsp_sar_config_client_set_sar_receiver_id#
#define sl_btmesh_rsp_sar_config_client_set_sar_receiver_idValue:
0x06620028
20396
of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h