Lutron Electronics HomeWorks User manual

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
●Dimmer button press
●Dimmer button release
●Dimmer button hold
●Dimmer button double tap
●Dimmer level change
●GRAFIK Eye scene select
●Sivoia scene command change
●Sivoia control button press
●Sivoia control button release
●Sivoia control button hold
●Sivoia control button double tap
http://www.lutron.com/hwi/Help/L232.htm (1 of 6) [7/3/03 1:19:37 PM]

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
Requests
●Request GRAFIK Eye scene
Keypad Commands
Actions
●Keypad button press
●Keypad button release
●Keypad button hold
●Keypad button double tap
●Keypad enable
●Keypad disable
●Set keypad led state
●Set led states for a whole keypad
http://www.lutron.com/hwi/Help/L232.htm (2 of 6) [7/3/03 1:19:37 PM]

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
●Set system date
●Time clock enable
●Time clock disable
Requests
●Request system time
●Request system time with seconds
●Request system date
●Request time clock state
●Request today's sunrise time
●Request today's sunset time
http://www.lutron.com/hwi/Help/L232.htm (3 of 6) [7/3/03 1:19:37 PM]

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
●Vacation mode state request
Security Mode Commands
Actions
●Security mode begin
●Security mode terminate
Requests
●Security mode state request
http://www.lutron.com/hwi/Help/L232.htm (4 of 6) [7/3/03 1:19:37 PM]

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
●Login to system
●Logout of system
●Turn L232> prompt off
●Turn L232> prompt on
●Set RS-232 port baud rate
●Print system event log
●Set RS-232 port handshaking type
Requests
●Request processor address
●Request RS-232 port baud rate
●Request RS-232 port handshaking type
●Reset RS-232 port parameters to serial driver settings
●Request system processor O/S revisions
●Help
Revision History
http://www.lutron.com/hwi/Help/L232.htm (5 of 6) [7/3/03 1:19:37 PM]

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]

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
9600 baud, and when it is down the baud rate is set to the user setting according to the SETBAUD command
●The HomeWorks Interactive processors use hardware handshaking for flow control by default. Software handshaking will not
work. The hardware handshaking may be disabled using the SETHAND command. If hardware handshaking is disabled, Lutron
recommends using a low baud rate to avoid buffer overflow problems.
●Other communication settings include, 8 data bits, 1 stop bit, and no parity bit
HWI Pin
Number HWI Pin Name Description for HWI Processor Required for Hardware Handshaking Required for Simple Communications (hardware
handshaking disabled)
1 DCD Data Carrier Detect (input)
2 TX Transmit Data (output) X X
3 RX Receive Data (input) X X
4 DSR Data Set Ready (input) X
5 GND Ground X X
6 DTR Data Terminal Ready (output) X
http://www.lutron.com/hwi/Help/l232/technical_specs.htm (1 of 2) [7/3/03 1:19:38 PM]

Technical Specifications
7 CTS Clear To Send (input) X
8 RTS Request To Send (output) X
9 RI 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. The SETHAND command can be used to disable hardware handshaking if needed.
●When hardware handshaking is used, communications with the HWI processor will be reliable up to 115200 bps. (Note: Some
older laptops cannot communicate reliably at 115200 bps)
●The DTR output from the HWI processor is used by the HWI programming software. It indicates to the software that the
processor is powered and ready for communications. This line is optional, and the DTR check can be disabled in the HWI
programming software. Contact Lutron for more information.
●The DSR input to the HWI processor is used to determine if an external device is controlling the handshaking lines. The DSR
line must be asserted for the hardware handshaking to work properly. If the DSR line is unasserted while hardware handshaking
is enabled, the processor will ignore the CTS input and always transmit characters.
●All communications lines indicated in the Hardware Handshaking column are required when connecting a modem to an HWI
processor.
Using Simple 3-Wire Communications
●If hardware handshaking communications lines are not available on the external serial device, it is possible to communicate to
the HWI processor using a simple 3-wire interface. The pins required are shown in the table above.
●The hardware handshaking should be disabled on the processor using the SETHAND command.
●In this configuration, the HWI processor will be unable to tell the external equipment to stop sending data, and the external
equipment will be unable to tell the HWI processor to stop sending data. This can result in buffer overruns if the communications
rates are too high.
●Care must be taken to understand the amount of data being sent to/from the HWI processor using the 3-wire interface.
Unnecessary monitoring messages should be disabled on the HWI processor to minimize communications.
●Lutron does not recommend using the simple 3-wire interface to connect to external equipment that may send continuous data
at a high data rate, or if your external equipment cannot process a continuous stream of monitoring output from the HWI
processor.
●The 3-wire interface cannot be used to connect a modem to an HWI processor.
http://www.lutron.com/hwi/Help/l232/technical_specs.htm (2 of 2) [7/3/03 1:19:38 PM]

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.
Parameter Description Format
baud rate new RS-232 port baud rate you must select one of the
following baud rates
300, 600, 1200, 2400, 4800,
9600, 19200, 38400, 57600,
115200
Description
When dip switch #1 on S2 is in the up position, the processor RS232 port baud rate is fixed at
9600 baud. When dip switch #1 on S2 is in the down position, the
processor RS232 port baud rate will be set to the user setting determined by the SETBAUD
command. When the SETBAUD command is issued, the processor power must be cycled for
the change to take effect. This will allow laptops that have problems communicating at 115200
baud to use an intermediate baud rate that is faster than 9600 baud in order to minimize
download times. Also, with dip switch #1 on S2 set to the up position, the processor can be set
to a known baud rate (9600 baud), ensuring reliable communications. This adjustable baud rate
also provides greater flexibility when connecting to external A/V equipment.
Example
Set RS-232 port baud rate to 57600 bps
L232> SETBAUD, 57600
For this change to take effect, you must cycle the processor power.
See Also
GETBAUD - Request the RS-232 port baud rate
http://www.lutron.com/hwi/Help/l232/setbaud.htm [7/3/03 1:19:39 PM]

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
for pp:ll:aaa (see RS232 Port
Addressing) This parameter is
optional. If omitted, the
request will default to the port
that receives the command
baud rate the RS-232 port baud rate
the processor will respond
with one of the following
300, 600, 1200, 2400, 4800,
9600, 19200, 38400, 57600,
115200
Description
Requests the RS-232 port baud rate setting for an RS232 port in the system.
Example
Get RS-232 port baud rate for the port you are connected to
L232> GETBAUD
RS232 port baud rate on port 01:03:001 is 115200
Example
Get RS-232 port baud rate for link 7 on processor 2
L232> GETBAUD, 2:7:1
RS232 port baud rate on port 02:07:001 is 115200
See Also
SETBAUD - Set RS-232 port baud rate
http://www.lutron.com/hwi/Help/l232/getbaud.htm [7/3/03 1:19:39 PM]

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.
●The entire device address may be enclosed in [brackets] if desired.
●All letters and spaces in the address are ignored and may be used to improve readability
●Examples of device address formats for Processor 1, Link 1, Module Interface Address 3, RPM Module
2, RPM zone 4
[01:01:03:02:04]
1:1:3:2:4
1.1.3.2.4
1/1/3/2/4
[proc 1 : link 1 : mi 3 : module 2 : zone 4]
RPM Dimmer/Switch
Processor Link Router (MI) Module Output
1-16 1 0-15 1-8 1-4
D48 Dimmer/Switch
Processor Link Router (D48) Bus Dimmer
http://www.lutron.com/hwi/Help/l232/device_addressing.htm (1 of 3) [7/3/03 1:19:40 PM]

