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#
EmberAfCalendarSpecialDayEntry
EmberAfCalendarSpecialDayProfile
API#
Get the first calendar index based on the calendar type.
Get the calendar ID at the specified index.
Macros#
API Documentation#
emberAfPluginCalendarClientGetCalendarIndexByType#
uint8_t emberAfPluginCalendarClientGetCalendarIndexByType (uint8_t endpoint, uint8_t calendarType)
Get the first calendar index based on the calendar type.
| N/A | endpoint | The relevant endpoint. |
| N/A | calendarType | The type of calendar that should be searched for in the table. |
Returns
The index of the first matching calendar, or EMBER_AF_PLUGIN_CALENDAR_CLIENT_CALENDARS if a match cannot be found.
127 of file app/framework/plugin/calendar-client/calendar-client.hemberAfPluginCalendarClientGetCalendarId#
uint32_t emberAfPluginCalendarClientGetCalendarId (uint8_t endpoint, uint8_t index)
Get the calendar ID at the specified index.
| N/A | endpoint | The relevant endpoint. |
| 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, EMBER_AF_PLUGIN_CALENDAR_CLIENT_INVALID_CALENDAR_ID will be returned.
139 of file app/framework/plugin/calendar-client/calendar-client.hMacro Definition Documentation#
EMBER_AF_PLUGIN_CALENDAR_CLIENT_INVALID_CALENDAR_ID#
#define EMBER_AF_PLUGIN_CALENDAR_CLIENT_INVALID_CALENDAR_IDValue:
0xFFFFFFFF
36 of file app/framework/plugin/calendar-client/calendar-client.hEMBER_AF_CALENDAR_MAXIMUM_CALENDAR_NAME_LENGTH#
#define EMBER_AF_CALENDAR_MAXIMUM_CALENDAR_NAME_LENGTHValue:
12
37 of file app/framework/plugin/calendar-client/calendar-client.h