Bluetooth Mesh Scheduler Client Model#

Bluetooth Mesh Scheduler Client Model.

This class provides commands and messages to interface with the Scheduler Client model. Scheduler models uses multiple fields to define the occurrence of an event and the type of event to be triggered.

For the description of these fields, please see Scheduler Server

Modules#

sl_btmesh_evt_scheduler_client_status

sl_btmesh_evt_scheduler_client_action_status

Functions#

sl_status_t
sl_btmesh_scheduler_client_init(uint16_t elem_index)
sl_status_t
sl_btmesh_scheduler_client_deinit(uint16_t elem_index)
sl_status_t
sl_btmesh_scheduler_client_get(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index)
sl_status_t
sl_btmesh_scheduler_client_get_action(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t index)
sl_status_t
sl_btmesh_scheduler_client_set_action(uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t flags, uint8_t index, uint8_t year, uint16_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint8_t day_of_week, uint8_t action, uint32_t transition_time_ms, uint16_t scene_number)

Macros#

#define
sl_btmesh_cmd_scheduler_client_init_id 0x00540028
#define
sl_btmesh_cmd_scheduler_client_deinit_id 0x01540028
#define
sl_btmesh_cmd_scheduler_client_get_id 0x02540028
#define
sl_btmesh_cmd_scheduler_client_get_action_id 0x03540028
#define
sl_btmesh_cmd_scheduler_client_set_action_id 0x04540028
#define
sl_btmesh_rsp_scheduler_client_init_id 0x00540028
#define
sl_btmesh_rsp_scheduler_client_deinit_id 0x01540028
#define
sl_btmesh_rsp_scheduler_client_get_id 0x02540028
#define
sl_btmesh_rsp_scheduler_client_get_action_id 0x03540028
#define
sl_btmesh_rsp_scheduler_client_set_action_id 0x04540028

Function Documentation#

sl_btmesh_scheduler_client_init#

sl_status_t sl_btmesh_scheduler_client_init (uint16_t elem_index)
Parameters
[in]elem_index

Client model element index

Initializes the Scheduler Client model

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 15091 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_scheduler_client_deinit#

sl_status_t sl_btmesh_scheduler_client_deinit (uint16_t elem_index)
Parameters
[in]elem_index

Client model element index

Deinitialize the Scheduler Client model

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 15102 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_scheduler_client_get#

sl_status_t sl_btmesh_scheduler_client_get (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index)
Parameters
[in]server_address

Destination server model address

[in]elem_index

Client model element index

[in]appkey_index

The application key index to use.

Send a Scheduler Get message to get the Scheduler Register status of a Scheduler Server.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 15119 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_scheduler_client_get_action#

sl_status_t sl_btmesh_scheduler_client_get_action (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t index)
Parameters
[in]server_address

Destination server model address

[in]elem_index

Client model element index

[in]appkey_index

The application key index to use.

[in]index

Index of the Scheduler Register entry to get

Send a Scheduler Action Get message to get action defined by a Schedule Register state entry.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 15139 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_scheduler_client_set_action#

sl_status_t sl_btmesh_scheduler_client_set_action (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index, uint8_t flags, uint8_t index, uint8_t year, uint16_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second, uint8_t day_of_week, uint8_t action, uint32_t transition_time_ms, uint16_t scene_number)
Parameters
[in]server_address

Destination server model address

[in]elem_index

Client model element index

[in]appkey_index

The application key index to use.

[in]flags

Bit 1 (0x02) defines whether response is required, othewise the unacknowledged message is used.

[in]index

Index of the Scheduler Register entry to set

[in]year

Scheduled year for the action

[in]month

Scheduled month for the action

[in]day

Scheduled day of the month for the action

[in]hour

Scheduled hour for the action

[in]minute

Scheduled minute for the action

[in]second

Scheduled second for the action

[in]day_of_week

Scheduled days of the week for the action

[in]action

Action to be performed at the scheduled time

[in]transition_time_ms

Transition time for this action

[in]scene_number

Scene number to be used for some actions

Send a Scheduler Action Set message to set the given entry of the Scheduler Register state.

For the description of these fields, see Scheduler Server

Returns

  • SL_STATUS_OK if successful. Error code otherwise.

Events


Definition at line 15175 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h