Plugin Commands: Calendar Common
Macros | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_ADD_CAL_INFO |
plugin calendar-common add-cal-info [providerId:4] [issuerEventId:4] [calId:4] [startTime:4] [calType:1] [calName:-1] [numberOfSeasons:1] [numberOfWeekProfiles:1] [numberOfDayProfiles:1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_CLEAR |
plugin calendar-common clear | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_ENHANCED_CALENDAR |
plugin calendar-common load-enhanced-calendar [index:1] [providerId:4] [issuerEventId:4] [issuerCalendarId:4] [startTime:4] [type:1] [name:-1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_ENHANCED_SPECIAL_DAYS |
plugin calendar-common load-enhanced-special-days [index:1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_FLAT_CALENDAR |
plugin calendar-common load-flat-calendar [index:1] [providerId:4] [issuerEventId:4] [issuerCalendarId:4] [startTime:4] [type:1] [name:-1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_SIMPLE_CALENDAR |
plugin calendar-common load-simple-calendar [index:1] [providerId:4] [issuerEventId:4] [issuerCalendarId:4] [startTime:4] [type:1] [name:-1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_SIMPLE_SPECIAL_DAYS |
plugin calendar-common load-simple-special-days [index:1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_DAYS |
plugin calendar-common print days | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_SEASONS |
plugin calendar-common print seasons | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_SPECIAL_DAYS |
plugin calendar-common print special-days | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_SUMMARY |
plugin calendar-common print summary | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_WEEKS |
plugin calendar-common print weeks | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SELECT |
plugin calendar-common select [index:1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SET_CAL_INFO |
plugin calendar-common set-cal-info [index:1] [providerId:4] [issuerEventId:4] [calId:4] [startTime:4] [calType:1] [calName:-1] [numberOfSeasons:1] [numberOfWeekProfiles:1] [numberOfDayProfiles:1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SET_DAY_PROF_INFO |
plugin calendar-common set-day-prof-info [index:1] [dayId:1] [entryId:1] [minutesFromMidnight:2] [data:1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SET_SEASONS_INFO |
plugin calendar-common set-seasons-info [index:1] [weekId:1] [startDate:4] [weekIdRef:1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SET_WEEK_PROF_INFO |
plugin calendar-common set-week-prof-info [index:1] [weekId:1] [dayIdRefMon:1] [dayIdRefTue:1] [dayIdRefWed:1] [dayIdRefThu:1] [dayIdRefFri:1] [dayIdRefSat:1] [dayIdRefSun:1] | |
#define | EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_TEST_INIT |
plugin calendar-common test-init |
Detailed Description
The calendar common plugin commands provide commands to view and manipulate the local copy of the calendar.
Macro Definition Documentation
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_ADD_CAL_INFO |
plugin calendar-common add-cal-info [providerId:4] [issuerEventId:4] [calId:4] [startTime:4] [calType:1] [calName:-1] [numberOfSeasons:1] [numberOfWeekProfiles:1] [numberOfDayProfiles:1]
- Adding calendar information.
- providerId - INT32U
- issuerEventId - INT32U
- calId - INT32U
- startTime - INT32U
- calType - INT8U
- calName - OCTET_STRING
- numberOfSeasons - INT8U
- numberOfWeekProfiles - INT8U
- numberOfDayProfiles - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_CLEAR |
plugin calendar-common clear
- Clear the calendars.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_ENHANCED_CALENDAR |
plugin calendar-common load-enhanced-calendar [index:1] [providerId:4] [issuerEventId:4] [issuerCalendarId:4] [startTime:4] [type:1] [name:-1]
- Loads the Enhanced Calendar defined in Appendix D.2 in the SE 1.2 Test specification.
- index - INT8U - The index in the internal calendar table where this calendar is to be stored
- providerId - INT32U - The provider ID
- issuerEventId - INT32U - The issuer event ID
- issuerCalendarId - INT32U - The issuer calendar ID
- startTime - INT32U - The time when this calendar is to be considered active
- type - INT8U - The type: Del=0x00, Rec=0x01, DelAndRec=0x02, Friendly=0x03, Aux=0x04
- name - OCTET_STRING - The calendar name
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_ENHANCED_SPECIAL_DAYS |
plugin calendar-common load-enhanced-special-days [index:1]
- Loads the Simple Special Days defined in Appendix D.5 in the SE 1.2 Test specification.
- index - INT8U - The index in the internal calendar table where the speical days are to be stored
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_FLAT_CALENDAR |
plugin calendar-common load-flat-calendar [index:1] [providerId:4] [issuerEventId:4] [issuerCalendarId:4] [startTime:4] [type:1] [name:-1]
- Loads the Flat Calendar defined in Appendix D.3 in the SE 1.2 Test specification.
- index - INT8U - The index in the internal calendar table where this calendar is to be stored
- providerId - INT32U - The provider ID
- issuerEventId - INT32U - The issuer event ID
- issuerCalendarId - INT32U - The issuer calendar ID
- startTime - INT32U - The time when this calendar is to be considered active
- type - INT8U - The type: Del=0x00, Rec=0x01, DelAndRec=0x02, Friendly=0x03, Aux=0x04
- name - OCTET_STRING - The calendar name
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_SIMPLE_CALENDAR |
plugin calendar-common load-simple-calendar [index:1] [providerId:4] [issuerEventId:4] [issuerCalendarId:4] [startTime:4] [type:1] [name:-1]
- Loads the Simple Calendar defined in Appendix D.1 in the SE 1.2 Test specification.
- index - INT8U - The index in the internal calendar table where this calendar is to be stored
- providerId - INT32U - The provider ID
- issuerEventId - INT32U - The issuer event ID
- issuerCalendarId - INT32U - The issuer calendar ID
- startTime - INT32U - The time when this calendar is to be considered active
- type - INT8U - The type: Del=0x00, Rec=0x01, DelAndRec=0x02, Friendly=0x03, Aux=0x04
- name - OCTET_STRING - The calendar name
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_LOAD_SIMPLE_SPECIAL_DAYS |
plugin calendar-common load-simple-special-days [index:1]
- Loads the Simple Special Days defined in Appendix D.4 in the SE 1.2 Test specification.
- index - INT8U - The index in the internal calendar table where the speical days are to be stored
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_DAYS |
plugin calendar-common print days
- Prints the local calendar's days
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_SEASONS |
plugin calendar-common print seasons
- Prints the local calendar's seasons.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_SPECIAL_DAYS |
plugin calendar-common print special-days
- Prints the local calendar's special days.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_SUMMARY |
plugin calendar-common print summary
- Prints the local calendar summary at the previously selected index.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_PRINT_WEEKS |
plugin calendar-common print weeks
- Prints the local calendar's weeks.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SELECT |
plugin calendar-common select [index:1]
- Selects a calendar to be printed.
- index - INT8U - The index of the calendar to be selected.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SET_CAL_INFO |
plugin calendar-common set-cal-info [index:1] [providerId:4] [issuerEventId:4] [calId:4] [startTime:4] [calType:1] [calName:-1] [numberOfSeasons:1] [numberOfWeekProfiles:1] [numberOfDayProfiles:1]
- Manually set local calendar information.
- index - INT8U
- providerId - INT32U
- issuerEventId - INT32U
- calId - INT32U
- startTime - INT32U
- calType - INT8U
- calName - OCTET_STRING
- numberOfSeasons - INT8U
- numberOfWeekProfiles - INT8U
- numberOfDayProfiles - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SET_DAY_PROF_INFO |
plugin calendar-common set-day-prof-info [index:1] [dayId:1] [entryId:1] [minutesFromMidnight:2] [data:1]
- Manually set local calendar's day profiles information.
- index - INT8U
- dayId - INT8U
- entryId - INT8U
- minutesFromMidnight - INT16U
- data - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SET_SEASONS_INFO |
plugin calendar-common set-seasons-info [index:1] [weekId:1] [startDate:4] [weekIdRef:1]
- Manually set local calendar's seasons information.
- index - INT8U
- weekId - INT8U
- startDate - DATE
- weekIdRef - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_SET_WEEK_PROF_INFO |
plugin calendar-common set-week-prof-info [index:1] [weekId:1] [dayIdRefMon:1] [dayIdRefTue:1] [dayIdRefWed:1] [dayIdRefThu:1] [dayIdRefFri:1] [dayIdRefSat:1] [dayIdRefSun:1]
- Manually set local calendar's week profiles information.
- index - INT8U
- weekId - INT8U
- dayIdRefMon - INT8U
- dayIdRefTue - INT8U
- dayIdRefWed - INT8U
- dayIdRefThu - INT8U
- dayIdRefFri - INT8U
- dayIdRefSat - INT8U
- dayIdRefSun - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_CALENDAR_COMMON_PLUGIN_CALENDAR_COMMON_TEST_INIT |
plugin calendar-common test-init
- Initializes test calendars with dummy data.