Bluetooth Mesh Health Server Model#

Bluetooth Mesh Health Server Model.

This class provides the commands and messages to interface with the Health Server model

Modules#

sl_btmesh_evt_health_server_attention

sl_btmesh_evt_health_server_test_request

Functions#

sl_status_t
sl_btmesh_health_server_set_fault(uint16_t elem_index, uint8_t id)
sl_status_t
sl_btmesh_health_server_clear_fault(uint16_t elem_index, uint8_t id)
sl_status_t
sl_btmesh_health_server_send_test_response(uint16_t client_address, uint16_t elem_index, uint16_t appkey_index, uint16_t vendor_id)

Function Documentation#

sl_btmesh_health_server_set_fault#

sl_status_t sl_btmesh_health_server_set_fault (uint16_t elem_index, uint8_t id)
Parameters
[in]elem_index

Index of the element on which the fault is occurring

[in]id

Fault ID. See the Mesh Profile specification for IDs defined by the Bluetooth SIG.

Set the fault condition on an element.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


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

sl_btmesh_health_server_clear_fault#

sl_status_t sl_btmesh_health_server_clear_fault (uint16_t elem_index, uint8_t id)
Parameters
[in]elem_index

Index of the element on which the fault is no longer occurring.

[in]id

Fault ID. See the Mesh Profile specification for IDs defined by the Bluetooth SIG.

Clear the fault condition on an element.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


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

sl_btmesh_health_server_send_test_response#

sl_status_t sl_btmesh_health_server_send_test_response (uint16_t client_address, uint16_t elem_index, uint16_t appkey_index, uint16_t vendor_id)
Parameters
[in]client_address

Address of the client model which sent the message

[in]elem_index

Server model element index. Identifies the Server model that received the request as well as the element on which the test is to be performed.

[in]appkey_index

The application key index to use in encrypting the request.

[in]vendor_id

Bluetooth vendor ID used in the request

Indicate to the stack that a test request has been completed and that the status may be communicated to the Health Client, which made the test request.

Returns

  • If an error occurs locally (for instance, because of invalid parameters), an errorcode parameter is returned immediately.


Definition at line 4983 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_health_server_set_fault_id#

#define sl_btmesh_cmd_health_server_set_fault_id
Value:
0x001b0028

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

sl_btmesh_cmd_health_server_clear_fault_id#

#define sl_btmesh_cmd_health_server_clear_fault_id
Value:
0x011b0028

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

sl_btmesh_cmd_health_server_send_test_response_id#

#define sl_btmesh_cmd_health_server_send_test_response_id
Value:
0x021b0028

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

sl_btmesh_rsp_health_server_set_fault_id#

#define sl_btmesh_rsp_health_server_set_fault_id
Value:
0x001b0028

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

sl_btmesh_rsp_health_server_clear_fault_id#

#define sl_btmesh_rsp_health_server_clear_fault_id
Value:
0x011b0028

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

sl_btmesh_rsp_health_server_send_test_response_id#

#define sl_btmesh_rsp_health_server_send_test_response_id
Value:
0x021b0028

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