Calendar Common#

API and Callbacks for the Calendar Common Component.

This component provides common utility functions that are used by the client and server of the Calendar Cluster.

Modules#

EmberAfCalendarDayScheduleEntryStruct

EmberAfCalendarDayStruct

EmberAfCalendarSpecialDayStruct

EmberAfCalendarWeekStruct

EmberAfCalendarSeasonStruct

EmberAfCalendarStruct

API#

uint8_t

emberAfPluginCalendarCommonGetCalendarById(uint32_t calendarId, uint32_t providerId)

Get the calendar by calendar ID.

uint32_t

emberAfPluginCalendarCommonEndTimeUtc(const EmberAfCalendarStruct *calendar)

Get the calendar end time (UTC).

bool

emberAfCalendarCommonSetCalInfo(uint8_t index, uint32_t providerId, uint32_t issuerEventId, uint32_t issuerCalendarId, uint32_t startTimeUtc, uint8_t calendarType, uint8_t *calendarName, uint8_t numberOfSeasons, uint8_t numberOfWeekProfiles, uint8_t numberOfDayProfiles)

Set the calendar info.

bool

emberAfCalendarCommonAddCalInfo(uint32_t providerId, uint32_t issuerEventId, uint32_t issuerCalendarId, uint32_t startTimeUtc, uint8_t calendarType, uint8_t *calendarName, uint8_t numberOfSeasons, uint8_t numberOfWeekProfiles, uint8_t numberOfDayProfiles)

Add a new entry corresponding to the PublishCalendar command. Tries to handle the new entry in the following method: 1) Try to apply new data to a matching existing entry. 2) Fields such as providerId, issuerEventId, and startTime, will be used. 3) Overwrite the oldest entry (one with smallest event ID) with new information.

bool

emberAfCalendarServerSetSeasonsInfo(uint8_t index, uint8_t seasonId, EmberAfDate startDate, uint8_t weekIndex)

Set calendar server season info.

bool

emberAfCalendarServerAddSeasonsInfo(uint32_t issuerCalendarId, uint8_t *seasonsEntries, uint8_t seasonsEntriesLength, uint8_t *unknownWeekIdSeasonsMask)

Add calendar server season info.

bool

emberAfCalendarCommonSetDayProfInfo(uint8_t index, uint8_t dayId, uint8_t entryId, uint16_t minutesFromMidnight, uint8_t data)

Set day profile info.

bool

emberAfCalendarCommonAddDayProfInfo(uint32_t issuerCalendarId, uint8_t dayId, uint8_t *dayScheduleEntries, uint16_t dayScheduleEntriesLength)

Add day profile info.

bool

emberAfCalendarServerSetWeekProfInfo(uint8_t index, uint8_t weekId, uint8_t dayIdRefMon, uint8_t dayIdRefTue, uint8_t dayIdRefWed, uint8_t dayIdRefThu, uint8_t dayIdRefFri, uint8_t dayIdRefSat, uint8_t dayIdRefSun)

Set calendar server week profile info.

bool

emberAfCalendarServerAddWeekProfInfo(uint32_t issuerCalendarId, uint8_t weekId, uint8_t dayIdRefMon, uint8_t dayIdRefTue, uint8_t dayIdRefWed, uint8_t dayIdRefThu, uint8_t dayIdRefFri, uint8_t dayIdRefSat, uint8_t dayIdRefSun)

Add calendar server week profile.

bool

emberAfCalendarCommonAddSpecialDaysInfo(uint32_t issuerCalendarId, uint8_t totalNumberOfSpecialDays, uint8_t *specialDaysEntries, uint16_t specialDaysEntriesLength, uint8_t *unknownSpecialDaysMask)

Updating special days information of the specified calendar. Assumes that the value of totalNumberOfSpecialDays will match up with the information passed in between specialDaysEntries and specialDaysEntriesLength.

Enumerations#

enum

EmberAfPluginCalendarCommonFlags {

EMBER_AF_PLUGIN_CALENDAR_COMMON_FLAGS_SENT = 0x01

}

Variables#

EmberAfCalendarStruct

calendars

Macros#

#define

fieldLength (field)

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_SCHEDULE_ENTRY 0xFFFF

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_ID 0xFF

#define

