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#
sl_zigbee_af_calendar_day_schedule_entry_struct_t
sl_zigbee_af_calendar_day_struct_t
sl_zigbee_af_calendar_special_day_struct_t
sl_zigbee_af_calendar_week_struct_t
sl_zigbee_af_calendar_season_struct_t
sl_zigbee_af_calendar_struct_t
API#
Get the calendar by calendar ID.
Get the calendar end time (UTC).
Set the calendar info.
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.
Set calendar server season info.
Add calendar server season info.
Set day profile info.
Add day profile info.
Set calendar server week profile info.
Add calendar server week profile.
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#
Macros#
API Documentation#
sl_zigbee_af_calendar_common_get_calendar_by_id#
uint8_t sl_zigbee_af_calendar_common_get_calendar_by_id (uint32_t calendarId, uint32_t providerId)
Get the calendar by calendar ID.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint32_t | N/A | calendarId | Ver.: always |
uint32_t | N/A | providerId | Ver.: always |
Returns
uint8_t Calender index
sl_zigbee_af_calendar_common_end_time_utc#
uint32_t sl_zigbee_af_calendar_common_end_time_utc (const sl_zigbee_af_calendar_struct_t * calendar)
Get the calendar end time (UTC).
Type | Direction | Argument Name | Description |
---|---|---|---|
const sl_zigbee_af_calendar_struct_t * | N/A | calendar | pointer to the calendar struct Ver.: always |
Returns
uint32_t end UTC time in seconds
sl_zigbee_af_calendar_common_set_cal_info#
bool sl_zigbee_af_calendar_common_set_cal_info (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.
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
sl_zigbee_af_calendar_common_add_cal_info#
bool sl_zigbee_af_calendar_common_add_cal_info (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.
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
sl_zigbee_af_calendar_server_set_seasons_info#
bool sl_zigbee_af_calendar_server_set_seasons_info (uint8_t index, uint8_t seasonId, sl_zigbee_af_date_t startDate, uint8_t weekIndex)
Set calendar server season info.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | index | Ver.: always |
uint8_t | N/A | seasonId | Ver.: always |
sl_zigbee_af_date_t | N/A | startDate | Ver.: always |
uint8_t | N/A | weekIndex | Ver.: always |
Returns
bool true if success
sl_zigbee_af_calendar_server_add_seasons_info#
bool sl_zigbee_af_calendar_server_add_seasons_info (uint32_t issuerCalendarId, uint8_t * seasonsEntries, uint8_t seasonsEntriesLength, uint8_t * unknownWeekIdSeasonsMask)
Add calendar server season info.
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
sl_zigbee_af_calendar_common_set_day_prof_info#
bool sl_zigbee_af_calendar_common_set_day_prof_info (uint8_t index, uint8_t dayId, uint8_t entryId, uint16_t minutesFromMidnight, uint8_t data)
Set day profile info.
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
sl_zigbee_af_calendar_common_add_day_prof_info#
bool sl_zigbee_af_calendar_common_add_day_prof_info (uint32_t issuerCalendarId, uint8_t dayId, uint8_t * dayScheduleEntries, uint16_t dayScheduleEntriesLength)
Add day profile info.
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
sl_zigbee_af_calendar_server_set_week_prof_info#
bool sl_zigbee_af_calendar_server_set_week_prof_info (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.
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
sl_zigbee_af_calendar_server_add_week_prof_info#
bool sl_zigbee_af_calendar_server_add_week_prof_info (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.
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
sl_zigbee_af_calendar_common_add_special_days_info#
bool sl_zigbee_af_calendar_common_add_special_days_info (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.
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#
sl_zigbee_af_plugin_calendar_common_flags_t#
sl_zigbee_af_plugin_calendar_common_flags_t
Enumerator | |
---|---|
SL_ZIGBEE_AF_PLUGIN_CALENDAR_COMMON_FLAGS_SENT |