background image

Programming i!-Schedule

16

 i!-Schedule

i!-ScheduleEngineMod Module Parameters (Cont.)

strTmTzDstRules

A string containing 1 or more daylight saving rule strings. Multiple daylight saving rules are 
separated with the "$FF" character. Two standard rule strings, 'None' and 'US' will disable 
daylight savings time (default) and enable US daylight savings rules respectively. For other 
locations, daylight saving rule strings should be in the following format:

Custom string: "Month" "Day Description" "Time" "Offset From Std" "Description"

               "Month":          Month name ex: "Apr"

               "Time"            Time to activate (hh:mm:ss, 24 hour).  ex: "02:00:00"

               "Offset From Std" Time to offset from GMT (hh:mm:ss, 24 hour).  ex: "01:00:00"

               "Description"     String to replace "%s" with in Time zone description.  ex: 'D'

               "Day Description"  Day Description. Fixed Date, Last Day Of Week or

                                  First Day of Week Before/After Date

                                  Fixed ex: "15"

                                  Last Day of Week ex: "LastSunday"

                                  First Day of Week Before DATE-ex: "Sun<=24"

                                  First Day of Week After DATE-ex: "Sun>=1"

Time zone examples:

Here is an example configuration for Santiago, Chile which observes Daylight savings 
starting on the first Sunday on or after October 9th at midnight (jump ahead 1 hour) and the 
First Sunday on or after the 9th of March at midnight (jump back 1 hour):

strTmTzDstRules = "'Oct Sun>=9 00:00:00 01:00:00 D',$FF,'Mar Sun>=9 00:00:00 00:00:00 S'"

Here is an example configuration for Sydney, Australia which observes Daylight savings 
starting on the Last Sunday in October 2:00 AM (jump ahead 1 hour) and the Last Sunday 
in March at 3:00 AM (jump back 1 hour):

strTmTzDstRules = "'Oct LastSun 02:00:00 01:00:00 X',$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) and 
the Last Sunday in October at 1:00 AM (jump back 1 hour):

strTmTzDstRules = "'Mar LastSun 01:00:00 01:00:00 BST',$FF,'Oct LastSun 01:00:00 00:00:00 GMT'"

strTmLocName

A string describing the location the system is installed in. This could be any string 
describing the region or city.

dTmLocLong 

and 

dTmLocLat

A double containing the longitude and latitude coordinates of the location where the system 
is installed. Longitude is in Degrees (Fraction of Degrees). West longitudes must be 
negative. Latitude is in Degrees (Fraction of Degrees). South latitudes must be negative.

These parameters are used for calculating sunrise and sunset times. You can find 
longitude / latitude values and descriptions at: 

• http://geography.about.com/cs/latitudelongitude/ 

• http://www.census.gov/cgi-bin/gazetteer 

• http://www.njdxa.org/landl-lookup-dx.shtml 

nTmTsProtocol

A Timeserver protocol number to allow the NetLinx system to synchronous its clock with an 
Internet timeserver. The available values are:

• 0  =  Disabled

• 1 = DayTime(13/udp, 13/tcp)

• 2 = Time(37/udp, 37/tcp)

• 3 = SNTP(123/udp)

• 4 = SNTP Broadcast (123/udp).

nTmTsCheck_Time

The time in minutes between time checked to the Internet timeserver. You can put 0 to use 
the default value of 120 (or 2 hours).

strTmTsServer

The IP address or Host Name of the preferred Internet timeserver. If left blank (empty 
string), a default server is picked from the nist_svr.lst file location in the doc:\time directory 
of the NetLinx Master. If this file is not present, an internal list of NIST time servers are used 
and an appropriate server is selected from the list.

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: