Bluetooth Mesh Health Client Model#

Bluetooth Mesh Health Client Model.

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

Modules#

sl_btmesh_evt_health_client_server_status

sl_btmesh_evt_health_client_server_status_period

sl_btmesh_evt_health_client_server_status_attention

Functions#

sl_status_t
sl_btmesh_health_client_get(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint16_t vendor_id)
sl_status_t
sl_btmesh_health_client_clear(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint16_t vendor_id, uint8_t reliable)
sl_status_t
sl_btmesh_health_client_test(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t test_id, uint16_t vendor_id, uint8_t reliable)
sl_status_t
sl_btmesh_health_client_get_period(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index)
sl_status_t
sl_btmesh_health_client_set_period(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t period, uint8_t reliable)
sl_status_t
sl_btmesh_health_client_get_attention(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index)
sl_status_t
sl_btmesh_health_client_set_attention(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t attention_sec, uint8_t reliable)

Macros#

Function Documentation#

sl_btmesh_health_client_init#

sl_status_t sl_btmesh_health_client_init ()

Initialize health client.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


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

sl_btmesh_health_client_deinit#

sl_status_t sl_btmesh_health_client_deinit ()

Deinitialize health client.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


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

sl_btmesh_health_client_get#

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

Destination server model address. May be a unicast address or a group address.

[in]elem_index

Client model element index. Identifies the client model used for sending the request.

[in]appkey_index

The application key index to use in encrypting the request

[in]vendor_id

Bluetooth vendor ID used in the request

Get the registered fault status of a Health Server model or models in the network.

Besides the immediate result code, the response or responses (if the destination server address is a group address) from the network will generate sl_btmesh_evt_health_client_server_status.

Returns

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

Events


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

sl_btmesh_health_client_clear#

sl_status_t sl_btmesh_health_client_clear (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint16_t vendor_id, uint8_t reliable)
Parameters
[in]server_address

Destination server model address. May be a unicast address or a group address.

[in]elem_index

Client model element index. Identifies the client model used for sending the request.

[in]appkey_index

The application key index to use in encrypting the request

[in]vendor_id

Bluetooth vendor ID used in the request

[in]reliable

If non-zero, a reliable model message is used.

Clear the fault status of a Health Server model or models in the network.

Besides the immediate result code, the response or responses (if the destination server address is a group address) from the network will generate sl_btmesh_evt_health_client_server_status.

Returns

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

Events


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

sl_btmesh_health_client_test#

sl_status_t sl_btmesh_health_client_test (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t test_id, uint16_t vendor_id, uint8_t reliable)
Parameters
[in]server_address

Destination server model address. May be a unicast address or a group address.

[in]elem_index

Client model element index. Identifies the client model used for sending the request.

[in]appkey_index

The application key index to use in encrypting the request

[in]test_id

Test ID used in the request

[in]vendor_id

Bluetooth vendor ID used in the request

[in]reliable

If non-zero, a reliable model message is used.

Execute a self test on a server model or models in the network.

Returns

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

Events


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

sl_btmesh_health_client_get_period#

sl_status_t sl_btmesh_health_client_get_period (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index)
Parameters
[in]server_address

Destination server model address, which may be a unicast address or a group address

[in]elem_index

Client model element index. Identifies the client model used for sending the request.

[in]appkey_index

The application key index to use in encrypting the request

Get the health period log of a Health Server model or models in the network.

Except for the immediate result code, the response or responses (if the destination server address is a group address) from the network will generate sl_btmesh_evt_health_client_server_status_period.

Returns

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

Events


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

sl_btmesh_health_client_set_period#

sl_status_t sl_btmesh_health_client_set_period (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t period, uint8_t reliable)
Parameters
[in]server_address

Destination server model address. May be a unicast address or a group address.

[in]elem_index

Client model element index, which identifies the client model used for sending the request.

[in]appkey_index

The application key index to use in encrypting the request

[in]period

Health period divisor value. Valid range: 0 - 16.

[in]reliable

If non-zero, a reliable model message is used.

Set the health period divisor of a Health Server model or models in the network.

