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#
emberAfCalendarServerPublishCalendarMessage#
void emberAfCalendarServerPublishCalendarMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)
Publish a calendar.
| N/A | nodeId | The destination nodeId. |
| N/A | srcEndpoint | The source endpoint. |
| N/A | dstEndpoint | The destination endpoint. |
| 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.
50 of file app/framework/plugin/calendar-server/calendar-server.hemberAfCalendarServerPublishDayProfilesMessage#
void emberAfCalendarServerPublishDayProfilesMessage (EmberNodeId 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.
| N/A | nodeId | The destination nodeId. |
| N/A | srcEndpoint | The source endpoint. |
| N/A | dstEndpoint | The destination endpoint. |
| N/A | calendarIndex | The index in the calendar table. |
| 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.
67 of file app/framework/plugin/calendar-server/calendar-server.hemberAfCalendarServerPublishWeekProfileMessage#
void emberAfCalendarServerPublishWeekProfileMessage (EmberNodeId 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.
| N/A | nodeId | The destination nodeId |
| N/A | srcEndpoint | The source endpoint |
| N/A | dstEndpoint | The destination endpoint |
| N/A | calendarIndex | The index in the calendar table. |
| 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.
85 of file app/framework/plugin/calendar-server/calendar-server.hemberAfCalendarServerPublishSeasonsMessage#
void emberAfCalendarServerPublishSeasonsMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)
Publish the seasons in the specified calendar.
| N/A | nodeId | The destination nodeId. |
| N/A | srcEndpoint | The source endpoint. |
| N/A | dstEndpoint | The destination endpoint. |
| 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.
102 of file app/framework/plugin/calendar-server/calendar-server.hemberAfCalendarServerPublishSpecialDaysMessage#
void emberAfCalendarServerPublishSpecialDaysMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)
Publish the special days of the specified calendar.
| N/A | nodeId | The destination nodeId. |
| N/A | srcEndpoint | The source endpoint. |
| N/A | dstEndpoint | The destination endpoint. |
| 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.
118 of file app/framework/plugin/calendar-server/calendar-server.hemberAfCalendarServerCancelCalendarMessage#
void emberAfCalendarServerCancelCalendarMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)
Publish the special days of the specified calendar.
| N/A | nodeId | The destination nodeId. |
| N/A | srcEndpoint | The source endpoint. |
| N/A | dstEndpoint | The destination endpoint. |
| 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.
135 of file app/framework/plugin/calendar-server/calendar-server.h