|
fsp_err_t | RM_MESH_GENERIC_LEVEL_CLT_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_GENERIC_LEVEL_CLT_Close (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_GENERIC_LEVEL_CLT_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_GENERIC_LEVEL_CLT_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_GENERIC_LEVEL_CLT_Get (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_GENERIC_LEVEL_CLT_Set (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_GENERIC_LEVEL_CLT_SetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_GENERIC_LEVEL_CLT_DeltaSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_GENERIC_LEVEL_CLT_DeltaSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_GENERIC_LEVEL_CLT_MoveSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_GENERIC_LEVEL_CLT_MoveSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
Overview
Target Devices
The BLE Mesh Network Generic Level Client module supports the following devices.
Configuration
Build Time Configurations for rm_mesh_generic_level_clt
The following build time configurations are defined in fsp_cfg/rm_mesh_generic_level_clt_cfg.h:
Configuration | Options | Default | Description |
Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Generic Level Client (rm_mesh_generic_level_clt)
This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Generic Level Client (rm_mesh_generic_level_clt).
Configuration | Options | Default | Description |
Interrupts |
Callback Provided When Timeout Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh generic level client ISR occurs |
Name | Name Must Be a Valid C Symbol | g_rm_mesh_generic_level_clt0 | Module name. |
◆ rm_mesh_generic_level_clt_instance_ctrl_t
struct rm_mesh_generic_level_clt_instance_ctrl_t |
◆ RM_MESH_GENERIC_LEVEL_CLT_Open()
Open Generic_Level Client middleware. This is to initialize Generic_Level 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_GENERIC_LEVEL_CLT_Close()
Close Generic_Level 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_GENERIC_LEVEL_CLT_GetModelHandle()
This is to get the handle of Generic_Level 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_GENERIC_LEVEL_CLT_SendReliablePdu()
This is to initialize sending acknowledged commands.
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_GENERIC_LEVEL_CLT_Get()
Generic Level Get is an acknowledged message used to get the Generic Level state of an element. The response to the Generic Level Get message is a Generic Level Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_generic_level_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_GENERIC_LEVEL_CLT_Set()
Generic Level Set is an acknowledged message used to set the Generic Level state of an element to a new absolute value. The response to the Generic Level Set message is a Generic Level Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_generic_level_clt control block. |
[in] | p_parameter | Pointer to Generic Level Set message. |
- 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_GENERIC_LEVEL_CLT_SetUnacknowledged()
Generic Level Set Unacknowledged is an unacknowledged message used to set the Generic Level state of an element to a new absolute value.
- Parameters
-
[in] | p_ctrl | rm_mesh_generic_level_clt control block. |
[in] | p_parameter | Pointer to Generic Level Set message. |
- 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_GENERIC_LEVEL_CLT_DeltaSet()
Generic Delta Set is an acknowledged message used to set the Generic Level state of an element by a relative value. The message is transactional, it supports changing the state by a cumulative value with a sequence of messages that are part of a transaction. The response to the Generic Delta Set message is a Generic Level Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_generic_level_clt control block. |
[in] | p_parameter | Pointer to Generic Level Set message. |
- 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_GENERIC_LEVEL_CLT_DeltaSetUnacknowledged()
Generic Delta Set Unacknowledged is an unacknowledged message used to set the Generic Level state of an element by a relative value.
- Parameters
-
[in] | p_ctrl | rm_mesh_generic_level_clt control block. |
[in] | p_parameter | Pointer to Generic Level Set message. |
- 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_GENERIC_LEVEL_CLT_MoveSet()
Generic Move Set is an acknowledged message used to start a process of changing the Generic Level state of an element with a defined transition speed. The response to the Generic Move Set message is a Generic Level Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_generic_level_clt control block. |
[in] | p_parameter | Pointer to Generic Level Set message. |
- 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_GENERIC_LEVEL_CLT_MoveSetUnacknowledged()
Generic Move Set Unacknowledged is an unacknowledged message used to start a process of changing the Generic Level state of an element with a defined transition speed.
- Parameters
-
[in] | p_ctrl | rm_mesh_generic_level_clt control block. |
[in] | p_parameter | Pointer to Generic Level Set message. |
- 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. |