|
fsp_err_t | RM_MESH_LIGHT_LC_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_LC_CLT_Close (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_LC_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_LC_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_LC_CLT_ModeGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_ModeSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_ModeSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_OmGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_OmSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_OmSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_LightOnOffGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_LightOnOffSet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_LightOnOffSetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_PropertyGet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_PropertySet (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
fsp_err_t | RM_MESH_LIGHT_LC_CLT_PropertySetUnacknowledged (rm_ble_mesh_model_client_ctrl_t *const p_ctrl, void const *const p_parameter) |
|
Overview
Target Devices
The BLE Mesh Network Light Location Client module supports the following devices.
Configuration
Build Time Configurations for rm_mesh_light_lc_clt
The following build time configurations are defined in fsp_cfg/rm_mesh_light_lc_clt_cfg.h:
Configuration | Options | Default | Description |
Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Light Lightness Controller Client (rm_mesh_light_lc_clt)
This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Light Lightness Controller Client (rm_mesh_light_lc_clt).
Configuration | Options | Default | Description |
Interrupts |
Callback Provided when Timeout Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh light lightness controller client ISR occurs |
Name | Name Must Be a Valid C Symbol | g_rm_mesh_light_lc_clt0 | Module name. |
◆ rm_mesh_light_lc_clt_instance_ctrl_t
struct rm_mesh_light_lc_clt_instance_ctrl_t |
◆ RM_MESH_LIGHT_LC_CLT_Open()
Open Light_Lc Client middleware. This is to initialize Light_Lc 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_LC_CLT_Close()
Close Light_Lc 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_LC_CLT_GetModelHandle()
This is to get the handle of Light_Lc 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_LC_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_LC_CLT_ModeGet()
Light LC Mode Get is an acknowledged message used to get the Light LC Mode state of an element. The response to the Light LC Mode Get message is a Light LC Mode Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_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_LC_CLT_ModeSet()
The Light LC Mode Set is an acknowledged message used to set the Light LC Mode state of an element. The response to the Light LC Mode Set message is a Light LC Mode Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC Mode 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_LC_CLT_ModeSetUnacknowledged()
The Light LC Mode Set Unacknowledged is an unacknowledged message used to set the Light LC Mode state of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC Mode 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_LC_CLT_OmGet()
Light LC OM Get is an acknowledged message used to get the Light LC Occupancy Mode state of an element. The response to the Light LC OM Get message is a Light LC OM Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_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_LC_CLT_OmSet()
The Light LC OM Set is an acknowledged message used to set the Light LC Occupancy Mode state of an element. The response to the Light LC OM Set message is a Light LC OM Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC OM 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_LC_CLT_OmSetUnacknowledged()
The Light LC OM Set Unacknowledged is an unacknowledged message used to set the Light LC Occupancy Mode state of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC OM 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_LC_CLT_LightOnOffGet()
Light LC Light OnOff Get is an acknowledged message used to get the Light LC Light OnOff state of an element. The response to the Light LC Light OnOff Get message is a Light LC Light OnOff Status message. There are no parameters for this message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_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_LC_CLT_LightOnOffSet()
The Light LC Light OnOff Set is an acknowledged message used to set the Light LC Light OnOff state of an element. The response to the Light LC Light OnOff Set message is a Light LC Light OnOff Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC Light OnOff 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_LC_CLT_LightOnOffSetUnacknowledged()
The Light LC Light OnOff Set Unacknowledged is an unacknowledged message used to set the Light LC Light OnOff state of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC Light OnOff 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_LC_CLT_PropertyGet()
Light LC Property Get is an acknowledged message used to get the Light LC Property state of an element. The response to the Light LC Property Get message is a Light LC Property Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC Property Get 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_LC_CLT_PropertySet()
The Light LC Property Set is an acknowledged message used to set the Light LC Property state of an element. The response to the Light LC Property Set message is a Light LC Property Status message.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC Property 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_LC_CLT_PropertySetUnacknowledged()
The Light LC Property Set Unacknowledged is an unacknowledged message used to set the Light LC Property state of an element.
- Parameters
-
[in] | p_ctrl | rm_mesh_light_lc_clt control block. |
[in] | p_parameter | Pointer to Light LC Property 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. |