EMBER_AF_PLUGIN_CALENDAR_MAX_CALENDAR_NAME_LENGTH 12

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_INDEX 0xFF

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_MONDAY_INDEX (0)

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_SUNDAY_INDEX (6)

#define

EMBER_AF_DAYS_IN_THE_WEEK (7)

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_CALENDAR_ID 0xFFFFFFFF

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_CALENDAR_ID 0x00000000

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_PROVIDER_ID 0xFFFFFFFF

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_ISSUER_ID 0xFFFFFFFF

#define

EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_CALENDAR_TYPE 0xFF

API Documentation#

emberAfPluginCalendarCommonGetCalendarById#

uint8_t emberAfPluginCalendarCommonGetCalendarById (uint32_t calendarId, uint32_t providerId)

Get the calendar by calendar ID.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	calendarId	Ver.: always
uint32_t	N/A	providerId	Ver.: always

Returns

uint8_t Calender index

emberAfPluginCalendarCommonEndTimeUtc#

uint32_t emberAfPluginCalendarCommonEndTimeUtc (const EmberAfCalendarStruct * calendar)

Get the calendar end time (UTC).

Parameters

Type	Direction	Argument Name	Description
const EmberAfCalendarStruct *	N/A	calendar	pointer to the calendar struct Ver.: always

Returns

uint32_t end UTC time in seconds

emberAfCalendarCommonSetCalInfo#

bool emberAfCalendarCommonSetCalInfo (uint8_t index, uint32_t providerId, uint32_t issuerEventId, uint32_t issuerCalendarId, uint32_t startTimeUtc, uint8_t calendarType, uint8_t * calendarName, uint8_t numberOfSeasons, uint8_t numberOfWeekProfiles, uint8_t numberOfDayProfiles)

Set the calendar info.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	index	Ver.: always
uint32_t	N/A	providerId	Ver.: always
uint32_t	N/A	issuerEventId	Ver.: always
uint32_t	N/A	issuerCalendarId	Ver.: always
uint32_t	N/A	startTimeUtc	Ver.: always
uint8_t	N/A	calendarType	Ver.: always
uint8_t *	N/A	calendarName	Ver.: always
uint8_t	N/A	numberOfSeasons	Ver.: always
uint8_t	N/A	numberOfWeekProfiles	Ver.: always
uint8_t	N/A	numberOfDayProfiles	Ver.: always

Returns

bool true if success

emberAfCalendarCommonAddCalInfo#

bool emberAfCalendarCommonAddCalInfo (uint32_t providerId, uint32_t issuerEventId, uint32_t issuerCalendarId, uint32_t startTimeUtc, uint8_t calendarType, uint8_t * calendarName, uint8_t numberOfSeasons, uint8_t numberOfWeekProfiles, uint8_t numberOfDayProfiles)

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	providerId	Ver.: always
uint32_t	N/A	issuerEventId	Ver.: always
uint32_t	N/A	issuerCalendarId	Ver.: always
uint32_t	N/A	startTimeUtc	Ver.: always
uint8_t	N/A	calendarType	Ver.: always
uint8_t *	N/A	calendarName	Ver.: always
uint8_t	N/A	numberOfSeasons	Ver.: always
uint8_t	N/A	numberOfWeekProfiles	Ver.: always
uint8_t	N/A	numberOfDayProfiles	Ver.: always

Returns

bool true if success

emberAfCalendarServerSetSeasonsInfo#

bool emberAfCalendarServerSetSeasonsInfo (uint8_t index, uint8_t seasonId, EmberAfDate startDate, uint8_t weekIndex)

Set calendar server season info.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	index	Ver.: always
uint8_t	N/A	seasonId	Ver.: always
EmberAfDate	N/A	startDate	Ver.: always
uint8_t	N/A	weekIndex	Ver.: always

Returns

bool true if success

emberAfCalendarServerAddSeasonsInfo#

bool emberAfCalendarServerAddSeasonsInfo (uint32_t issuerCalendarId, uint8_t * seasonsEntries, uint8_t seasonsEntriesLength, uint8_t * unknownWeekIdSeasonsMask)

Add calendar server season info.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	issuerCalendarId	Ver.: always
uint8_t *	N/A	seasonsEntries	Ver.: always
uint8_t	N/A	seasonsEntriesLength	Ver.: always
uint8_t *	N/A	unknownWeekIdSeasonsMask	Ver.: always

