Download
Share
Print this page
Lutron Electronics HomeWorks Protocol Manual
  1. Manuals
  2. Brands
  3. Lutron Electronics Manuals
  4. Computer Hardware
  5. HomeWorks
  6. Protocol manual
Lutron Electronics HomeWorks Protocol Manual

Lutron Electronics HomeWorks Protocol Manual

Rs232
Hide thumbs

Advertisement

Quick Links

Download this manual

Advertisement

loading
Need help?

Need help?

Do you have a question about the HomeWorks and is the answer not in the manual?

Questions and answers

Related Manuals for Lutron Electronics HomeWorks

Summary of Contents for Lutron Electronics HomeWorks

  • Page 2 RS-232 Command Set HomeWorks Interactive RS-232 Command Set Technical Specs Command Format Device Address Format Time Format Date Format Keypad Button Numbering Monitor Output Format Keypad button press Keypad button release Keypad button hold Keypad button double tap Keypad led states...
  • Page 3 RS-232 Command Set Dimmer Commands Actions Fade a system dimmer Raise a system dimmer Lower a system dimmer Stop a dimmer raise/lower Flash a system dimmer Stop dimmer flashing Dimmer button press Dimmer button double tap Requests Request dimmer level GRAFIK Eye Commands Actions Select GRAFIK Eye scene...
  • Page 4 RS-232 Command Set Pulse CCO relay Close CCO relay Open CCO relay Requests Request keypad enabled/disabled state Request keypad led states Request last button pressed on a keypad Sivoia Commands Actions Select Sivoia scene command Requests Request Sivoia scene command Time Clock Commands Actions Set system time...
  • Page 5 RS-232 Command Set Scene Saver Mode Commands Actions Begin scene saver mode Terminate scene saver mode Scene save on a keypad button Scene restore on a keypad button Requests Request scene save mode state Vacation Mode Commands Actions Vacation mode record Vacation mode playback Vacation mode disable Requests...
  • Page 6 RS-232 Command Set Monitoring Output Commands Actions Dimmer level/Sivoia scene monitoring on Dimmer level/Sivoia scene monitoring off Keypad/dimmer/Sivoia control button monitoring on Keypad/dimmer/Sivoia control button monitoring off Keypad led monitoring on Keypad led monitoring off GRAFIK Eye scene monitoring on GRAFIK Eye scene monitoring off System Commands Actions...
  • Page 7 RS-232 Command Set back to the top... http://www.lutron.com/hwi/Help/L232.htm (6 of 6) [7/3/03 1:19:37 PM]...

  • Page 8: Technical Specifications

    Technical Specifications Technical Specifications HomeWorks Interactive processors require the use of a standard 9-pin DB9 serial cable for communications with external equipment. This cable must be a 9-wire, straight through cable, not a 3-wire cable. The available baud rates are 9600, 19200, 38400, 57600, and 115,200 baud. When dip switch #1 on S2 is up the baud rate is...
  • Page 9 Technical Specifications Clear To Send (input) Request To Send (output) Ring Indicate (input) General Specifications The HWI processor connects to the serial port on a laptop using a standard DB-9 serial cable (all pins straight through) The default configuration for the HWI processor is to use hardware handshaking, which requires the pin connections as shown in the table above.
  • Page 10 SETBAUD SETBAUD Set RS-232 port baud rate Syntax SETBAUD, <baud rate> Processor Responds with one of the following For this change to take effect, you must cycle the processor power. For this change to take effect, you must first set dip switch #1 on S2 in the down position and then cycle the processor power.
  • Page 11 GETBAUD GETBAUD Get RS-232 port baud rate Syntax GETBAUD, <port address> Processor responds with the following RS232 port baud rate on port <port address> is <baud rate> Parameter Description Format port address (optional) the port address the request is pp:ll:aaa (see RS232 Port Addressing) This parameter is optional.
  • Page 12 Device Address Formatting Device Address Formatting Every physical device in the system (RPM zone, D48 zone, GRAFIK Eye, etc) has a system device address. Each device address is separated into 3-5 elements as shown in the tables below Device address elements are listed in the order shown, separated by a period, colon, slash, backslash or dash.
  • Page 13 Device Address Formatting 1-16 1-12 H48 Dimmer/Switch Processor Link Router (H48) Dimmer 1-16 RF Dimmer/Switch Processor Link Device Type Dimmer 1-16 1-64 RF Keypad Processor Link Device Type Keypad 1-16 1-32 RF Repeater Processor Link Device Type Repeater 1-16 Keypad/Sivoia Control/CCO/CCI/TEL-9 Processor Link Keypad...
  • Page 14 Device Address Formatting RS232 Port Processor Link Port 1-16 3 or 7 GRAFIK Eye Main Unit Processor Link GRAFIK Eye 1-16 GRAFIK Eye Main Unit Single Zone Processor Link GRAFIK Eye Output 1-16 http://www.lutron.com/hwi/Help/l232/device_addressing.htm (3 of 3) [7/3/03 1:19:40 PM]...
  • Page 15 SETHAND Set RS-232 port SETHAND handshaking type Syntax SETHAND, <handshaking> Processor Responds with one of the following No handshaking enabled Hardware handshaking enabled Parameter Description Format handshaking new RS-232 port handshaking you must select one of the type following handshaking types NONE, HW (Hardware) Description This command is used to specify the 232 port handshaking method to be used.
  • Page 16 GETHAND Get RS-232 port GETHAND handshaking type Syntax GETHAND, <port address> Processor responds with the following RS232 port handshaking on processor <port address> is <handshaking type> Parameter Description Format port address (optional) the port address the request is pp:ll:aaa (see RS232 Port Addressing) This parameter is optional.
  • Page 17 GETHAND See Also SETHAND - Set RS-232 port handshaking type http://www.lutron.com/hwi/Help/l232/gethand.htm (2 of 2) [7/3/03 1:19:40 PM]...
  • Page 18 Command Formatting Command Formatting All commands are in ASCII characters. Each command is made up of fields, seperated by commas, and terminated with a carriage return <CR> = $0D Hex. Spaces are ignored, allowing for visual formatting of commands Where letters are used, case is ignored Some commands allow parameters to be omitted, and a default value will be used.
  • Page 19 Time Formatting Time Formatting Times are used when entering fade or delay times, and for setting the internal processor clock When setting the system time, 24 hour format must be used When entering times the following formats may be used: HH:MM:SS MM:SS HH = Hours...
  • Page 20 Dates are used when setting the internal processor calendar The month and day must have 2 digits, and the year must have 4 digits HomeWorks Interactive is year 2000 compliant The following formats can be used for entering the date...
  • Page 21 Keypad Button Numbering Keypad Button Numbering HWI-KP5 HWI-KP10 HWI-KP15 http://www.lutron.com/hwi/Help/l232/diagrams.htm (1 of 6) [7/3/03 1:19:43 PM]...
  • Page 22 Keypad Button Numbering HWI-4SE-M HWI-8SE-M HWI-4SE-IR HWI-8SE-IR http://www.lutron.com/hwi/Help/l232/diagrams.htm (2 of 6) [7/3/03 1:19:43 PM]...
  • Page 23 Keypad Button Numbering HWI-2SE HWI-KP5-DN HWI-KP5-DW http://www.lutron.com/hwi/Help/l232/diagrams.htm (3 of 6) [7/3/03 1:19:43 PM]...
  • Page 24 Keypad Button Numbering HWI-KP-LB6 HWI-KP-LB9 HWI-2B http://www.lutron.com/hwi/Help/l232/diagrams.htm (4 of 6) [7/3/03 1:19:43 PM]...
  • Page 25 Keypad Button Numbering HWI-5S-IR HWI-5S-M SPACER HWI-5S-NM GRX-4/8-IT http://www.lutron.com/hwi/Help/l232/diagrams.htm (5 of 6) [7/3/03 1:19:43 PM]...
  • Page 26 Keypad Button Numbering HWI-CCI HWI-CCO HWI-TEL 9 http://www.lutron.com/hwi/Help/l232/diagrams.htm (6 of 6) [7/3/03 1:19:43 PM]...
  • Page 27 KBP_MON Keypad Button Press KBP Monitor String Monitor String Syntax KBP, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number that was pressed 1 - 24 Description The KBP monitor string is output from a processor when a keypad button is pressed Example...
  • Page 28 KBR_MON Keypad Button Release KBR Monitor String Monitor String Syntax KBR, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number that was released 1 - 24 Description The KBR monitor string is output from a processor when a keypad button is released Example...
  • Page 29 KBH_MON Keypad Button Hold KBH Monitor String Monitor String Syntax KBH, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number that was held 1 - 24 Description The KBH monitor string is output from a processor when a keypad button is held Example...
  • Page 30 KBDT_MON Keypad Button Double Tap KBDT Monitor String Monitor String Syntax KBDT, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button button number that was double tapped 1 - 24 number Description The KBDT monitor string is output from a processor when a keypad button is double tapped...
  • Page 31 KBMON Keypad/Dimmer/Sivoia Control KBMON Button Monitoring On Syntax KBMON Processor Responds Keypad button monitoring enabled Description Enables keypad button monitoring on this processor. When any keypad button in the system is pressed, a monitoring message will be output from this processor indicating which processor, link, keypad address and button was activated.
  • Page 32 KBMON Dimmer Button Double Tap Monitoring Output Format Sivoia Control Button Press Monitoring Output Format Sivoia Control Button Release Monitoring Output Format Sivoia Control Button Hold Monitoring Output Format Sivoia Control Button Double Tap Monitoring Output Format http://www.lutron.com/hwi/Help/l232/kbmon.htm (2 of 2) [7/3/03 1:19:45 PM]...
  • Page 33 KBMOFF Keypad/Dimmer/Sivoia Control KBMOFF Button Monitoring Off Syntax KBMOFF Processor Responds Keypad button monitoring disabled Description Disables keypad button monitoring on this processor. When a keypad button in the system is pressed, this processor will not send a monitor output string. Also disables dimmer button monitoring on this processor.
  • Page 34 KBMOFF Sivoia Control Button Hold Monitoring Output Format Sivoia Control Button Double Tap Monitoring Output Format http://www.lutron.com/hwi/Help/l232/kbmoff.htm (2 of 2) [7/3/03 1:19:46 PM]...
  • Page 35 Dimmer Button Press Monitor String Dimmer Button Press DBP Monitor String Monitor String Syntax DBP, <address>, <button number> Parameter Description Format address system address of the H48 or RF device address formatting dimmer/switch description button button number that was pressed number Description The DBP monitor string is output from a processor when the tap switch for an H48 or RF...
  • Page 36 Dimmer Button Release Monitor String Dimmer Button Release DBR Monitor String Monitor String Syntax DBR, <address>, <button number> Parameter Description Format address system address of the H48 dimmer/switch see device address formatting description button button number that was released number Description The DBP monitor string is output from a processor when the tap switch for an H48 dimmer/switch is released.
  • Page 37 Dimmer Button Hold Monitor String Dimmer Button Hold DBH Monitor String Monitor String Syntax DBH, <address>, <button number> Parameter Description Format address system address of the H48 dimmer/switch see device address formatting description button button number that was held number Description The DBH monitor string is output from a processor when the tap switch for an H48 dimmer/switch is held.
  • Page 38 Dimmer Button Double Tap Monitor String Dimmer Button Double Tap DBDT Monitor String Monitor String Syntax DBDT, <address>, <button number> Parameter Description Format address system address of the H48 or RF device address formatting dimmer/switch description button button number that was double tapped number Description The DBP monitor string is output from a processor when the tap switch for an H48...
  • Page 39 SVBP_MON SVBP Monitor Sivoia Control Button Press Monitor String String Syntax SVBP, <address>, <button number> Parameter Description Format address system address of the Sivoia control [processor : link : address] device address formatting description button number button number that was pressed 1 - 24 Description The SVBP monitor string is output from a processor when a Sivoia control button is pressed...
  • Page 40 SVBR_MON SVBR Monitor Sivoia Control Button Release Monitor String String Syntax SVBR, <address>, <button number> Parameter Description Format address system address of the Sivoia control [processor : link : address] device address formatting description button number button number that was released 1 - 24 Description The SVBR monitor string is output from a processor when a Sivoia control button is released.
  • Page 41 SVBH_MON SVBH Monitor Sivoia Control Button Hold Monitor String String Syntax SVBH, <address>, <button number> Parameter Description Format address system address of the Sivoia control [processor : link : address] device address formatting description button number button number that was held 1 - 24 Description The SVBH monitor string is output from a processor when a Sivoia control button is held...
  • Page 42 SVBDT_MON SVBDT Monitor Sivoia Control Button Double Tap Monitor String String Syntax SVBDT, <address>, <button number> Parameter Description Format address system address of the Sivoia control [processor : link : address] device address formatting description button button number that was double tapped 1 - 24 number Description The SVBDT monitor string is output from a processor when a Sivoia control button is double...
  • Page 43 SVS_MON SVS Monitor Sivoia Scene Command Monitor Output String String Syntax SVS, <address>, <scene command>, <status> Parameter Description Format address system address of Sivoia control that [processor : link : address] changed device address formatting description scene Sivoia scene command 1 = Preset 1 command 2 = Preset 2...
  • Page 44 SVS_MON SVS, [01:06:03], R, MOVING When the same Sivoia stops raising. SVS, [01:06:03], S, STOPPED See Also SVBP Monitor String SVBR Monitor String SVBH Monitor String SVBDT Monitor String KBMON - Keypad/Sivoia control button monitoring on KBMOFF - Keypad/Sivoia control button monitoring off http://www.lutron.com/hwi/Help/l232/svs_mon.htm (2 of 2) [7/3/03 1:19:50 PM]...
  • Page 45 KLS_MON KLS Monitor String Keypad LED Monitor String Syntax KLS, <address>, <led states> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description led states the current state of the keypad's LEDs The first digit is LED 1, the last digit is LED 0 = Off 1 = On 2 = Flash 1...
  • Page 46 KLMON Keypad LED Monitoring KLMON Syntax KLMON Processor Responds Keypad led monitoring enabled Description Enables keypad led monitoring on this processor. When any keypad led in the system changes state, a monitoring message will be output from this processor indicating which processor, link, interface, address, and its new led state Example Enable keypad led monitoring...
  • Page 47 KLMOFF Keypad LED Monitoring KLMOFF Syntax KLMOFF Processor Responds Keypad led monitoring disabled Description Disables keypad led monitoring on this processor. When any keypad led in the system changes state, this processor will not send an led monitor output string. Example Disable keypad led monitoring L232>...
  • Page 48 DL_MON Dimmer Level Monitor DL Monitor Output String Syntax DL, <address>, <level> Parameter Description Format address system address of zone that changed [processor : link : interface : module or bus : zone] device address formatting description level new level of the zone 0 - 100 (percent) Description The DL monitor string is output from a processor when any zone in the system changes level...
  • Page 49 DLMON Dimmer Level/Sivoia Scene DLMON Monitoring On Syntax DLMON Processor Responds Dimmer level monitoring enabled Description Enables dimmer level monitoring on this processor. When any dimmer in the system changes level, a monitoring message will be output from this processor indicating which processor, link, interface and address.
  • Page 50 DLMOFF Dimmer Level/Sivoia Scene DLMOFF Monitoring Off Syntax DLMOFF Processor Responds Dimmer level monitoring disabled Description Disables dimmer level monitoring on this processor. When a zone in the system changes levels, this processor will not send a monitor output string. Also disables Sivoia scene monitoring on this processor.
  • Page 51 GSS_MON GRAFIK Eye Scene Select GSS Monitor String Monitor Output String Syntax GSS, <address>, <scene number> Parameter Description Format address system address of GRAFIK Eye that [processor : link : address] changed device address formatting description scene scene number selected 0 - 16 number 0 = Off...
  • Page 52 GSMON GRAFIK Eye Scene GSMON Monitoring On Syntax GSMON Processor Responds GRAFIK Eye scene monitoring enabled Description Enables GRAFIK Eye scene monitoring on this processor. When any GRAFIK Eye in the system changes scenes, a monitoring message will be output from this processor indicating which processor, link, address and scene.
  • Page 53 GSMOFF GRAFIK Eye Scene GSMOFF Monitoring Off Syntax GSMOFF Processor Responds GRAFIK Eye scene monitoring disabled Description Disables GRAFIK Eye scene monitoring on this processor. When any GRAFIK Eye in the system changes scenes, this processor will not send a GRAFIK Eye scene monitoring output string.
  • Page 54 FADEDIM FADEDIM Fade a dimmer Syntax FADEDIM, <intensity>, <fade time>, <delay time>, <address 1>, ..., <address n> Parameter Description Format intensity target intensity for specified dimmer 0 - 100 (percent) fade time time for dimmers to fade from current HH:MM:SS intensity to target intensity example: 00:00:05 for 5 seconds time formatting...
  • Page 55 FADEDIM STOPDIM - Stop a dimmer raise/lower http://www.lutron.com/hwi/Help/l232/fadedim.htm (2 of 2) [7/3/03 1:19:54 PM]...
  • Page 56 FLASHDIM FLASHDIM Flash a dimmer Syntax FLASHDIM, <intensity>, <flash rate>, <address 1>, ..., <address n> Parameter Description Format intensity Intensity to flash the dimmers to 0 - 100 (percent) flash rate The amount of time the dimmers are HH:MM:SS on/off example: 00:00:05 for 5 seconds time formatting description...
  • Page 57 STOPFLASH STOPFLASH Stop flashing a dimmer Syntax STOPFLASH, <address 1>, ..., <address n> Parameter Description Format address system address of zones to fade [processor : link : address] maximum of 10 address per command device address formatting description Description Stops flashing one or more system zones Example Stop flashing processor 1, link1, MI address 0, RPM module 2, zone 3 L232>...
  • Page 58 RAISEDIM RAISEDIM Raise a dimmer Syntax RAISEDIM, <address 1>, ..., <address n> Parameter Description Format address system address of zones to fade [processor : link : address] maximum of 10 address per command device address formatting description Description Starts raising one or more system dimmers Example Start raising processor 1, link1, MI address 0, RPM module 2, zone 3 L232>...
  • Page 59 LOWERDIM LOWERDIM Lower a dimmer Syntax LOWERDIM, <address 1>, ..., <address n> Parameter Description Format address system address of zones to fade [processor : link : address] maximum of 10 address per command device address formatting description Description Starts lowering one or more system dimmers Example Start lowering processor 1, link1, MI address 0, RPM module 2, zone 3 L232>...
  • Page 60 STOPDIM STOPDIM Stop a dimmer raise/lower Syntax STOPDIM, <address 1>, ..., <address n> Parameter Description Format address system address of zones to fade [processor : link : address] maximum of 10 address per command device address formatting description Description Stops raising/lowering one or more system dimmers Example Stop raising/lowering processor 1, link1, MI address 0, RPM module 2, zone 3 L232>...
  • Page 61 Dimmer Button Press Dimmer Button Press Syntax DBP, <address>, <button number> Parameter Description Format address system address of the H48 or RF device address formatting dimmer/switch description button button number to press number Description Simulates the press action of the tap switch for an H48 or RF dimmer/switch. This will affect the local load and activate any keypad-like press programming.
  • Page 62 Dimmer Button Double Tap DBDT Dimmer Button Double Tap Syntax DBDT, <address>, <button number> Parameter Description Format address system address of the H48 or RF device address formatting dimmer/switch description button button number to double tap number Description Simulates the double tap action of the tap switch for an H48 or RF dimmer/switch. This will affect the local load and activate any keypad-like double tap programming.
  • Page 63 Request a Dimmer Level Syntax RDL, <address> Processor responds with DL, <address>, <level> Parameter Description Format address system address of zone to query [processor : link : interface : module or bus : zone] device address formatting description level current level of the queried zone 0 - 100 (percent) Description Returns the current or target level for any zone in the sysyem Example...
  • Page 64 FRPM FRPM Fade an RPM zone Syntax FRPM, <intensity>, <fade time>, <delay time>, <address 1>, ..., <address n> Parameter Description Format intensity target intensity for specified zones 0 - 100 (percent) fade time time for zones to fade from current HH:MM:SS intensity to target intensity example: 00:00:05 for 5 seconds...
  • Page 65 Fade a Vareo zone Syntax FV, <intensity>, <fade time>, <delay time>, <address 1>, ..., <address n> Parameter Description Format intensity target intensity for specified zones 0 - 100 (percent) fade time time for zones to fade from current HH:MM:SS intensity to target intensity example: 00:00:05 for 5 seconds time formatting description...
  • Page 66 GRAFIK Eye Scene Select Syntax GSS, <address>, <scene number> Parameter Description Format address system address of GRAFIK Eye to control [processor : link : address] device address formatting description scene scene number to select 0 - 16 number 0 = Off 1 - 16 = scene 1 - scene 16 Description Selects a scene on any GRAFIK Eye in the system...
  • Page 67 Request a GRAFIK Eye's current scene Syntax RGS, <address> Processor responds with GSS, <address>, <scene number> Parameter Description Format address system address of GRAFIK Eye to query [processor : link : address] device address formatting description 0 - 16 scene scene number selected on the GRAFIK 0 = Off number...
  • Page 68 Keypad Button Press Syntax KBP, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number to press 1 - 24 Description Simulates the press action of a keypad button. This does not simulate a true keypad button press that might include an immediate release.
  • Page 69 Keypad Button Release Syntax KBR, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number to release 1 - 24 Description Simulates the release action of a keypad button. Example Release button 1 on processor 1, link 4, keypad address 10 L232>...
  • Page 70 Keypad Button Hold Syntax KBH, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number to hold 1 - 24 Description Simulates the hold action of a keypad button. This does not simulate a true keypad button hold that will include a preceeding press Example Hold button 1 on processor 1, link 4, keypad address 10...
  • Page 71 KBDT KBDT Keypad Button Double Tap Syntax KBDT, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number to double tap 1 - 24 Description Simulates the double tap action of a keypad button.
  • Page 72 Keypad Enable Syntax KE, <address> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description Description Enable a keypad Example Enable processor 1, link 6, keypad 21 L232> KE, [1:6:21] See Also KD - Keypad disable RKES -Request keypad enabled state http://www.lutron.com/hwi/Help/l232/ke.htm [7/3/03 1:20:01 PM]...
  • Page 73 Keypad Disable Syntax KD, <address> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description Description Disables a keypad Example Disable processor 1, link 6, keypad 21 L232> KD, [1:6:21] See Also KE - Keypad enable RKES -Request keypad enabled state http://www.lutron.com/hwi/Help/l232/kd.htm [7/3/03 1:20:01 PM]...
  • Page 74 RKES Request Keypad Enabled RKES State Syntax RKES, <address> Processor responds with KES, <address>, <state> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description state the enabled/disabled state of the keypad Description Queries the system for the enabled/disabled state of a keypad Example...
  • Page 75 SETLED SETLED Set an LED State Syntax SETLED, <address>, <led number>, <led state> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description led number on the keypad 1 - 24 number The led number is the corresponding button number 0 = Off...
  • Page 76 RKLS Request a Keypad's LED RKLS States Syntax RKLS, <address> Processor Response KLS, <address>, <led states> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description The first digit is LED 1, the last digit is LED 0 = Off led states the current state of the keypad's LEDs 1 = On...
  • Page 77 SETLED Set the LED States for a SETLEDS Whole Keypad Syntax SETLEDS, <address>, <led states> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description 0 = Off 1 = On states to set some or all the LEDs led states 2 = Flash 1 LED #1 is the left most LED in the string...
  • Page 78 CCOPULSE CCOPULSE CCO Relay Pulse Syntax CCOPULSE, <address>, <relay number>, <pulse time> Parameter Description Format address system address of the CCO [processor : link : address] device address formatting description relay relay number to pulse 1 - 8 number 1 - 245 1 = 0.5 seconds 2 = 1.0 seconds pulse time pulse duration in 0.5 second increments...
  • Page 79 CCOCLOSE CCOCLOSE CCO Relay Close Syntax CCOCLOSE, <address>, <relay number> Parameter Description Format address system address of the CCO [processor : link : address] device address formatting description relay number relay number to close 1 - 8 Description Closes a specific CCO relay Note - The processor does not verify that the given address is ACTUALLY a CCO address.
  • Page 80 CCOOPEN CCOOPEN CCO Relay Open Syntax CCOOPEN, <address>, <relay number> Parameter Description Format address system address of the CCO [processor : link : address] device address formatting description relay number relay number to open 1 - 8 Description Opens a specific CCO relay Note - The processor does not verify that the given address is ACTUALLY a CCO address.
  • Page 81 RKLBP Request Keypad Last RKLBP Button Press Syntax RKLBP, <address> Processor responds KLBP, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button the last button pressed on the specified 1-24 number keypad...
  • Page 82 SVSS Sivoia Scene Command SVSS Select Syntax SVSS, <address>, <scene command>, <delay time> Parameter Description Format address system address of Sivoia control [processor : link : address] device address formatting description scene Sivoia scene command to select 1 = Preset 1 command 2 = Preset 2 3 = Preset 3...
  • Page 83 RSVS Request a Sivoia's Current RSVS Scene Command Syntax RSVS, <address> Processor responds with SVS, <address>, <scene command>, <status> Parameter Description Format address system address of Sivoia control to query [processor : link : address] device address formatting description 1 = Preset 1 2 = Preset 2 3 = Preset 3 scene...
  • Page 84 Set Time Syntax ST, <time> Processor Responds Processor Time: <time> Parameter Description Format time current time of day in 24 hour format HH:MM:SS in 24 Hour format time address formatting description the seconds must be specified Description Sets the system time. This will update the time on all processors in the system. Example Set the time to 2:34 PM L232>...
  • Page 85 Request System Time Syntax Processor Responds Processor Time: <time> Description Queries the current system time Example Request the system time L232> RST Processor Time: 12:00 See Also ST - Set system time SD - Set system date RSD - Request system date http://www.lutron.com/hwi/Help/l232/rst.htm [7/3/03 1:20:05 PM]...
  • Page 86 Set Date Syntax SD, <date> Processor Responds Processor Date: <date> Parameter Description Format date current date MM/DD/YYYY date formatting description Description Sets the system date. This will update the date on all processors in the system. Example Set the date to March 10, 1999 L232>...
  • Page 87 Request System Date Syntax Processor Responds Processor Date: <day of week> <date> Description Queries the current system date Example Request the system date L232> RSD Processor Date: Wednesday 03/10/1999 See Also SD - Set system date ST - Set system time RST - Request system time http://www.lutron.com/hwi/Help/l232/rsd.htm [7/3/03 1:20:06 PM]...
  • Page 88 Timeclock Enable Syntax Processor Responds TCE: Timeclock Enabled Description Enables the system timeclock Example Enable the system timeclock L232> TCE TCE: Timeclock Enabled See Also TCD - Timeclock disable TCS - Timeclock state http://www.lutron.com/hwi/Help/l232/tce.htm [7/3/03 1:20:06 PM]...
  • Page 89 Timeclock Disable Syntax Processor Responds TCD: Timeclock Disabled Description Disables the system timeclock Example Disable the system timeclock L232> TCD TCD: Timeclock Disabled See Also TCE - Timeclock enable TCS - Timeclock state http://www.lutron.com/hwi/Help/l232/tcd.htm [7/3/03 1:20:07 PM]...
  • Page 90 Timeclock State Syntax Processor Responds with one of the following TCS: Timeclock Enabled TCS: Timeclock Disabled Description Queries the system for the timeclock state Example Query the system timeclock state L232> TCS TCS: Timeclock Enabled See Also TCE - Timeclock enable TCD - Timeclock disable http://www.lutron.com/hwi/Help/l232/tcs.htm [7/3/03 1:20:07 PM]...
  • Page 91 RST2 Request System Time with RST2 seconds Syntax RST2 Processor Responds Processor Time: <time> Description Queries the current system time (including seconds) Example Request the system time L232> RST Processor Time: 12:00:00 See Also ST - Set system time SD - Set system date RST - Request system time RSD - Request system date http://www.lutron.com/hwi/Help/l232/rst2.htm [7/3/03 1:20:07 PM]...
  • Page 92 SUNRISE SUNRISE Today's sunrise time Syntax SUNRISE Processor Responds with Today's Sunrise: <time> Description Returns the sunrise time for the current day. This can be useful when testing astronomic timeclock events. Example Request today's sunrise time L232> SUNRISE Today's Sunrise: 06:52 See Also SUNSET - Today's sunset time ST - Set system time...
  • Page 93 SUNSET SUNSET Today's sunset time Syntax SUNSET Processor Responds with Today's Sunset: <time> Description Returns the sunset time for the current day. This can be useful when testing astronomic timeclock events. Example Request today's sunset time L232> SUNSET Today's Sunset: 06:52 See Also SUNRISE - Today's sunrise time ST - Set system time...
  • Page 94 Scene Saver Mode Begin Syntax SSB, <timeout> Parameter Description Format timeout number of minutes scene saver mode will be CONT = continuous (no timeout) running 0 = 1 minute 1-1440 Processor Responds Scene Saver Mode Begin Description Begins scene saver mode with the specified timeout Example Begin scene saver mode without a timeout L232>...
  • Page 95 Scene Saver Mode Terminate Syntax Processor Responds Scene Saver Mode Terminated Description Terminates scene saver mode Example Terminate scene saver mode L232> SST Scene Saver Mode Terminated See Also SSB - Scene saver mode begin SSS - Request scene saver mode state KBSS - Keypad button scene save KBSR - Keypad button scene restore http://www.lutron.com/hwi/Help/l232/sst.htm [7/3/03 1:20:09 PM]...
  • Page 96 Scene Saver Mode State Syntax Processor Responds with one of the following Scene Saver Mode is Running Scene Saver Mode is Stopped Description Queries the system for the scene saver mode state Example Query the scene saver mode state L232> SSS Scene Saver Mode is Running See Also SSB - Scene saver mode begin...
  • Page 97 KBSS KBSS Keypad Button Scene Save Syntax KBSS, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number to scene save 1 - 24 Processor Responds Preset Saved Description Scene save the current levels of the preset on the button that has scene saver option checked.
  • Page 98 KBSR Keypad Button Scene Restore KBSR Syntax KBSR, <address>, <button number> Parameter Description Format address system address of the keypad [processor : link : address] device address formatting description button number button number to scene save 1 - 24 Processor Responds Preset Restored Description Restore the preset on the button that has scene saver option checked back to the levels of the uploaded preset.
  • Page 99 Vacation Mode Record Syntax Processor Responds Vacation mode recording Description Begins recording vacation mode data Example Begin vacation mode recording L232> VMR Vacation mode recording See Also VMP - Vacation mode playback VMD - Vacation mode disable VMS - Vacation mode state http://www.lutron.com/hwi/Help/l232/vmr.htm [7/3/03 1:20:10 PM]...
  • Page 100 Vacation Mode Playback Syntax Processor Responds Vacation mode playing Description Begins playback of vacation mode data Example Begin vacation mode playback L232> VMP Vacation mode playing See Also VMR - Vacation mode record VMD - Vacation mode disable VMS - Vacation mode state http://www.lutron.com/hwi/Help/l232/vmp.htm [7/3/03 1:20:10 PM]...
  • Page 101 Vacation Mode Disable Syntax Processor Responds Vacation mode disabled Description Stops vacation mode recording or playback Example Stop vacation mode recording or playback L232> VMD Vacation mode disabled See Also VMP - Vacation mode playback VMR - Vacation mode record VMS - Vacation mode state http://www.lutron.com/hwi/Help/l232/vmd.htm [7/3/03 1:20:11 PM]...
  • Page 102 Vacation Mode State Syntax Processor Responds with one of the following Vacation mode recording Vacation mode playing Vacation mode disabled Description Queries the system for the vacation mode state Example Query the vacation mode state L232> VMS Vacation mode recording See Also VMR - Vacation mode record VMP - Vacation mode playback...
  • Page 103 Security Mode Begin Syntax Processor Responds Security mode begin Description Begins security mode Example Begin security mode L232> SMB Security mode begin See Also SMT - Security mode terminate SMS - Security mode state http://www.lutron.com/hwi/Help/l232/smb.htm [7/3/03 1:20:11 PM]...
  • Page 104 Security Mode Terminate Syntax Processor Responds Security mode terminated Description Terminates security mode Example Terminate security mode L232> SMT Security mode terminated See Also SMB - Security mode begin SMS - Security mode status http://www.lutron.com/hwi/Help/l232/smt.htm [7/3/03 1:20:12 PM]...
  • Page 105 Security Mode State Syntax Processor Responds with one of the following Security mode active Security mode terminated Description Queries the system for the security mode state Example Query the security mode state L232> SMS Security mode active See Also SMB - Security mode begin SMT - Security mode terminate http://www.lutron.com/hwi/Help/l232/sms.htm [7/3/03 1:20:12 PM]...
  • Page 106 LOGIN LOGIN Login to the system Syntax LOGIN, <password>, <port address> Processor Responds with one of the following Processor <processor address> logging in RS232 ports Processor <processor address> RS232 ports logged in Logging in RS232 port <port address> RS232 port <port address> already logged in Missing or incorrect password.
  • Page 107 LOGIN Processor 3 logging in RS232 ports Example Login port 7 of processor 2 in a system with password "lutron" L232> LOGIN, lutron, 2:7:1 Logging in RS232 port 02:07:001 See Also LOGOUT - Logout of the system http://www.lutron.com/hwi/Help/l232/login.htm (2 of 2) [7/3/03 1:20:13 PM]...
  • Page 108 LOGOUT LOGOUT Logout of the system Syntax LOGOUT, <port address> Processor Responds with one of the following Processor <processor address> logging out RS232 ports Processor <processor address> lRS232 ports logged out Logging out RS232 port <port address> RS232 port <port address> logged out Parameter Description Format...
  • Page 109 LOGOUT Logging out RS232 port 02:07:001 Example Logout all RS232 ports on processor connected to L232> LOGOUT, PROC Processor 1 logging out RS232 ports Example Logout all RS232 ports in the system with processors 1, 2 and 3 present L232> LOGOUT, ALL Processor 1 logging out RS232 ports Processor 2 logging out RS232 ports Processor 3 logging out RS232 ports...
  • Page 110 PROMPTOFF PROMPTOFF Turn off the L232> Prompt Syntax PROMPTOFF Description When the L232> prompt is turned off, a new L232> will not be printed after each command execution. This can be useful when communicating with external A/V systems that would just ignore the prompt.
  • Page 111 PROMPTON PROMPTON Turn on the L232> Prompt Syntax PROMPTON Description Re-enables the L232> prompt. After every command execution, a new L232> prompt will be issued. Example Turn the L232> prompt on. PROMPTON L232> See Also PROMPTOFF - Turn the L232> prompt off http://www.lutron.com/hwi/Help/l232/prompton.htm [7/3/03 1:20:14 PM]...
  • Page 112 When the terminal screen is active in the programming tool, all terminal screen activity is logged to a file called cpu.log located in the /log directory under the HomeWorks Interactive directory. To access this file you must exit the programming screen (go to the floorplan for example);...
  • Page 113 PROCADDR PROCADDR Processor Address Syntax PROCADDR Processor Responds with Processor Addresss : <address> Parameter Description Format address the address of the processor 1 - 16 that received the command Description Returns the address of the processor that received the command Example Request the processor address L232>...
  • Page 114 This command is used to reset all RS-232 port settings to the serial driver settings assigned to that port using the HomeWorks Interactive software. The settings effected are baud rate, handshaking type, number of data bits, parity type, number of stop bits, and the status of HomeWorks monitoring messages.
  • Page 115 OSREV OSREV Request O/S revision Syntax OSREV Processor responds with the following for each processor in the system Processor <processor address> O/S Rev = <O/S Rev> Parameter Description Format processor address The processor address 1-16 O/S Rev Revision number of the currently installed O/S 1-100 Description Returns the O/S revision for all processors in the system...
  • Page 116 HELP HELP L232 Command Help Syntax HELP HELP,<command name> Description Typing HELP by itself will print a list of the currently available L232 commands with brief descriptions. To get command specific help, use the HELP,<command name> syntax Example Request help for the Keypad Button Press command L232>...
  • Page 117 Revision History L232 Help Revision History v5 5-07-99 OS Rev 18 Added the following conmmands to this help document: SMB, SMT, SMS Added the keypad button numbering page v4 4-15-99 OS Rev 18 Added the following conmmands FADEDIM, RAISEDIM, LOWERDIM, STOPDIM, FLASHDIM, STOPFLASH, SETHAND Made the time formatting more flexible Updated HELP command page...