Except for the immediate result code, the response or responses (if the destination server address is a group address) from the network will generate sl_btmesh_evt_health_client_server_status_period.

Returns

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

Events


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

sl_btmesh_health_client_get_attention#

sl_status_t sl_btmesh_health_client_get_attention (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index)
Parameters
[in]server_address

Destination server model address. May be a unicast address or a group address.

[in]elem_index

Client model element index. Identifies the client model used for sending the request.

[in]appkey_index

The application key index to use in encrypting the request

Get the attention timer value of a Health Server model or models in the network.

Besides the immediate result code, the response or responses (if the destination server address is a group address) from the network will generate sl_btmesh_evt_health_client_server_status_attention.

Returns

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

Events


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

sl_btmesh_health_client_set_attention#

sl_status_t sl_btmesh_health_client_set_attention (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t attention_sec, uint8_t reliable)
Parameters
[in]server_address

Destination server model address. May be a unicast address or a group address.

[in]elem_index

Client model element index. Identifies the client model used for sending the request.

[in]appkey_index

The application key index to use in encrypting the request

[in]attention_sec

Attention timer period in seconds

[in]reliable

If non-zero, a reliable model message is used.

Set the attention timer value of a Health Server model or models in the network.

Except for the immediate result code, the response or responses (if the destination server address is a group address) from the network will generate sl_btmesh_evt_health_client_server_status_attention.

Returns

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

Events


Definition at line 4920 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_health_client_init_id#

#define sl_btmesh_cmd_health_client_init_id
Value:
0x071a0028

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

sl_btmesh_cmd_health_client_deinit_id#

#define sl_btmesh_cmd_health_client_deinit_id
Value:
0x081a0028

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

sl_btmesh_cmd_health_client_get_id#

#define sl_btmesh_cmd_health_client_get_id
Value:
0x001a0028

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

sl_btmesh_cmd_health_client_clear_id#

#define sl_btmesh_cmd_health_client_clear_id
Value:
0x011a0028

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

sl_btmesh_cmd_health_client_test_id#

#define sl_btmesh_cmd_health_client_test_id
Value:
0x021a0028

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

sl_btmesh_cmd_health_client_get_period_id#

#define sl_btmesh_cmd_health_client_get_period_id
Value:
0x031a0028

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

sl_btmesh_cmd_health_client_set_period_id#

#define sl_btmesh_cmd_health_client_set_period_id
Value:
0x041a0028

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

sl_btmesh_cmd_health_client_get_attention_id#

#define sl_btmesh_cmd_health_client_get_attention_id
Value:
0x051a0028

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

sl_btmesh_cmd_health_client_set_attention_id#

#define sl_btmesh_cmd_health_client_set_attention_id
Value:
0x061a0028

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

sl_btmesh_rsp_health_client_init_id#

#define sl_btmesh_rsp_health_client_init_id
Value:
0x071a0028

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

sl_btmesh_rsp_health_client_deinit_id#

#define sl_btmesh_rsp_health_client_deinit_id
Value:
0x081a0028

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

sl_btmesh_rsp_health_client_get_id#

#define sl_btmesh_rsp_health_client_get_id
Value:
0x001a0028

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

sl_btmesh_rsp_health_client_clear_id#

#define sl_btmesh_rsp_health_client_clear_id
Value:
0x011a0028

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

sl_btmesh_rsp_health_client_test_id#

#define sl_btmesh_rsp_health_client_test_id
Value:
0x021a0028

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

sl_btmesh_rsp_health_client_get_period_id#

#define sl_btmesh_rsp_health_client_get_period_id
Value:
0x031a0028

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

sl_btmesh_rsp_health_client_set_period_id#

#define sl_btmesh_rsp_health_client_set_period_id
Value:
0x041a0028

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

sl_btmesh_rsp_health_client_get_attention_id#

#define sl_btmesh_rsp_health_client_get_attention_id
Value:
0x051a0028

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

sl_btmesh_rsp_health_client_set_attention_id#

#define sl_btmesh_rsp_health_client_set_attention_id
Value:
0x061a0028

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