Plugin Commands: Calendar Server#

The calendar-server plugin contributes several commands to the application framework's CLI. These commands are be used for adding, clearing, and printing calendars.

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_CANCEL_CALENDAR undefined

plugin calendar-server cancel-calendar [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_CALENDAR undefined

plugin calendar-server publish-calendar [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_DAY_PROFILES undefined

plugin calendar-server publish-day-profiles [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1] [dayIndex:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_SEASONS undefined

plugin calendar-server publish-seasons [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_SPECIAL_DAYS undefined

plugin calendar-server publish-special-days [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_WEEK_PROFILE undefined

plugin calendar-server publish-week-profile [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1] [weekIndex:1]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_CANCEL_CALENDAR#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_CANCEL_CALENDAR

plugin calendar-server cancel-calendar [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1]

  • Invalidates the specified calendar and sends a cancel calendar.

    • nodeId - INT16U - the destination node id

    • srcEndpoint - INT8U - the source endpoint

    • dstEndpoint - INT8U - the destination endpoint

    • calendarIndex - INT8U - the index of the calendar within the calendar table


Definition at line 1906 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_CALENDAR#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_CALENDAR

plugin calendar-server publish-calendar [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1]

  • Publish an calendar.

    • nodeId - INT16U - the destination node id

    • srcEndpoint - INT8U - the source endpoint

    • dstEndpoint - INT8U - the destination endpoint

    • calendarIndex - INT8U - the index of the calendar within the calendar table


Definition at line 1915 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_DAY_PROFILES#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_DAY_PROFILES

plugin calendar-server publish-day-profiles [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1] [dayIndex:1]

  • Publish the day profiles of the specified day in the specified calendar.

    • nodeId - INT16U - the destination node id

    • srcEndpoint - INT8U - the source endpoint

    • dstEndpoint - INT8U - the destination endpoint

    • calendarIndex - INT8U - the index of the calendar within the calendar table

    • dayIndex - INT8U - the index of the day in the calendar


Definition at line 1925 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_SEASONS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_SEASONS

plugin calendar-server publish-seasons [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1]

  • Publish the seasons in the specified calendar.

    • nodeId - INT16U - the destination node id

    • srcEndpoint - INT8U - the source endpoint

    • dstEndpoint - INT8U - the destination endpoint

    • calendarIndex - INT8U - the index of the calendar within the calendar table


Definition at line 1934 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_SPECIAL_DAYS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_SPECIAL_DAYS

plugin calendar-server publish-special-days [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1]

  • Publish the special days for the specified calendar.

    • nodeId - INT16U - the destination node id

    • srcEndpoint - INT8U - the source endpoint

    • dstEndpoint - INT8U - the destination endpoint

    • calendarIndex - INT8U - the index of the calendar within the calendar table


Definition at line 1943 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_WEEK_PROFILE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_SERVER_PLUGIN_CALENDAR_SERVER_PUBLISH_WEEK_PROFILE

plugin calendar-server publish-week-profile [nodeId:2] [srcEndpoint:1] [dstEndpoint:1] [calendarIndex:1] [weekIndex:1]

  • Publish the week profile of the specified week in the specified calendar.

    • nodeId - INT16U - the destination node id

    • srcEndpoint - INT8U - the source endpoint

    • dstEndpoint - INT8U - the destination endpoint

    • calendarIndex - INT8U - the index of the calendar within the calendar table

    • weekIndex - INT8U - the index of the week in the calendar


Definition at line 1953 of file ./app/framework/test/headers/cli.doc