Calendar Common#

emberAfPluginCalendarCommonGetCalendarById#

uint8_t emberAfPluginCalendarCommonGetCalendarById (uint32_t calendarId, uint32_t providerId)

Gets the calender by calender ID.

Returns

• uint8_t Calender index

emberAfPluginCalendarCommonEndTimeUtc#

uint32_t emberAfPluginCalendarCommonEndTimeUtc (const EmberAfCalendarStruct * calendar)

Get the calender end time (UTC).

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)

Sets the calender info.

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)

Adds 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.

Returns

• bool true if success

emberAfCalendarServerSetSeasonsInfo#

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

Set calender server season info.

Returns

• bool true if success

emberAfCalendarServerAddSeasonsInfo#

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

Add calender server season info.

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.

Returns

• bool true if success

emberAfCalendarCommonAddDayProfInfo#

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

Add day profile info.

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 calender server week profile info.

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 calender server week profile.

Returns

• bool true if success

emberAfCalendarCommonAddSpecialDaysInfo#

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.

Returns

• bool true if success

EmberAfPluginCalendarCommonFlags#

EmberAfPluginCalendarCommonFlags

calendars#

EmberAfCalendarStruct calendars[]

fieldLength#

#define fieldLength

(field)

EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_SCHEDULE_ENTRY#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_SCHEDULE_ENTRY

0xFFFF

EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_ID#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_ID

0xFF

EMBER_AF_PLUGIN_CALENDAR_MAX_CALENDAR_NAME_LENGTH#

#define EMBER_AF_PLUGIN_CALENDAR_MAX_CALENDAR_NAME_LENGTH

12

EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_INDEX#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_INDEX

0xFF

EMBER_AF_PLUGIN_CALENDAR_COMMON_MONDAY_INDEX#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_MONDAY_INDEX

(0)

EMBER_AF_PLUGIN_CALENDAR_COMMON_SUNDAY_INDEX#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_SUNDAY_INDEX

(6)

EMBER_AF_DAYS_IN_THE_WEEK#

#define EMBER_AF_DAYS_IN_THE_WEEK

(7)

EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_CALENDAR_ID#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_INVALID_CALENDAR_ID

0xFFFFFFFF

EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_CALENDAR_ID#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_CALENDAR_ID

0x00000000

EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_PROVIDER_ID#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_PROVIDER_ID

0xFFFFFFFF

EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_ISSUER_ID#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_ISSUER_ID

0xFFFFFFFF

EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_CALENDAR_TYPE#

#define EMBER_AF_PLUGIN_CALENDAR_COMMON_WILDCARD_CALENDAR_TYPE

0xFF