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

sl_zigbee_af_calendar_t

API#

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.

uint32_t
sl_zigbee_af_calendar_client_get_calendar_id(uint8_t endpoint, uint8_t index)

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.

Parameters
N/Aendpoint

The relevant endpoint.

N/AcalendarType

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.


Definition at line 127 of file app/framework/plugin/calendar-client/calendar-client.h

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.

Parameters
N/Aendpoint

The relevant endpoint.

N/Aindex

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.


Definition at line 139 of file app/framework/plugin/calendar-client/calendar-client.h

Macro Definition Documentation#

SL_ZIGBEE_AF_PLUGIN_CALENDAR_CLIENT_INVALID_CALENDAR_ID#

#define SL_ZIGBEE_AF_PLUGIN_CALENDAR_CLIENT_INVALID_CALENDAR_ID
Value:
0xFFFFFFFF

Definition at line 36 of file app/framework/plugin/calendar-client/calendar-client.h

SL_ZIGBEE_AF_CALENDAR_MAXIMUM_CALENDAR_NAME_LENGTH#

#define SL_ZIGBEE_AF_CALENDAR_MAXIMUM_CALENDAR_NAME_LENGTH
Value:
12

Definition at line 37 of file app/framework/plugin/calendar-client/calendar-client.h