background image

Programming i!-Schedule

12

 i!-Schedule

Send_Commands

i!-Schedule supports the following out-bound commands (Master to device). In the table the 

command text wraps, but there are no breaks in syntax. 

i!-Schedule Send_Commands

Command

Description

"'SET EVENT-[Event Number],[Event Name],
[Date String],[Start Time String],
[End Time String]'"

Sets the name, date, start and end time of an event. All 
Parameters are optional.

"'GET EVENT-[Event Number]'"

Gets the name, date, start and end time of an event.

"'SET NAME-[Event Number],[Event Name]'"

Sets the name of an event. If name is an empty string, event 
is deleted.

"'GET NAME-[Event Number]'"

Gets the name of an event.

"'SET STIME-[Event Number],[Time 
String]'"

Sets start time for event number. If time string is empty, the 
event is set for "No Start Time" (i.e. not scheduled).

"'GET STIME-[Event Number]'"

Gets start time for event number.

"'SET ETIME-[Event Number],[Time 
String]'"

Sets end-time for event number. If time string is empty, the 
event is set for one-shot (non-time spanning) event.

"'GET ETIME-[Event Number]'"

Gets end-time for event number.

"'SET DATE-[Event Number],[Date 
String]'"

Gets date for event number. If time string is empty, the event 
is set for "No Date" (i.e. not scheduled).

"'GET DATE-[Event Number]'"

Gets date string for event number.

"'SET SPARAM-[Event Number],[Param 
Number],[Param String]'"

Sets the string parameter for event number. If no string is 
supplied, parameter is deleted.

"'GET SPARAM-[Event Number],[Param 
Number]'"

Gets the string parameters for event number. If the 
parameter number is 0, all string parameters for event 
number are returned.

"'SET VPARAM-[Event Number],[Param 
Number],[Param Value]'"

Sets the value parameter for event number. If no value is 
supplied, the parameter is deleted.

"'GET VPARAM-[Event Number],[Param 
Number]'"

Gets the value parameters for event number. If parameter 
number is 0, all value parameters for event number are 
returned.

"'SET PPAGE-[Event Number],[Param 
Page]'"

Sets the parameter page for event number. If no value is 
supplied, parameter page is deleted.

"'GET PPAGE-[Event Number]"

Gets the parameter page for event number.

"'SET PTEXT-[Event Number],[Param 
Page]'"

Sets the parameter text for event number. If no value is 
supplied, parameter text is deleted.

"'GET PTEXT-[Event Number]"

Gets the parameter text for event number.

"'GET EVENT LISTS'"

Returns past, current/active and future event lists.

"'RUN-[Event Number]'"

Runs event number and re-schedules the event (if it can be 
rescheduled).

'"CANCEL-[Event Number]'"

Cancels event form running today and re-schedules the 
event (if it can be rescheduled).

"'DFORMAT-DAY/MONTH'"

Sets Date format European Format: Day/Month/Year.

"'DFORMAT-MONTH/DAY'"

Sets Date format US style: Month/Day/Year.

"'TFORMAT-12 HOUR'"

Sets Time format to 12 hour format: [01-12]:[00-59] [AM,PM].

"'TFORMAT-24 Hour'"

Sets Time format to 24 hour (military) format: 
[01-23]:[00-59].

Continued

Summary of Contents for I!-SCHEDULE

Page 1: ...instruction manual integration Solutions i Schedule...

Page 2: ...any accompanying hardware This limited warranty gives you specific legal rights You may have others which vary from state country to state country NO LIABILITY FOR CONSEQUENTIAL DAMAGES In no event sh...

Page 3: ...ing Systems 1 Minimum PC Requirements 1 Installing i Schedule 2 Using i Schedule 3 Dynamic Events 4 Schedule Persistence 7 Time Protocols 8 Programming i Schedule 11 Channels 11 Levels 11 Send_Command...

Page 4: ...ii i Schedule Table of Contents...

Page 5: ...ace where the user can edit the scheduling of events Use this module if you want a user interface for scheduling You do not need to include the i ScheduleEngineMod if you use this module Supported Ope...

