|
fsp_err_t | RM_MESH_HEALTH_CLIENT_Open (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, rm_ble_mesh_model_client_cfg_t const *const p_cfg) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_Close (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_GetModelHandle (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t *const p_model_handle) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_SendReliablePdu (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, uint32_t req_opcode, void const *const p_parameter, uint32_t rsp_opcode) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_FaultGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_FaultClearUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_FaultClear (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_FaultTest (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_FaultTestUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_PeriodGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_PeriodSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_PeriodSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_AttentionGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_AttentionSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_HEALTH_CLIENT_AttentionSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
Overview
Target Devices
The BLE Mesh Network Health Client module supports the following devices.
Configuration
Build Time Configurations for rm_mesh_health_clt
The following build time configurations are defined in fsp_cfg/rm_mesh_health_clt_cfg.h:
Configuration | Options | Default | Description |
Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Health Client (rm_mesh_health_clt)
This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Health Client (rm_mesh_health_clt).
Configuration | Options | Default | Description |
Interrupts |
Callback Provided when Timeout occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh health client ISR occurs |
Name | Name Must Be a Valid C Symbol | g_rm_mesh_health_clt0 | Module name. |
◆ rm_mesh_health_clt_instance_ctrl_t
struct rm_mesh_health_clt_instance_ctrl_t |
◆ RM_MESH_HEALTH_CLIENT_Open()
Open Health Client middleware. This is to initialize Health Client model and to register with Access layer.
Implements rm_ble_mesh_model_client_api_t::open.
Example:
- Return values
-
FSP_SUCCESS | Model opened successfully. |
FSP_ERR_ASSERTION | Pointer to control block or configuration structure is NULL. |
FSP_ERR_ALREADY_OPEN | Model is already open. |
FSP_ERR_NOT_FOUND | The number of models has exceeded the limit. |
FSP_ERR_ABORTED | Model initialization is failed. |
◆ RM_MESH_HEALTH_CLIENT_Close()
Close Health Client middleware.
Implements rm_ble_mesh_model_client_api_t::close.
Example:
- Return values
-
FSP_SUCCESS | Model successfully closed. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
◆ RM_MESH_HEALTH_CLIENT_GetModelHandle()
This is to get the handle of Health client model.
Implements rm_ble_mesh_model_client_api_t::getModelHandle.
Example:
- Return values
-
FSP_SUCCESS | Got model handle successfully. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_POINTER | The parameter p_model_handle is NULL. |
◆ RM_MESH_HEALTH_CLIENT_SendReliablePdu()
This is to set the handle of Health client model.
Implements rm_ble_mesh_model_client_api_t::sendReliablePdu.
Example:
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_FaultGet()
The Health Fault Get is an acknowledged message used to get the current Registered Fault state identified by Company ID of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_FaultClearUnacknowledged()
The Health Fault Clear Unacknowledged is an unacknowledged message used to clear the current Registered Fault state identified by Company ID of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_FaultClear()
The Health Fault Clear is an acknowledged message used to clear the current Registered Fault state identified by Company ID of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_FaultTest()
The Health Fault Test is an acknowledged message used to invoke a self-test procedure of an element. The procedure is implementation specific and may result in changing the Health Fault state of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_FaultTestUnacknowledged()
The Health Fault Test Unacknowledged is an unacknowledged message used to invoke a self-test procedure of an element. The procedure is implementation specific and may result in changing the Health Fault state of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_PeriodGet()
The Health Period Get is an acknowledged message used to get the current Health Period state of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_health_clt control block. |
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_PeriodSetUnacknowledged()
The Health Period Set Unacknowledged is an unacknowledged message used to set the current Health Period state of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_PeriodSet()
The Health Period Set is an acknowledged message used to set the current Health Period state of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_AttentionGet()
The Health Attention Get is an acknowledged message used to get the current Attention Timer state of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_health_clt control block. |
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_AttentionSet()
The Health Attention Set is an acknowledged message used to set the Attention Timer state of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
◆ RM_MESH_HEALTH_CLIENT_AttentionSetUnacknowledged()
The Health Attention Set Unacknowledged is an unacknowledged message used to set the Attention Timer state of an element.
- Parameters
-
- Return values
-
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |