Modules#

EmberAfCalendarSeason

EmberAfCalendarWeekProfile

EmberAfCalendarScheduleEntry

EmberAfCalendarDayProfile

EmberAfCalendarSpecialDayEntry

EmberAfCalendarSpecialDayProfile

EmberAfCalendar

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.

API#

uint8_t
emberAfPluginCalendarClientGetCalendarIndexByType(uint8_t endpoint, uint8_t calendarType)

Get the first calendar index based on the calendar type.

uint32_t
emberAfPluginCalendarClientGetCalendarId(uint8_t endpoint, uint8_t index)

Get the calendar ID at the specified index.

Macros#

#define
EMBER_AF_PLUGIN_CALENDAR_CLIENT_INVALID_CALENDAR_ID 0xFFFFFFFF
#define
EMBER_AF_CALENDAR_MAXIMUM_CALENDAR_NAME_LENGTH 12

API Documentation#

emberAfPluginCalendarClientGetCalendarIndexByType#

uint8_t emberAfPluginCalendarClientGetCalendarIndexByType (uint8_t endpoint, uint8_t calendarType)

Get the first calendar index based on the calendar type.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

The relevant endpoint.

uint8_tN/AcalendarType

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.


emberAfPluginCalendarClientGetCalendarId#

uint32_t emberAfPluginCalendarClientGetCalendarId (uint8_t endpoint, uint8_t index)

Get the calendar ID at the specified index.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aendpoint

The relevant endpoint.

uint8_tN/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, EMBER_AF_PLUGIN_CALENDAR_CLIENT_INVALID_CALENDAR_ID will be returned.