Overview
Target Devices
The BLE Mesh Network Scheduler Server module supports the following devices.
Configuration
Build Time Configurations for rm_mesh_scheduler_srv
The following build time configurations are defined in fsp_cfg/rm_mesh_scheduler_srv_cfg.h:
Configuration | Options | Default | Description |
Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Scheduler Server (rm_mesh_scheduler_srv)
This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Scheduler Server (rm_mesh_scheduler_srv).
Configuration | Options | Default | Description |
Interrupts |
Callback Provided when Timeout Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh scheduler server ISR occurs |
Callback Provided when an Timeout ISR Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh scheduler server timeout ISR occurs |
Name | Name Must Be a Valid C Symbol | g_rm_mesh_scheduler_srv0 | Module name. |
◆ rm_mesh_scheduler_srv_schedules_info_t
struct rm_mesh_scheduler_srv_schedules_info_t |
The current Schedule Register state of an element.
Data Fields |
uint16_t |
schedules |
Bit field indicating defined Actions in the Schedule Register
|
◆ rm_mesh_scheduler_srv_entry_index_info_t
struct rm_mesh_scheduler_srv_entry_index_info_t |
The entry index of the Schedule Register state
Data Fields |
uint8_t |
index |
Index of the Schedule Register entry
|
◆ rm_mesh_scheduler_srv_entry_info_t
struct rm_mesh_scheduler_srv_entry_info_t |
The entry of the Schedule Register state
Data Fields |
uint8_t |
index |
Index of the Schedule Register entry
|
uint8_t |
year |
Scheduled year for the action
|
uint16_t |
month |
Scheduled month for the action
|
uint8_t |
day |
Scheduled day of the month for the action
|
uint8_t |
hour |
Scheduled hour for the action
|
uint8_t |
minute |
Scheduled minute for the action
|
uint8_t |
second |
Scheduled second for the action
|
uint8_t |
dayofweek |
Schedule days of the week for the action
|
uint8_t |
action |
Action to be performed at the scheduled time
|
uint8_t |
transition_time |
Transition time for this action
|
uint16_t |
scene_number |
Scene number to be used for some actions
|
◆ rm_mesh_scheduler_srv_instance_ctrl_t
struct rm_mesh_scheduler_srv_instance_ctrl_t |
◆ RM_MESH_SCHEDULER_SRV_Open()
API to initialize Scheduler Server model. This is to initialize Scheduler Server model and to register with Access layer.
Implements rm_ble_mesh_model_server_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_SCHEDULER_SRV_Close()
API to terminate Scheduler Server model. This is to terminate Scheduler Server model and to register with Access layer.
Implements rm_ble_mesh_model_server_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_SCHEDULER_SRV_StateUpdate()
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:
- Return values
-
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. |