Modules#

Calendar Server

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.

API#

void
emberAfCalendarServerPublishCalendarMessage(EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)

Publish a calendar.

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.

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.

void
emberAfCalendarServerPublishSeasonsMessage(EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)

Publish the seasons in the specified calendar.

void
emberAfCalendarServerPublishSpecialDaysMessage(EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)

Publish the special days of the specified calendar.

void
emberAfCalendarServerCancelCalendarMessage(EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)

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.

Parameters
N/AnodeId

The destination nodeId.

N/AsrcEndpoint

The source endpoint.

N/AdstEndpoint

The destination endpoint.

N/AcalendarIndex

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.


Definition at line 50 of file app/framework/plugin/calendar-server/calendar-server.h

emberAfCalendarServerPublishDayProfilesMessage#

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.

Parameters
N/AnodeId

The destination nodeId.

N/AsrcEndpoint

The source endpoint.

N/AdstEndpoint

The destination endpoint.

N/AcalendarIndex

The index in the calendar table.

N/AdayIndex

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.


Definition at line 67 of file app/framework/plugin/calendar-server/calendar-server.h

emberAfCalendarServerPublishWeekProfileMessage#

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.

Parameters
N/AnodeId

The destination nodeId

N/AsrcEndpoint

The source endpoint

N/AdstEndpoint

The destination endpoint

N/AcalendarIndex

The index in the calendar table.

N/AweekIndex

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.


Definition at line 85 of file app/framework/plugin/calendar-server/calendar-server.h

emberAfCalendarServerPublishSeasonsMessage#

void emberAfCalendarServerPublishSeasonsMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)

Publish the seasons in the specified calendar.

Parameters
N/AnodeId

The destination nodeId.

N/AsrcEndpoint

The source endpoint.

N/AdstEndpoint

The destination endpoint.

N/AcalendarIndex

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.


Definition at line 102 of file app/framework/plugin/calendar-server/calendar-server.h

emberAfCalendarServerPublishSpecialDaysMessage#

void emberAfCalendarServerPublishSpecialDaysMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)

Publish the special days of the specified calendar.

Parameters
N/AnodeId

The destination nodeId.

N/AsrcEndpoint

The source endpoint.

N/AdstEndpoint

The destination endpoint.

N/AcalendarIndex

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.


Definition at line 118 of file app/framework/plugin/calendar-server/calendar-server.h

emberAfCalendarServerCancelCalendarMessage#

void emberAfCalendarServerCancelCalendarMessage (EmberNodeId nodeId, uint8_t srcEndpoint, uint8_t dstEndpoint, uint8_t calendarIndex)

Publish the special days of the specified calendar.

Parameters
N/AnodeId

The destination nodeId.

N/AsrcEndpoint

The source endpoint.

N/AdstEndpoint

The destination endpoint.

N/AcalendarIndex

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.


Definition at line 135 of file app/framework/plugin/calendar-server/calendar-server.h