Returns

bool true if success

emberAfCalendarCommonSetDayProfInfo#

bool emberAfCalendarCommonSetDayProfInfo (uint8_t index, uint8_t dayId, uint8_t entryId, uint16_t minutesFromMidnight, uint8_t data)

Set day profile info.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	index	Ver.: always
uint8_t	N/A	dayId	Ver.: always
uint8_t	N/A	entryId	Ver.: always
uint16_t	N/A	minutesFromMidnight	Ver.: always
uint8_t	N/A	data	Ver.: always

Returns

bool true if success

emberAfCalendarCommonAddDayProfInfo#

bool emberAfCalendarCommonAddDayProfInfo (uint32_t issuerCalendarId, uint8_t dayId, uint8_t * dayScheduleEntries, uint16_t dayScheduleEntriesLength)

Add day profile info.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	issuerCalendarId	Ver.: always
uint8_t	N/A	dayId	Ver.: always
uint8_t *	N/A	dayScheduleEntries	Ver.: always
uint16_t	N/A	dayScheduleEntriesLength	Ver.: always

Returns

bool true if success

emberAfCalendarServerSetWeekProfInfo#

bool emberAfCalendarServerSetWeekProfInfo (uint8_t index, uint8_t weekId, uint8_t dayIdRefMon, uint8_t dayIdRefTue, uint8_t dayIdRefWed, uint8_t dayIdRefThu, uint8_t dayIdRefFri, uint8_t dayIdRefSat, uint8_t dayIdRefSun)

Set calendar server week profile info.

Parameters

Type	Direction	Argument Name	Description
uint8_t	N/A	index	Ver.: always
uint8_t	N/A	weekId	Ver.: always
uint8_t	N/A	dayIdRefMon	Ver.: always
uint8_t	N/A	dayIdRefTue	Ver.: always
uint8_t	N/A	dayIdRefWed	Ver.: always
uint8_t	N/A	dayIdRefThu	Ver.: always
uint8_t	N/A	dayIdRefFri	Ver.: always
uint8_t	N/A	dayIdRefSat	Ver.: always
uint8_t	N/A	dayIdRefSun	Ver.: always

Returns

bool true if success

emberAfCalendarServerAddWeekProfInfo#

bool emberAfCalendarServerAddWeekProfInfo (uint32_t issuerCalendarId, uint8_t weekId, uint8_t dayIdRefMon, uint8_t dayIdRefTue, uint8_t dayIdRefWed, uint8_t dayIdRefThu, uint8_t dayIdRefFri, uint8_t dayIdRefSat, uint8_t dayIdRefSun)

Add calendar server week profile.

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	issuerCalendarId	Ver.: always
uint8_t	N/A	weekId	Ver.: always
uint8_t	N/A	dayIdRefMon	Ver.: always
uint8_t	N/A	dayIdRefTue	Ver.: always
uint8_t	N/A	dayIdRefWed	Ver.: always
uint8_t	N/A	dayIdRefThu	Ver.: always
uint8_t	N/A	dayIdRefFri	Ver.: always
uint8_t	N/A	dayIdRefSat	Ver.: always
uint8_t	N/A	dayIdRefSun	Ver.: always

Returns

bool true if success

emberAfCalendarCommonAddSpecialDaysInfo#

bool emberAfCalendarCommonAddSpecialDaysInfo (uint32_t issuerCalendarId, uint8_t totalNumberOfSpecialDays, uint8_t * specialDaysEntries, uint16_t specialDaysEntriesLength, uint8_t * unknownSpecialDaysMask)

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	issuerCalendarId	Ver.: always
uint8_t	N/A	totalNumberOfSpecialDays	Ver.: always
uint8_t *	N/A	specialDaysEntries	Ver.: always
uint16_t	N/A	specialDaysEntriesLength	Ver.: always
uint8_t *	N/A	unknownSpecialDaysMask	Ver.: always

Returns

bool true if success

Enumeration Documentation#

EmberAfPluginCalendarCommonFlags#

EmberAfPluginCalendarCommonFlags

Enumerator
EMBER_AF_PLUGIN_CALENDAR_COMMON_FLAGS_SENT

Variable Documentation#

calendars#

EmberAfCalendarStruct calendars[]