Calendar Client#
API and Callbacks for the Calendar Cluster Client Component.
Silicon Labs implementation of the Calendar Cluster Client. This component is capable of receiving calendars published by a server but does not make requests on its own.
Modules#
sl_zigbee_af_calendar_season_t
sl_zigbee_af_calendar_week_profile_t
sl_zigbee_af_calendar_schedule_entry_t
sl_zigbee_af_calendar_day_profile_t
sl_zigbee_af_calendar_special_day_entry_t
sl_zigbee_af_calendar_special_day_profile_t
API#
Get the first calendar index based on the calendar type.
Get the calendar ID at the specified index.
Macros#
API Documentation#
sl_zigbee_af_calendar_client_get_calendar_index_by_type#
uint8_t sl_zigbee_af_calendar_client_get_calendar_index_by_type (uint8_t endpoint, uint8_t calendarType)
Get the first calendar index based on the calendar type.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | calendarType | The type of calendar that should be searched for in the table. |
Returns
The index of the first matching calendar, or SL_ZIGBEE_AF_PLUGIN_CALENDAR_CLIENT_CALENDARS if a match cannot be found.
sl_zigbee_af_calendar_client_get_calendar_id#
uint32_t sl_zigbee_af_calendar_client_get_calendar_id (uint8_t endpoint, uint8_t index)
Get the calendar ID at the specified index.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The relevant endpoint. |
| uint8_t | N/A | index | The index in the calendar table whose calendar ID should be returned. |
Returns
The calendar ID of the calendar at the specified index. If index is out of bounds, or if a match cannot be found, SL_ZIGBEE_AF_PLUGIN_CALENDAR_CLIENT_INVALID_CALENDAR_ID will be returned.