Calendar Server#
API and Callbacks for the Calendar Cluster Server Component.
This component is an implementation of the calendar server cluster. It responds to requests for the calendar data using data from the Calendar Common component.
Modules#
API#
Publish a calendar.
Publish the day profiles of the specified day in the specified calendar.
Publish the week profile of the specified week in the specified calendar.
Publish the seasons in the specified calendar.
Publish the special days of the specified calendar.
Publish the special days of the specified calendar.
API Documentation#
sl_zigbee_af_calendar_server_publish_calendar_message#
void sl_zigbee_af_calendar_server_publish_calendar_message (sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)
Publish a calendar.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | nodeId | The destination nodeId. |
| uint8_t | N/A | srcEndpoint | The source endpoint. |
| uint8_t | N/A | dstEndpoint | The destination endpoint. |
| uint8_t | N/A | calendarIndex | The index in the calendar table. |
Locates the calendar in the calendar table at the specified location and sends a PublishCalendar command using its information.
sl_zigbee_af_calendar_server_publish_day_profiles_message#
void sl_zigbee_af_calendar_server_publish_day_profiles_message (sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex, uint8_t dayIndex)
Publish the day profiles of the specified day in the specified calendar.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | nodeId | The destination nodeId. |
| uint8_t | N/A | srcEndpoint | The source endpoint. |
| uint8_t | N/A | dstEndpoint | The destination endpoint. |
| uint8_t | N/A | calendarIndex | The index in the calendar table. |
| uint8_t | N/A | dayIndex | The index of the day in the calendar. |
Locates the calendar in the calendar table at the specified location and sends a PublishDayProfiles command using its information.
sl_zigbee_af_calendar_server_publish_week_profile_message#
void sl_zigbee_af_calendar_server_publish_week_profile_message (sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex, uint8_t weekIndex)
Publish the week profile of the specified week in the specified calendar.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | nodeId | The destination nodeId |
| uint8_t | N/A | srcEndpoint | The source endpoint |
| uint8_t | N/A | dstEndpoint | The destination endpoint |
| uint8_t | N/A | calendarIndex | The index in the calendar table. |
| uint8_t | N/A | weekIndex | The index of the week in the calendar. |
Locates the calendar in the calendar table at the specified location and sends a PublishWeekProfile command using its information.
sl_zigbee_af_calendar_server_publish_seasons_message#
void sl_zigbee_af_calendar_server_publish_seasons_message (sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)
Publish the seasons in the specified calendar.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | nodeId | The destination nodeId. |
| uint8_t | N/A | srcEndpoint | The source endpoint. |
| uint8_t | N/A | dstEndpoint | The destination endpoint. |
| uint8_t | N/A | calendarIndex | The index in the calendar table. |
Locates the calendar in the calendar table at the specified location and sends a PublishSeasons command using its information.
sl_zigbee_af_calendar_server_publish_special_days_message#
void sl_zigbee_af_calendar_server_publish_special_days_message (sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)
Publish the special days of the specified calendar.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | nodeId | The destination nodeId. |
| uint8_t | N/A | srcEndpoint | The source endpoint. |
| uint8_t | N/A | dstEndpoint | The destination endpoint. |
| uint8_t | N/A | calendarIndex | The index in the calendar table. |
Locates the calendar in the calendar table at the specified location and sends a PublishSpecialDays command using its information.
sl_zigbee_af_calendar_server_cancel_calendar_message#
void sl_zigbee_af_calendar_server_cancel_calendar_message (sl_802154_short_addr_t nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)
Publish the special days of the specified calendar.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_802154_short_addr_t | N/A | nodeId | The destination nodeId. |
| uint8_t | N/A | srcEndpoint | The source endpoint. |
| uint8_t | N/A | dstEndpoint | The destination endpoint. |
| uint8_t | N/A | calendarIndex | The index in the calendar table. |
Locates the calendar in the calendar table at the specified location and sends a CancelCalendar command using its information. Note: It is up to the caller to invalidate the local copy of the calendar.