|
fsp_err_t | RM_MESH_LIGHT_CTL_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_LIGHT_CTL_CLT_Close (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_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_LIGHT_CTL_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_LIGHT_CTL_CLT_Get (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_Set (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_SetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_TemperatureGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_TemperatureSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_TemperatureSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_DefaultGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_DefaultSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_DefaultSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_TemperatureRangeGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_TemperatureRangeSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_CTL_CLT_TemperatureRangeSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
Overview
Target Devices
The BLE Mesh Network Light Control Client module supports the following devices.
Configuration
Build Time Configurations for rm_mesh_light_ctl_clt
The following build time configurations are defined in fsp_cfg/rm_mesh_light_ctl_clt_cfg.h:
Configuration | Options | Default | Description |
Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Light Control Client (rm_mesh_light_ctl_clt)
This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Light Control Client (rm_mesh_light_ctl_clt).
Configuration | Options | Default | Description |
Interrupts |
Callback Provided when Timeout Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh light control client ISR occurs |
Name | Name Must Be a Valid C Symbol | g_rm_mesh_light_ctl_clt0 | Module name. |
◆ rm_mesh_light_ctl_clt_instance_ctrl_t
struct rm_mesh_light_ctl_clt_instance_ctrl_t |
◆ RM_MESH_LIGHT_CTL_CLT_Open()
Open Light_Ctl Client middleware. This is to initialize Light_Ctl 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_LIGHT_CTL_CLT_Close()
Close Light_Ctl 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_LIGHT_CTL_CLT_GetModelHandle()
This is to get the handle of Light_Ctl 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_LIGHT_CTL_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_LIGHT_CTL_CLT_Get()
Light CTL Get is an acknowledged message used to get the Light CTL state of an element. The response to the Light CTL Get message is a Light CTL Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_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_LIGHT_CTL_CLT_Set()
Light CTL Set is an acknowledged message used to set the Light CTL Lightness state, Light CTL Temperature state, and the Light CTL Delta UV state of an element. The response to the Light CTL Set message is a Light CTL Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_clt control block. |
[in] | p_parameter | Pointer to Light CTL 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_LIGHT_CTL_CLT_SetUnacknowledged()
Light CTL Set Unacknowledged is an unacknowledged message used to set the Light CTL Lightness state, Light CTL Temperature state, and the Light CTL Delta UV state of an element
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_clt control block. |
[in] | p_parameter | Pointer to Light CTL 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_LIGHT_CTL_CLT_TemperatureGet()
Light CTL Temperature Get is an acknowledged message used to get the Light CTL Temperature state of an element. The response to the Light CTL Temperature Get message is a Light CTL Temperature Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_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_LIGHT_CTL_CLT_TemperatureSet()
The Light CTL Temperature Set is an acknowledged message used to set the Light CTL Temperature state and the Light CTL Delta UV state of an element. The response to the Light CTL Temperature Set message is a Light CTL Temperature Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_clt control block. |
[in] | p_parameter | Pointer to Light CTL Temperature 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_LIGHT_CTL_CLT_TemperatureSetUnacknowledged()
The Light CTL Temperature Set Unacknowledged is an unacknowledged message used to set the Light CTL Temperature state and the Light CTL Delta UV state of an element
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_clt control block. |
[in] | p_parameter | Pointer to Light CTL Temperature 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_LIGHT_CTL_CLT_DefaultGet()
Light CTL Default Get is an acknowledged message used to get the Light CTL Temperature Default and Light CTL Delta UV Default states of an element. The response to the Light CTL Default Get message is a Light CTL Default Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_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_LIGHT_CTL_CLT_DefaultSet()
The Light CTL Default Set is an acknowledged message used to set the Light CTL Temperature Default state and the Light CTL Delta UV Default state of an element. The response to the Light CTL Set message is a Light CTL Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_clt control block. |
[in] | p_parameter | Pointer to Light CTL Default 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_LIGHT_CTL_CLT_DefaultSetUnacknowledged()
The Light CTL Default Set Unacknowledged is an unacknowledged message used to set the Light CTL Temperature Default state and the Light CTL Delta UV Default state of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_clt control block. |
[in] | p_parameter | Pointer to Light CTL Default 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_LIGHT_CTL_CLT_TemperatureRangeGet()
The Light CTL Temperature Range Get is an acknowledged message used to get the Light CTL Temperature Range state of an element. The response to the Light CTL Temperature Range Get message is a Light CTL Temperature Range Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_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_LIGHT_CTL_CLT_TemperatureRangeSet()
Light CTL Temperature Range Set Unacknowledged is an unacknowledged message used to set the Light CTL Temperature Range state of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_clt control block. |
[in] | p_parameter | Pointer to Light CTL Temperature Range 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_LIGHT_CTL_CLT_TemperatureRangeSetUnacknowledged()
Light CTL Temperature Range Set is an acknowledged message used to set the Light CTL Temperature Range state of an element. The response to the Light CTL Temperature Range Get message is a Light CTL Temperature Range Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_ctl_clt control block. |
[in] | p_parameter | Pointer to Light CTL Temperature Range 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. |