|
fsp_err_t | RM_MESH_LIGHT_XYL_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_XYL_CLT_Close (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_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_XYL_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_XYL_CLT_Get (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_Set (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_SetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_TargetGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_DefaultGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_DefaultSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_DefaultSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_RangeGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_RangeSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_XYL_CLT_RangeSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
Overview
Target Devices
The BLE Mesh Network Light Xyl Client module supports the following devices.
Configuration
Build Time Configurations for rm_mesh_light_xyl_clt
The following build time configurations are defined in fsp_cfg/rm_mesh_light_xyl_clt_cfg.h:
Configuration | Options | Default | Description |
Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Light XYL Client (rm_mesh_light_xyl_clt)
This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Light XYL Client (rm_mesh_light_xyl_clt).
Configuration | Options | Default | Description |
Interrupts |
Callback Provided when Timeout Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh light XYL client ISR occurs |
Name | Name Must Be a Valid C Symbol | g_rm_mesh_light_xyl_clt0 | Module name. |
◆ rm_mesh_light_xyl_clt_instance_ctrl_t
struct rm_mesh_light_xyl_clt_instance_ctrl_t |
◆ RM_MESH_LIGHT_XYL_CLT_Open()
Open Light_Xyl Client middleware. This is to initialize Light_Xyl 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_XYL_CLT_Close()
Close Light_Xyl 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_XYL_CLT_GetModelHandle()
This is to get the handle of Light_Xyl 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_XYL_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_XYL_CLT_Get()
The Light xyL Get is an acknowledged message used to get the Light xyL Lightness, Light xyL x, and Light xyL y states of an element. Upon receiving a Light xyL Get message, the element shall respond with a Light xyL Status message. The response to the Light xyL Get message is a Light xyL Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_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_XYL_CLT_Set()
The Light xyL Set is an acknowledged message used to set the Light xyL Lightness, Light xyL x state, and the Light xyL y states of an element. The response to the Light xyL Set message is a Light xyL Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_clt control block. |
[in] | p_parameter | Pointer to Light xyL 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_XYL_CLT_SetUnacknowledged()
The Light xyL Set Unacknowledged is an unacknowledged message used to set the Light xyL Lightness, Light xyL x, and the Light xyL y states of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_clt control block. |
[in] | p_parameter | Pointer to Light xyL 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_XYL_CLT_TargetGet()
The Light xyL Target Get is an acknowledged message used to get the target Light xyL Lightness, Light xyL x, and Light xyL y states of an element. The response to the Light xyL Target Get message is a Light xyL Target Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_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_XYL_CLT_DefaultGet()
Light xyL Default Get is an acknowledged message used to get the Light Lightness Default, the Light xyL x Default, and Light xyL y Default states of an element. The response to the Light xyL Default Get message is a Light xyL Default Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_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_XYL_CLT_DefaultSet()
Light xyL Default Set is an acknowledged message used to set the Light Lightness Default, the Light xyL x Default, and Light xyL y Default states of an element. The response to the Light xyL Default Set message is a Light xyL Default Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_clt control block. |
[in] | p_parameter | Pointer to Light HSL 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_XYL_CLT_DefaultSetUnacknowledged()
Light xyL Default Set Unacknowledged is an unacknowledged message used to set the Light Lightness Default, the Light xyL x Default, and Light xyL y Default states of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_clt control block. |
[in] | p_parameter | Pointer to Light HSL 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_XYL_CLT_RangeGet()
The Light xyL Range Get is an acknowledged message used to get the Light xyL x Range and Light xyL y Range states of an element. The response to the Light xyL Range Get message is a Light xyL Range Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_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_XYL_CLT_RangeSet()
Light xyL Range Set is an acknowledged message used to set the Light xyL x Range and Light xyL y Range states of an element. The response to the Light xyL Range Set message is a Light xyL Range Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_clt control block. |
[in] | p_parameter | Pointer to Light xyL 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_XYL_CLT_RangeSetUnacknowledged()
Light xyL Range Set Unacknowledged is an unacknowledged message used to set the Light xyL x Range and Light xyL y Range states of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_xyl_clt control block. |
[in] | p_parameter | Pointer to Light xyL 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. |