Cluster Commands: Calendar#

This group describes the CLI commands for the Calendar cluster. Listed below is a description of the cluster: This cluster provides attributes and commands to assist applications in developing time and date based protocol.

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_CALENDAR

zcl calendar get-calendar [earliestStartTime:4] [minIssuerEventId:4] [numberOfCalendars:1] [calendarType:1] [providerId:4]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_DAY_PROFILES

zcl calendar get-day-profiles [providerId:4] [issuerCalendarId:4] [startDayId:1] [numberOfDays:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_WEEK_PROFILES

zcl calendar get-week-profiles [providerId:4] [issuerCalendarId:4] [startWeekId:1] [numberOfWeeks:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_SEASONS

zcl calendar get-seasons [providerId:4] [issuerCalendarId:4]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_SPECIAL_DAYS

zcl calendar get-special-days [startTime:4] [numberOfEvents:1] [calendarType:1] [providerId:4] [issuerCalendarId:4]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_CANCELLATION

zcl calendar get-cancellation

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_CALENDAR#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_CALENDAR

zcl calendar get-calendar [earliestStartTime:4] [minIssuerEventId:4] [numberOfCalendars:1] [calendarType:1] [providerId:4]

  • This command initiates PublishCalendar command(s) for scheduled Calendar updates.

    • earliestStartTime - UTC_TIME

    • minIssuerEventId - INT32U

    • numberOfCalendars - INT8U

    • calendarType - CalendarType [ENUM8]

    • providerId - INT32U See Also


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

EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_DAY_PROFILES#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_DAY_PROFILES

zcl calendar get-day-profiles [providerId:4] [issuerCalendarId:4] [startDayId:1] [numberOfDays:1]

  • This command initiates one or more PublishDayProfile commands for the referenced Calendar.

    • providerId - INT32U

    • issuerCalendarId - INT32U

    • startDayId - INT8U

    • numberOfDays - INT8U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_WEEK_PROFILES#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_WEEK_PROFILES

zcl calendar get-week-profiles [providerId:4] [issuerCalendarId:4] [startWeekId:1] [numberOfWeeks:1]

  • This command initiates one or more PublishWeekProfile commands for the referenced Calendar.

    • providerId - INT32U

    • issuerCalendarId - INT32U

    • startWeekId - INT8U

    • numberOfWeeks - INT8U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_SEASONS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_SEASONS

zcl calendar get-seasons [providerId:4] [issuerCalendarId:4]

  • This command initiates one or more PublishSeasons commands for the referenced Calendar.

    • providerId - INT32U

    • issuerCalendarId - INT32U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_SPECIAL_DAYS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_SPECIAL_DAYS

zcl calendar get-special-days [startTime:4] [numberOfEvents:1] [calendarType:1] [providerId:4] [issuerCalendarId:4]

  • This command initiates one or more PublishSpecialDays commands for the scheduled Special Day Table updates.

    • startTime - UTC_TIME

    • numberOfEvents - INT8U

    • calendarType - CalendarType [ENUM8]

    • providerId - INT32U

    • issuerCalendarId - INT32U See Also


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

EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_CANCELLATION#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_CALENDAR_GET_CANCELLATION

zcl calendar get-cancellation

  • This command initiates the return of the last CancelCalendar command held on the associated server.


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