Page 6: ...xt to proceed 4 In the i Schedule Select Components dialog select which example programs you would like to install 5 In the Select i Schedule Install Location dialog use the Browse button to navigate...

Page 7: ...uld write code that responds to the pushes turning the lights on and then off Let s use relays for lighting control to simplify the example BUTTON_EVENT TP 1 Outdoor Lights On PUSH ON RELAY 1 BUTTON_E...

Page 8: ...ddition to specifying the name of an event you can also program the date and time when the event should occur The scheduled virtual device supports a variety of commands to set and query the values of...

Page 9: ...ecord RELEASE Switch nVCRNumber Case 1 dvVCRDev dvVCR1 Case 2 dvVCRDev dvVCR2 Case 3 dvVCRDev dvVCR3 Case 4 dvVCRDev dvVCR4 Case 5 dvVCRDev dvVCR5 Send_Command dvVCRDev SP 2 Stop Easy right If we have...

Page 10: ...ll probably have an OK and Cancel button The Cancel would simply return them to the scheduling edit page while the OK button would return them to the scheduling edit page and update the parameters You...

Page 11: ...doc user schedule directory All event information is stored in this file and recalled during power up Any event scheduled by the user is stored during a power cycle and will not be lost This file is...

Page 12: ...ule has also been written to use a popular DayTime format which is used by the Linux implementation of DayTime and Tardis a popular time synching software Although not specified the Date and Time of t...

Page 13: ...your Network administrator It is probable that your network already provides some form of Date and Time information and that information is probably obtained from a highly accurate source Most instal...

Page 14: ...Using i Schedule 10 i Schedule...

Page 15: ...annel Status 241 Sunrise occurred Push only 242 Sunset occurred Push only 243 Daylight savings status Push when active and release when not active with Channel Status 244 Time changed by time sever up...

Page 16: ...ts the string parameter for event number If no string is supplied parameter is deleted GET SPARAM Event Number Param Number Gets the string parameters for event number If the parameter number is 0 all...

Page 17: ...Weekly SMTWTFS or xMultiplier Monthly Day 1 31 xMultiplier Monthly First Second Third Fourth Last Sun Mon Tue Wed Thu Fri Sat xMultiplier Yearly Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec Day 1...

Page 18: ...Sch is a unique module name i Schedule Strings String Description ETIME Event Number Time String End Time String for event number DATE Event Number Date String Date String for event number PARAM Param...

Page 19: ...ST rules So to handle the case you specify E sT Eastern time zone C sT Central time zone M sT Mountain time zone P sT Pacific time zone For description in DTS time rules you use Standard Description S...

Page 20: ...FF Mar LastSun 03 00 00 00 00 00 X Here is the example configuration for London England which uses GMT and observes Daylight savings starting on the last Sunday in March at 1 00 AM jump ahead 1 hour a...

Page 21: ...nvtSchEventList nvtSchEventInfo nvtSchEngineList nvtSchEngineInfo nvtSchEngineStats nvtSchEngineListSel nvtSchTimeSelect nvtSchDateSelect nvtSchDetailSelect strTmTzName strTmTzDesc dTmTzGmtOffset strT...

Page 22: ...unrise Start time Before Sunset Start Time After Sunrise Start time After Sunset Start Time Hour Start time Minute Start Time AM PM End time None End time Fixed End time Sunrise End time Sunset End ti...

Page 23: ...tSel An INTEGER array with the following variable text channels Number of Past Events Number of Current Events Number of Future Events nvtSchTimeSelect An INTEGER array with the following variable tex...

Page 24: ...rules So to handle the case you specify E sT Eastern time zone C sT Central time zone M sT Mountain time zone P sT Pacific time zone For description in DTS time rules you use Standard Description S Da...

Page 25: ...tSun 03 00 00 00 00 00 X Here is the example configuration for London England which uses GMT and observes Daylight savings starting on the last Sunday in March at 1 00 AM jump ahead 1 hour and the Las...

Page 26: ...ve richardson TX 75082 USA 469 624 8000 800 222 0193 fax 469 624 7153 technical support 800 932 6993 033 004 2598 2 05 2005 AMX Corporation All rights reserved AMX the AMX logo the building icon the h...

Reviews: