RA Flexible Software Package Documentation
Release v5.2.0
|
|
Functions | |
fsp_err_t | RM_MESH_LIGHT_LIGHTNESS_SRV_Open (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_model_server_cfg_t const *const p_cfg) |
fsp_err_t | RM_MESH_LIGHT_LIGHTNESS_SRV_Close (rm_ble_mesh_model_server_ctrl_t *const p_ctrl) |
fsp_err_t | RM_MESH_LIGHT_LIGHTNESS_SRV_StateUpdate (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_access_server_state_t const *const p_state) |
fsp_err_t | RM_MESH_LIGHT_LIGHTNESS_SRV_SetupServerStateUpdate (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_access_server_state_t const *const p_state) |
The BLE Mesh Network Light Lightness Server module supports the following devices.
Configuration | Options | Default | Description |
---|
Configuration | Options | Default | Description |
---|---|---|---|
Interrupts | |||
Callback Provided when Timeout Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh light lightness server ISR occurs |
Callback Provided when an Timeout ISR Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh light lightness server timeout ISR occurs |
Name | Name Must Be a Valid C Symbol | g_rm_mesh_light_lightness_srv0 | Module name. |
Data Structures | |
struct | rm_mesh_light_lightness_srv_linear_info_t |
struct | rm_mesh_light_lightness_srv_actual_info_t |
struct | rm_mesh_light_lightness_srv_last_info_t |
struct | rm_mesh_light_lightness_srv_default_info_t |
struct | rm_mesh_light_lightness_srv_range_info_t |
struct | rm_mesh_light_lightness_srv_info_t |
struct | rm_mesh_light_lightness_srv_instance_ctrl_t |
struct rm_mesh_light_lightness_srv_linear_info_t |
Light Lightness Linear state represents the lightness of a light on a linear scale
struct rm_mesh_light_lightness_srv_actual_info_t |
Light Lightness Actual state represents the lightness of a light on a perceptually uniform lightness scale
struct rm_mesh_light_lightness_srv_last_info_t |
struct rm_mesh_light_lightness_srv_default_info_t |
struct rm_mesh_light_lightness_srv_range_info_t |
struct rm_mesh_light_lightness_srv_info_t |
Light Lightness state is a composite state that includes the Light Lightness Linear, the Light Lightness Actual, the Light Lightness Last, and the Light Lightness Default states
Data Fields | ||
---|---|---|
rm_mesh_light_lightness_srv_linear_info_t | light_lightness_linear |
Light Lightness Linear state represents the lightness of a light on a linear scale |
rm_mesh_light_lightness_srv_actual_info_t | light_lightness_actual |
Light Lightness Actual state represents the lightness of a light on a perceptually uniform lightness scale |
rm_mesh_light_lightness_srv_last_info_t | light_lightness_last |
Light Lightness Last state represents the lightness of a light on a perceptually uniform lightness scale |
rm_mesh_light_lightness_srv_default_info_t | light_lightness_default |
Light Lightness Default state is a value ranging from 0x0000 to 0xFFFF, representing a default lightness level for the Light Lightness Actual state |
rm_mesh_light_lightness_srv_range_info_t | light_lightness_range |
Light Lightness Range state. |
uint8_t | range_status |
Status field used only for the Range Status |
struct rm_mesh_light_lightness_srv_instance_ctrl_t |
BLE mesh light lightness instance control block. DO NOT INITIALIZE. Initialization occurs when RM_MESH_LIGHT_LIGHTNESS_SRV_Open() is called.
fsp_err_t RM_MESH_LIGHT_LIGHTNESS_SRV_Open | ( | rm_ble_mesh_model_server_ctrl_t *const | p_ctrl, |
rm_ble_mesh_model_server_cfg_t const *const | p_cfg | ||
) |
API to initialize Light_Lightness Server model and to initialize Light_Lightness_Setup Server model. This is to initialize Light_Lightness Server model and to register with Access layer. And this is to initialize Light_Lightness_Setup Server model and to register with Access layer. Implements rm_ble_mesh_model_server_api_t::open.
Example:
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. |
fsp_err_t RM_MESH_LIGHT_LIGHTNESS_SRV_Close | ( | rm_ble_mesh_model_server_ctrl_t *const | p_ctrl | ) |
API to terminate Light_Lightness Server model. This is to terminate Light_Lightness Server model and to register with Access layer.
Implements rm_ble_mesh_model_server_api_t::close.
Example:
FSP_SUCCESS | Model successfully closed. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
fsp_err_t RM_MESH_LIGHT_LIGHTNESS_SRV_StateUpdate | ( | rm_ble_mesh_model_server_ctrl_t *const | p_ctrl, |
rm_ble_mesh_access_server_state_t const *const | p_state | ||
) |
API to send reply or to update state change. This is to send reply for a request or to inform change in state.
Implements rm_ble_mesh_model_server_api_t::stateUpdate.
Example:
FSP_SUCCESS | Updated server status successfully. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_INVALID_POINTER | The parameter p_state is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
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. |
fsp_err_t RM_MESH_LIGHT_LIGHTNESS_SRV_SetupServerStateUpdate | ( | rm_ble_mesh_model_server_ctrl_t *const | p_ctrl, |
rm_ble_mesh_access_server_state_t const *const | p_state | ||
) |
API to send reply or to update state change. This is to send reply for a request or to inform change in state.
[in] | p_ctrl | rm_mesh_light_lightness_srv control block. |
[in] | p_state | To send reply for a request or to inform change in state. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_INVALID_POINTER | The parameter p_state is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
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. |