Device Address Formatting
1-16 4-6 1-4 1-12 1-4
H48 Dimmer/Switch
Processor Link Router (H48) Bus Dimmer
1-16 4-6 1-4 1-6 1-8
RF Dimmer/Switch
Processor Link Device Type Dimmer
1-16 811-64
RF Keypad
Processor Link Device Type Keypad
1-16 821-32
RF Repeater
Processor Link Device Type Repeater
1-16 831-4
Keypad/Sivoia Control/CCO/CCI/TEL-9
Processor Link Keypad
1-16 4-6 1-32
http://www.lutron.com/hwi/Help/l232/device_addressing.htm (2 of 3) [7/3/03 1:19:40 PM]

Device Address Formatting
RS232 Port
Processor Link Port
1-16 3 or 7 1
GRAFIK Eye Main Unit
Processor Link GRAFIK Eye
1-16 4-6 1-8
GRAFIK Eye Main Unit Single Zone
Processor Link GRAFIK Eye Output
1-16 4-6 1-8 1-8
http://www.lutron.com/hwi/Help/l232/device_addressing.htm (3 of 3) [7/3/03 1:19:40 PM]

SETHAND
SETHAND Set RS-232 port
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
type you must select one of the following handshaking types
NONE, HW (Hardware)
Description
This command is used to specify the 232 port handshaking method to be used. When set to
NONE, the HWI processor will ignore the CTS input, and always transmit data. When set to
HW (hardware), the HWI processor will only transmit characters if the CTS input is low.
Example
Set RS-232 port handshaking to NONE
L232> SETHAND, NONE
No handshaking enabled
See Also
GETHAND - Request RS-232 port handshaking type
http://www.lutron.com/hwi/Help/l232/sethand.htm [7/3/03 1:19:40 PM]

GETHAND
GETHAND Get RS-232 port
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
for pp:ll:aaa (see RS232 Port
Addressing) This parameter is
optional. If omitted, the
request will default to the
processor that receives the
command
handshaking type the RS-232 port handshaking
type The processor will respond with one of the following
handshaking types
None, Hardware Handshaking
Description
This command is used to request the handshaking method being used on an RS232 port.
Example
Get RS-232 port handshaking for the port you are connected to
L232> GETHAND
RS232 port handshaking on port 01:03:001 is Hardware Handshaking
Example
Get RS-232 port handshaking for link 7 on processor 2
L232> GETHAND, 2:7:1
RS232 port handshaking on port 02:06:001 is None
http://www.lutron.com/hwi/Help/l232/gethand.htm (1 of 2) [7/3/03 1:19:40 PM]

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]

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. In this case, the
delimiting commas must still be used
●There is a limit of 255 characters per command.
http://www.lutron.com/hwi/Help/l232/command_formatting.htm [7/3/03 1:19:41 PM]

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 SS
HH = Hours
MM = Minutes MM = Minutes
SS = Seconds SS = Seconds SS = Seconds
●Examples
4:23 AM = 04:23:00
3:15 PM = 15:15:00
4 sec fade time = 00:00:04 or 00:04 or 4
1 minute delay time = 00:01:00 or 1:00
http://www.lutron.com/hwi/Help/l232/time_formatting.htm [7/3/03 1:19:41 PM]

Date Formatting
Date Formatting
●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
MM / DD / YYYY
MM \ DD \ YYYY
MM - DD - YYYY
MM = Month
DD = Day of month
YYYY = Year
●Example
January 10, 1999 = 01/10/1999
http://www.lutron.com/hwi/Help/l232/date_formatting.htm [7/3/03 1:19:41 PM]