5.0 RS-232 COMMANDS 5.1 Normal Mode Commands

Add to my manuals
127 Pages

advertisement

5.0 RS-232 COMMANDS 5.1 Normal Mode Commands | Manualzz

5.0 RS-232 COMMANDS

5.1 Normal Mode Commands

(L232>)

5.1.1 Spec and Formatting

5.1.2 Monitor Output

5.1.3 Device Commands

5.1.4 System Commands

5.2 Boot Mode Commands

(>)

5.2.1 Spec and Formatting

5.2.2 System Commands

5.1 Normal Mode Commands

Contents

5.1.1 Specs and Formatting

5.1.2 Monitoring Output

5.1.3 Device Commands

5.1.4 System Commands

5.1.1 Specs and Formatting

Technical Specs

Command Format

Device Address Format

Time Format

Date Format

Keypad Button Numbering

5.1.2 Monitoring Output

Level / State Changes

Commands: Dimmer Level/Sivoia State Monitoring On

Dimmer Level/Sivoia State Monitoring Off

Format:

Dimmer Level Monitor String

Sivoia State Monitor String

GRAFIK Eye Scene Changes

Commands: GRAFIK Eye Scene Monitoring On

GRAFIK Eye Scene Monitoring Off

Format:

GRAFIK Eye Scene Select Monitor String

Button Events

Commands: Keypad/Dimmer/Sivoia Control Button Monitoring On

Keypad/Dimmer/Sivoia Control Button Monitoring Off

Format:

Keypad Button Press Monitor String

Keypad Button Release Monitor String

Keypad Button Hold Monitor String

Keypad Button Double Tap Monitor String

Sivoia Control Button Press Monitor String

Sivoia Control Button Release Monitor String

Sivoia Control Button Hold Monitor String

Sivoia Control Button Double Tap Monitor String

Dimmer Button Press Monitor String

Dimmer Button Release Monitor String

Dimmer Button Hold Monitor String

Dimmer Button Double Tap Monitor String

LED State Changes

Commands: Keypad LED Monitoring On

Keypad LED Monitoring Off

Format:

Keypad LED Monitor String

5.1.3 Device Commands

Keypad

Actions:

Keypad Button Press

Keypad Button Release

Keypad Button Hold

Keypad Button Double Tap

Keypad Enable

Keypad Disable

Set One Keypad LED State

Set Keypad LED States

CCO Relay Pulse

CCO Relay Close

CCO Relay Open

Request Keypad LED States

Request Keypad Last Button Pressed

Dimmer

Actions:

Fade a HomeWorks Dimmer

Raise a HomeWorks Dimmer

Lower a HomeWorks Dimmer

Stop a Raising/Lowering HomeWorks Dimmer

Flash a HomeWorks Dimmer

Stop a Flashing HomeWorks Dimmer

Dimmer Button Press

Dimmer Button Double Tap

Requests:

Sivoia

Actions:

Select Sivoia State

GRAFIK Eye

Actions:

Select GRAFIK Eye Scene

5.1.4 System Commands

Time Clock

Actions:

Set system time

Set system date

Time clock enable

Time clock disable

Requests:

Request system time with seconds

Request system date

Request time clock state

Request today's sunrise time

Request today's sunset time

Scene Saver Mode

Actions:

Begin scene saver mode

Terminate scene saver mode

Scene save on a keypad button

Scene restore on a keypad button

Vacation Mode

Actions:

Vacation mode record

Vacation mode playback

Vacation mode disable

Security Mode

Actions:

Security mode begin

Security mode terminate

System

Actions:

Login to system

Logout of system

Turn L232> prompt off

Turn L232> prompt on

Set RS-232 port baud rate

Set RS-232 port handshaking type

Reset RS-232 port parameters to serial driver settings

Send Database to All RF Devices

Send Database to All RF Devices with Errors

Send Database to One RF Device

Clear Processor Memory (cleanmem)

Put Processor into Boot Mode

Put Processor into OS Mode

Request RS-232 port baud rate

Request RS-232 port handshaking type

Request system processor O/S revisions

Request RF Devices with Errors

Help

Ethernet

Actions:

Set IP Address of Processor

Set Gateway Address of Processor

Set Subnet Mask of Processor

Set FTP Port of Processor

Set Telnet Port of Processor

Clear Current TCP/IP Settings

Back to top

Technical Specifications

RS232 Port

Female DB-9 Pinout on

HomeWorks Processor

Pin

7

8

5

6

9

3

4

1

2

Pin

Name

DCD

TXD

RXD

DSR

GND

DTR

CTS

RTS

RI

Description for

Processor

Data Carrier Detect (input)

Transmit Data (output)

1

Receive Data (input)

1

Data Set Ready (input)

Ground

Data Terminal Ready (output)

Clear To Send (input)

Ready To Send (output)

Ring Indicate (input)

1. Hardware handshaking disabled for

simple communications

Required for

Hardware

Handshaking

X

X

X

X

X

X

X

Required for

Simple

Communications

X

X

X

HomeWorks 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 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

General RS232 Specifications

The HomeWorks 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 HomeWorks 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 HomeWorks processor will be reliable up to 115200 bps. (Note: Some older laptops cannot communicate reliably at 115200 bps)

The DTR output from the HomeWorks processor is used by the HomeWorks 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 HomeWorks programming software. Contact Lutron for more information.

The DSR input to the HomeWorks 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 HomeWorks 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

HomeWorks 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 HomeWorks processor will be unable to tell the external equipment to stop sending data, and the external equipment will be unable to tell the HomeWorks 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 HomeWorks processor using the 3-wire interface.

Unnecessary monitoring messages should be disabled on the HomeWorks 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 HomeWorks processor.

The 3-wire interface cannot be used to connect a modem to an HomeWorks processor.

Ethernet Port

Female RJ45 Pinout on

HomeWorks Processor

Pin

6

7

4

5

8

1

2

3

Processor

Transmit +Ve

Transmit -Ve

Receive +Ve

No Connection

No Connection

Receive -Ve

No Connection

No Connection

Ethernet Hub / Switch

Receive +Ve

Receive -Ve

Transmit +Ve

No Connection

No Connection

Transmit -Ve

No Connection

No Connection

A crossover cable is used when connecting the processor directly to a laptop or other non-hub device.

General Ethernet Specifications

Configuring the HomeWorks

®

P5 processor to communicate over a network takes not only knowledge of the HomeWorks system, but of networking as well. HomeWorks installers with limited networking knowledge are advised to contact a networking professional before attempting to connect to HomeWorks processors via a network. This specification will help a HomeWorks installer communicate the P5 processor configurations to a network professional.

The HomeWorks installer will make any necessary changes to the P5 processor and the network professional can make any necessary changes to the networking equipment. Use the worksheet at the end of this document to record the P5 processor configuration(s).

This specification applies to version 1.22 (non-beta) or newer of the HomeWorks Illumination

TM

software.

Single Ethernet Port

• IEEE

®

802.3 Auto-Sensing 10BaseT / 100BaseTX

• Female 8P8C “Computer RJ-45” socket

• Green Connect LED, Amber Activity LED

• Use Cat 5 cabling or better

Protocols Used

• TCP, UDP, IP, ARP, DHCP, ICMP, TELNET, FTP, NBNS

TCP/IP Settings

• DHCP or static* configuration <factory default = DHCP>

• IP Address*: <static or dynamic configuration>

• Subnet Mask*: < static or dynamic configuration>

• Gateway*: <static or dynamic configuration>

• Telnet Port: <factory default = 23>

• FTP Port: <factory default = 21>

• HTTP Port: <factory default = 80>

• Ping Response: Enabled <factory default = Enabled, can be Disabled>

• NetBIOS Name: <factory fixed to = HOMEWORKS>

• NetBIOS Name is case insensitive

* If DHCP is set to Disabled, the following are the default values:

IP Address: 192.168.250.<processor address = 1 through 16>

Subnet: 255.255.255.0

Gateway: 0.0.0.0

Command Formatting

All commands are available to both RS232 and Ethernet, unless otherwise noted.

All commands are in ASCII characters.

All commands are typed after the command prompt: L232> for RS232, LNET> for Ethernet, > for BOOT Mode.

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.

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]

Remote Power Module (RPM) Zone

Processor

1-16

Processor

1-16

Processor

1-16

Processor

1-16

Processor

1-16

Processor

1-16

Link

1

Link

4-6

Link

4-6

Router (MI)

0-15

D48 Dimmer/Switch

Router (D48)

1-4

H48 Dimmer/Switch

Module

1-8

Bus

1-12

Link

8

Router (H48)

1-4

RF Dimmer/Switch

Device Type

1

Bus

1-6

Link

8

RF Keypad

Device Type

2

RF Repeater

Link

8

Device Type

3

Keypad/Sivoia Control/CCO/CCI/TEL-9

Dimmer

1-64

Keypad

1-32

Repeater

1-4

Output

1-4

Dimmer

1-4

Dimmer

1-8

Processor

1-16

Link

4-6

Keypad

1-32

Processor

1-16

Processor

1-16

Processor

1-16

Processor

1-16

RS232 Port

Link

3 or 7

Port

1

GRAFIK Eye Main Unit

Link

4-6

GRAFIK Eye Single Zone

GRAFIK Eye

1-8

Link

4-6

GRAFIK Eye

1-8

Wallbox Power Module (WPM) Zone

Link

4-6

WPM

1-8

Output

1-8

Output

1-6

Time Formatting

z z z

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

SS = Seconds

MM = Minutes

SS = Seconds SS = Seconds z

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

MM / DD / YYYY

MM \ DD \ YYYY

MM - DD - YYYY z

Example

January 10, 1999 = 01/10/1999

Date Formatting

z z z z

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 Illumination is year 2000 compliant

The following formats can be used for entering the date

MM = Month

DD = Day of month

YYYY = Year

Keypad Button Numbering

HWI-KP5 HWI-KP10

HWI-KP15

HWI-4SE-M HWI-8SE-M

HWI-4SE-IR HWI-8SE-IR

HWI-2SE

H W -I K P 5 D N H W -I K P 5 D W

H W -I K P L B 6 H W -I K P L B 9

HWI-2B

H W -I 5 S IR H W -I 5 S M

HWI-5S-NM

G R X 4 / 8 IT S P A C E R

H W -I C C O H W -I C C I

HWI-TEL 9

DLMON

Dimmer Level/Sivoia State 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.

Also enables Sivoia state monitoring on this processor. When any Sivoia MDU or Sivoia QED in the system changes state, a monitoring message will be output from this processor indicating which processor, link and Sivoia control address.

Example

Enable dimmer level/Sivoia state monitoring

L232> DLMON

Dimmer level monitoring enabled

See Also

DLMOFF - Dimmer Level/Sivoia State Monitoring Off

Dimmer Level Monitoring Output Format

Sivoia State Monitoring Output Format

DLMOFF

Dimmer Level/Sivoia State 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 state monitoring on this processor. When a Sivoia MDU or Sivoia QED in the system changes scenes, this processor will not send a monitor output string.

Example

Disable dimmer level/Sivoia state monitoring

L232> DLMOFF

Dimmer level monitoring disabled

See Also

DLMON - Dimmer Level/Sivoia State Monitoring On

Dimmer Level Monitoring Output Format

Sivoia State Monitoring Output Format

DL Monitor Output

Syntax

DL, <address>, <level>

Dimmer Level Monitor String

Parameter Description

address level system address of zone that changed new level of the zone

Format

[processor : link : interface : module or bus : zone] see

device address formatting description

0 - 100 (percent)

Description

The DL monitor string is output from a processor when any zone in the system changes level

Example

Processor 1, link 1, MI address 0, RPM module 2, zone 4 changes level to 50%

DL, [01:01:00:02:04], 50

See Also

DLMON - Dimmer level monitoring on

DLMOFF - Dimmer level monitoring off

SVS Monitor String

Syntax

SVS, <address>, <state>, <status>

Sivoia State Monitor String

Parameter Description address state status system address of Sivoia control that changed

Sivoia state, either a defined level or an action. current status of the Sivoia

Format

[processor : link : address]

see device address formatting description

1 = Preset 1

2 = Preset 2

3 = Preset 3

R = Raise

L = Lower o = Open

C = Close

S = Stop

STOPPED or MOVING

Description

The SVS monitor string is output from a processor when a Sivoia changes state or status.

Example 1

Someone selects Preset 1 on the Sivoia controlled by processor 1, link 6, Sivoia control address 3.

SVS, [01:06:03], 1, MOVING

When the same Sivoia stops at Preset 1.

SVS, [01:06:03], 1, STOPPED

Example 2

Someone selects the raise command on the Sivoia controlled by processor 1, link 6, Sivoia control address 3.

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

GSMON

GRAFIK Eye Scene 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.

Example

Enable GRAFIK Eye scene monitoring

L232> GSMON

GRAFIK Eye scene monitoring enabled

See Also

GSMOFF - GRAFIK Eye Scene Monitoring Off

GRAFIK Eye Scene Monitoring Output Format

GSMOFF

GRAFIK Eye Scene 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.

Example

Disable GRAFIK Eye scene monitoring

L232> GSMOFF

GRAFIK Eye scene monitoring disabled

See Also

GSMON - GRAFIK Eye Scene Monitoring On

GRAFIK Eye Scene Monitoring Output Format

GSS Monitor String

GRAFIK Eye Scene Select Monitor

String

Syntax

GSS, <address>, <scene number>

Parameter address

Description system address of GRAFIK Eye that changed scene number scene number selected

Description

The GSS monitor string is output from a processor when a GRAFIK Eye changes scenes

Example

Someone selects scene 1 on processor 1, link 4, GRAFIK Eye address 3

GSS, [01:04:03], 1

See Also

GSMON - GRAFIK Eye Scene Monitoring On

GSMOFF - GRAFIK Eye Scene Monitoring Off

Format

[processor : link : address] see

device address formatting

description

0 - 16

0 = Off

1 - 16 = scene 1 - scene 16

KBMON

Keypad/Dimmer/Sivoia Control 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.

Also enables dimmer button monitoring on this processor. When an H48 or RF dimmer/switch in the system is pressed, a monitoring message will be output from this processor indicating which processor, link, and dimmer was activated.

Also enables Sivoia control 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, Sivoia control address and button was activated.

Example

Enable keypad/dimmer/Sivoia control button monitoring

L232> KBMON

Keypad button monitoring enabled

See Also

KBMOFF - Keypad/Sivoia Control Button Monitoring Off

Keypad Button Press Monitoring Output Format

Keypad Button Release Monitoring Output Format

Keypad Button Hold Monitoring Output Format

Keypad Button Double Tap Monitoring Output Format

Dimmer Button Press Monitoring Output Format

Dimmer Button Release Monitoring Output Format

Dimmer Button Hold Monitoring Output Format

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

KBMOFF

Keypad/Dimmer/Sivoia Control 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. When an H48 or RF dimmer/switch in the system is pressed, this processor will not send a monitor output string.

Also disables Sivoia control monitoring on this processor. When a Sivoia control button in the system is pressed, this processor will not send a monitor output string.

Example

Disable keypad/dimmer/Sivoia control button monitoring

L232> KBMOFF

Keypad button monitoring disabled

See Also

KBMON - Keypad/Sivoia Control Button Monitoring On

Keypad Button Press Monitoring Output Format

Keypad Button Release Monitoring Output Format

Keypad Button Hold Monitoring Output Format

Keypad Button Double Tap Monitoring Output Format

Dimmer Button Press Monitoring Output Format

Dimmer Button Release Monitoring Output Format

Dimmer Button Hold Monitoring Output Format

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

KBP Monitor String

Syntax

KBP, <address>, <button number>

Keypad Button Press Monitor String

Parameter

address button number

Description

system address of the keypad button number that was pressed

Format

[processor : link : address]

see device address formatting

description

1 - 24

Description

The KBP monitor string is output from a processor when a keypad button is pressed

Example

Someone presses button 1 on processor 1, link 4, keypad address 4

KBP, [01:04:04], 1

See Also

KBR Monitor String

KBH Monitor String

KBDT Monitor String

KBMON - Keypad button monitoring on

KBMOFF - Keypad button monitoring off

KBR Monitor String

Syntax

KBR, <address>, <button number>

Keypad Button Release Monitor String

Parameter

address button number

Description

system address of the keypad button number that was released

Format

[processor : link : address] see

device address formatting

description

1 - 24

Description

The KBR monitor string is output from a processor when a keypad button is released

Example

Someone releases button 1 on processor 1, link 4, keypad address 4

KBR, [01:04:04], 1

See Also

KBP Monitor String

KBH Monitor String

KBDT Monitor String

KBMON - Keypad button monitoring on

KBMOFF - Keypad button monitoring off

KBH Monitor String

Syntax

KBH, <address>, <button number>

Keypad Button Hold Monitor String

Parameter

address button number

Description

system address of the keypad button number that was held

Format

[processor : link : address]

see device address formatting description

1 - 24

Description

The KBH monitor string is output from a processor when a keypad button is held

Example

Someone holds button 1 on processor 1, link 4, keypad address 4

KBH, [01:04:04], 1

See Also

KBP Monitor String

KBR Monitor String

KBDT Monitor String

KBMON - Keypad button monitoring on

KBMOFF - Keypad button monitoring off

KBDT Monitor String

Keypad Button Double Tap Monitor

String

Syntax

KBDT, <address>, <button number>

Parameter

address

Description

system address of the keypad button number button number that was double tapped

Format

[processor : link : address]

see device address formatting description

1 - 24

Description

The KBDT monitor string is output from a processor when a keypad button is double tapped

Example

Someone double taps button 1 on processor 1, link 4, keypad address 4

KBDT, [01:04:04], 1

See Also

KBP Monitor String

KBR Monitor String

KBH Monitor String

KBMON - Keypad button monitoring on

KBMOFF - Keypad button monitoring off

SVBP Monitor String

Syntax

SVBP, <address>, <button number>

Sivoia Control Button Press Monitor String

Parameter

address button number

Description

system address of the Sivoia control button number that was pressed

Format

[processor : link : address]

see device address formatting description

1 - 24

Description

The SVBP monitor string is output from a processor when a Sivoia control button is pressed

Example

Someone presses button 1 on processor 1, link 4, Sivoia control address 4

SVBP, [01:04:04], 1

See Also

SVBR Monitor String

SVBH Monitor String

SVBDT Monitor String

SVS Monitor String

KBMON - Keypad/Sivoia control button monitoring on

KBMOFF - Keypad/Sivoia control button monitoring off

SVBR Monitor String

Syntax

SVBR, <address>, <button number>

Sivoia Control Button Release Monitor String

Parameter

address button number

Description

system address of the Sivoia control button number that was released

Format

[processor : link : address] see device address formatting description

1 - 24

Description

The SVBR monitor string is output from a processor when a Sivoia control button is released.

Example

Someone releases button 1 on processor 1, link 4, Sivoia control address 4

SVBR, [01:04:04], 1

See Also

SVBP Monitor String

SVBH Monitor String

SVBDT Monitor String

SVS Monitor String

KBMON - Keypad/Sivoia control button monitoring on

KBMOFF - Keypad/Sivoia control button monitoring off

SVBH Monitor String

Syntax

SVBH, <address>, <button number>

Sivoia Control Button Hold Monitor String

Parameter

address button number

Description

system address of the Sivoia control button number that was held

Format

[processor : link : address] see device address formatting description

1 - 24

Description

The SVBH monitor string is output from a processor when a Sivoia control button is held

Example

Someone holds button 1 on processor 1, link 4, Sivoia control address 4

SVBH, [01:04:04], 1

See Also

SVBP Monitor String

SVBR Monitor String

SVBDT Monitor String

SVS Monitor String

KBMON - Keypad/Sivoia control button monitoring on

KBMOFF - Keypad/Sivoia control button monitoring off

SVBDT Monitor String

Sivoia Control Button Double Tap Monitor String

Syntax

SVBDT, <address>, <button number>

Parameter

address button number

Description

system address of the Sivoia control button number that was double tapped

Format

[processor : link : address] see device address formatting description

1 - 24

Description

The SVBDT monitor string is output from a processor when a Sivoia control button is double tapped.

Example

Someone double taps button 1 on processor 1, link 4, Sivoia control address 4

SVBDT, [01:04:04], 1

See Also

SVBP Monitor String

SVBR Monitor String

SVBH Monitor String

SVS Monitor String

KBMON - Keypad/Sivoia control button monitoring on

KBMOFF - Keypad/Sivoia control button monitoring off

DBP Monitor String

Syntax

DBP, <address>, <button number>

Dimmer Button Press Monitor String

Parameter

address

Description

system address of the H48 or RF dimmer/switch button number button number that was pressed

Format

see device address formatting description

1

Description

The DBP monitor string is output from a processor when the tap switch for an H48 or RF dimmer/switch is pressed. This string is not generated when the tap switch for a D48 dimmer/switch is pressed nor when the raise/lower rocker for any dimmer is pressed.

Example

Someone presses the H48 tap switch on processor 1, link 4, router 1, bus 3, dimmer 2.

DBP, [01:04:01:03:02], 1

Someone presses the RF tap switch on processor 1, link 8, dimmer 54. (The device type is 1 for all RF dimmers/switches.)

DBP, [01:08:01:54], 1

See Also

DBR Monitor String

DBH Monitor String

DBDT Monitor String

KBMON - Keypad button monitoring on

KBMOFF - Keypad button monitoring off

DBR Monitor String

Syntax

DBR, <address>, <button number>

Dimmer Button Release Monitor String

Parameter

address

Description

system address of the H48 dimmer/switch button number button number that was released

Format

see device address formatting description

1

Description

The DBP monitor string is output from a processor when the tap switch for an H48 dimmer/switch is released. This string is not generated when the tap switch for a D48 or RF dimmer/switch is released nor when the raise/lower rocker for any dimmer is released.

Example

Someone releases the H48 tap switch on processor 1, link 4, router 1, bus 3, dimmer 2.

DBP, [01:04:01:03:02], 1

See Also

DBP Monitor String

DBH Monitor String

DBDT Monitor String

KBMON - Keypad button monitoring on

KBMOFF - Keypad button monitoring off

DBH Monitor String

Syntax

DBH, <address>, <button number>

Dimmer Button Hold Monitor String

Parameter

address

Description

system address of the H48 dimmer/switch button number button number that was held

Format

see device address formatting description

1

Description

The DBH monitor string is output from a processor when the tap switch for an H48 dimmer/switch is held. This string is not generated when the tap switch for a D48 or RF dimmer/switch is held.

Example

Someone holds the H48 tap switch on processor 1, link 4, router 1, bus 3, dimmer 2.

DBH, [01:04:01:03:02], 1

See Also

DBP Monitor String

DBR Monitor String

DBDT Monitor String

KBMON - Keypad button monitoring on

KBMOFF - Keypad button monitoring off

DBDT Monitor String

Dimmer Button Double Tap Monitor

String

Syntax

DBDT, <address>, <button number>

Parameter

address

Description

system address of the H48 or RF dimmer/switch button number button number that was double tapped

Format

see device address formatting description

1

Description

The DBP monitor string is output from a processor when the tap switch for an H48 dimmer/switch is double tapped. It is output from a processor when the tap switch for an RF dimmer/switch is double tapped only if the dimmer has keypad-like programming. This string is not generated when the tap switch for a D48 dimmer/switch is double tapped.

Example

Someone double taps the H48 tap switch on processor 1, link 4, router 1, bus 3, dimmer 2.

DBDT, [01:04:01:03:02], 1

Someone double taps the programmed RF tap switch on processor 1, link 8, dimmer 54. (The device type is 1 for all RF dimmers/switches.)

DBDT, [01:08:01:54], 1

See Also

DBP Monitor String

DBR Monitor String

DBH Monitor String

KBMON - Keypad button monitoring on

KBMOFF - Keypad button monitoring off

KLMON

Keypad LED Monitoring On

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

L232> KLMON

Keypad led monitoring enabled

See Also

KLMOFF - Keypad Led Monitoring Off

Keypad Led Monitoring Output Format

KLMOFF

Keypad LED Monitoring Off

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> KLMOFF

Keypad led monitoring disabled

See Also

KLMON - Keypad Led Monitoring On

Keypad Led Monitoring Output Format

KLS Monitor String

Syntax

KLS, <address>, <led states>

Keypad LED Monitor String

Parameter Description

address led states system address of the keypad the current state of the keypad's LEDs

Format

[processor : link : address] see device address formatting description

The first digit is LED 1, the last digit is LED 24

0 = Off

1 = On

2 = Flash 1

3 = Flash 2

Description

The KLS monitor string is output from a processor when any led on a keypad changes state

Example

An led on processor 1, link 4, keypad address 10 changes state

KLS, [01:04:10], 100000000000000000000000

See Also

KLMON - Keypad button monitoring on

KLMOFF - Keypad button monitoring off

KBP

Syntax

KBP, <address>, <button number>

Keypad Button Press

Parameter

address button number

Description

system address of the keypad button number to press

Format

[processor : link : address] see device address formatting description

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.

Example

Press button 1 on processor 1, link 4, keypad address 10

L232> KBP, [1:4:10], 1

See Also

KBR - Keypad button release

KBH - Keypad button hold

KBDT - Keypad button double tap

KBR

Syntax

KBR, <address>, <button number>

Parameter

address button number

Description

system address of the keypad button number to release

Description

Simulates the release action of a keypad button.

Example

Release button 1 on processor 1, link 4, keypad address 10

L232> KBR, [1:4:10], 1

See Also

KBP - Keypad button press

KBH - Keypad button hold

KBDT - Keypad button double tap

Keypad Button Release

Format

[processor : link : address] see device address formatting description

1 - 24

KBH

Syntax

KBH, <address>, <button number>

Keypad Button Hold

Parameter

address button number

Description

system address of the keypad button number to hold

Format

[processor : link : address] see device address formatting description

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

L232> KBH, [1:4:10], 1

See Also

KBP - Keypad button press

KBR - Keypad button release

KBDT - Keypad button double tap

KBDT

Syntax

KBDT, <address>, <button number>

Keypad Button Double Tap

Parameter

address button number

Description

system address of the keypad button number to double tap

Format

[processor : link : address] see device address formatting description

1 - 24

Description

Simulates the double tap action of a keypad button. This does not simulate a true keypad button double tap that is preceeded by a press and release, and followed by a release

Example

Double tap button 1 on processor 1, link 4, keypad address 10

L232> KBDT, [1:4:10], 1

See Also

KBP - Keypad button press

KBR - Keypad button release

KBH - Keypad button hold

KE

Syntax

KE, <address>

Parameter Description

address system address of the keypad

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

Keypad Enable

Format

[processor : link : address] see device address formatting description

KD

Syntax

KD, <address>

Parameter Description

address system address of the keypad

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

Keypad Disable

Format

[processor : link : address] see device address formatting description

SETLED

Syntax

SETLED, <address>, <led number>, <led state>

Set One Keypad LED State

Parameter address led number led state

Description system address of the keypad led number on the keypad state to set the LED to

Format

[processor : link : address] see device address formatting description

1 - 24

The led number is the corresponding button number

0 = Off

1 = On

2 = Flash 1

3 = Flash 2

Description

Sets the state of a keypad led. If the designated led is already programmed to indicate the status of something else in the system, this command will have no effect on the led state.

Example

Turn on LED 3 on processor 2, link 5, keypad address 7

L232> SETLED, [2:5:7], 3, 1

See Also

SETLEDS - Set Keypad LED States

RKLS - Request Keypad LED States

SETLEDS

Syntax

SETLEDS, <address>, <led states>

Set Keypad LED States

Parameter Description address led states system address of the keypad states to set some or all the LEDs

LED #1 is the left most LED in the string

Format

[processor : link : address] see device address formatting description

0 = Off

1 = On

2 = Flash 1

3 = Flash 2 x = Don't change

Description

Sets the states of several LEDs on a keypad. If the designated LEDs are already programmed to indicate the status of something else in the system, this command will have no effect on the led state.

Example

Turn on LED #3 & LED #10 on processor 2, link 5, keypad address 7

L232> SETLEDS, [2:5:7], xx1xxxxxx1

Example

Turn off LED #1 and flash LEDs #11 to #15 on processor 1, link 6, keypad address 4

L232> SETLEDS, [1:6:4], 0xxxxxxxxx22222

See Also

SETLED - Set One Keypad LED State

RKLS - Request Keypad Led States

CCOPULSE

Syntax

CCOPULSE, <address>, <relay number>, <pulse time>

Parameter

address

Description

system address of the CCO relay number relay number to pulse pulse time pulse duration in 0.5 second increments

CCO Relay Pulse

Format

[processor : link : address] see device address formatting description

1 - 8

1 - 245

1 = 0.5 seconds

2 = 1.0 seconds

3 = 1.5 seconds

.

.

245 = 122.5 seconds

Description

Pulses a specific CCO relay for a specified duration.

Example

Pulse relay 3 on processor 2, link 4, CCO address 6, for 2 seconds

L232> CCOPULSE, [2:4:6], 3, 4

See Also

CCOCLOSE - Close a CCO relay

CCOOPEN - Open a CCO relay

CCOCLOSE

Syntax

CCOCLOSE, <address>, <relay number>

CCO Relay Close

Parameter

address relay number

Description

system address of the CCO relay number to close

Format

[processor : link : address] see device address formatting description

1 - 8

Description

Closes a specific CCO relay

Note - The processor does not verify that the given address is ACTUALLY a CCO address. If the address is a normal keypad, the command may temporarily change the state of the leds on that keypad.

Example

Close relay 3 on processor 2, link 4, CCO address 6

L232> CCOCLOSE, [2:4:6], 3

See Also

CCOOPEN - Open a CCO relay

CCOPULSE - Pulse a CCO relay

CCOOPEN

Syntax

CCOOPEN, <address>, <relay number>

CCO Relay Open

Parameter

address relay number

Description

system address of the CCO relay number to open

Format

[processor : link : address] see device address formatting description

1 - 8

Description

Opens a specific CCO relay

Note - The processor does not verify that the given address is ACTUALLY a CCO address. If the address is a normal keypad, the command may temporarily change the state of the leds on that keypad.

Example

Open relay 3 on processor 2, link 4, CCO address 6

L232> CCOOPEN, [2:4:6], 3

See Also

CCOCLOSE - CLOSE a CCO relay

CCOPULSE - Pulse a CCO relay

RKES

Syntax

RKES, <address>

Processor responds with

KES, <address>, <state>

Parameter Description

address system address of the keypad state the enabled/disabled state of the keypad

Description

Queries the system for the enabled/disabled state of a keypad

Example

Query processor 1, link 4, keypad address 10

L232> RKES, [1:4:10]

KES, [01:04:10], enabled

See Also

KD - Keypad disable

KE - Keypad enable

Request Keypad Enabled State

Format

[processor : link : address] see device address formatting description

RKLS

Syntax

RKLS, <address>

Processor Response

KLS, <address>, <led states>

Request Keypad LED States

Parameter Description address system address of the keypad led states the current state of the keypad's LEDs

Format

[processor : link : address] see device address formatting description

The first digit is LED 1, the last digit is LED 24

0 = Off

1 = On

2 = Flash 1

3 = Flash 2

Description

Queries the system for the state of the LEDs on a specified keypad. 24 led digits will be returned regardless of the number of physical LEDs on the keypad.

Example

Query processor 4, link 6, keypad 1

L232> RKLS, [4:6:1]

KLS, [04:06:01], 000001000010000010000000

See Also

SETLED - Set One Keypad LED State

SETLEDS - Set Keypad LED States

RKLBP

Syntax

RKLBP, <address>

Processor responds

KLBP, <address>, <button number>

Parameter address

Description system address of the keypad button number the last button pressed on the specified keypad

Description

Queries the system for the last button pressed on a keypad

Example

Query for the last button pressed on processor 1, link 4, keypad address 10

L232> RKLBP, [1:4:10]

KLBP, [01:04:10], 4

Request Keypad Last Button Pressed

Format

[processor : link : address] see device address formatting description

1-24

FADEDIM

Syntax

FADEDIM, <intensity>, <fade time>, <delay time>, <address 1>, ..., <address n>

Fade a dimmer

Parameter Description

intensity target intensity for specified dimmer

Format

0 - 100 (percent) fade time time for dimmers to fade from current intensity to target intensity HH:MM:SS example: 00:00:05 for 5 seconds see time formatting description if omitted, time defaults to 0 seconds delay time time for dimmers to delay before starting to fade address system address of dimmer to fade

HH:MM:SS example: 00:00:05 for 5 seconds see time formatting description if omitted, time defaults to 0 seconds

[processor : link : address] maximum of 10 address per command see device address formatting description

Description

Fades one or more system dimmers to a target intensity using a specified fade time and after a specified delay time.

Example

Fade processor 1, link1, MI address 0, RPM module 2, zone 3 and processor 2, link 4, D48 address 1, Vareo Bus 4, Vareo address 1 to 100% with a 1 second fade time and a 2 second delay time

L232> FADEDIM, 100, 1, 2, [1.1.0.2.3], [2.4.1.4.1]

See Also

FLASHDIM - Flash a system dimmer

STOPFLASH - Stop flashing a system dimmer

RAISEDIM - Raise a system dimmer

LOWERDIM - Lower a system dimmer

STOPDIM - Stop a dimmer raise/lower

RAISEDIM

Syntax

RAISEDIM, <address 1>, ..., <address n>

Parameter Description

address system address of zones to fade

Raise a dimmer

Description

Starts raising one or more system dimmers

Example

Start raising processor 1, link1, MI address 0, RPM module 2, zone 3

L232> RAISEDIM, [1:1:0:2:3]

See Also

LOWERDIM - Lower a system dimmer

STOPDIM - Stop a dimmer raise/lower

FADEDIM - Fade a system dimmer

FLASHDIM - Flash a system dimmer

STOPFLASH - Stop flashing a system dimmer

Format

[processor : link : address] maximum of 10 address per command see device address formatting description

LOWERDIM

Syntax

LOWERDIM, <address 1>, ..., <address n>

Parameter Description

address system address of zones to fade

Lower a dimmer

Description

Starts lowering one or more system dimmers

Example

Start lowering processor 1, link1, MI address 0, RPM module 2, zone 3

L232> LOWERDIM, [1:1:0:2:3]

See Also

RAISEDIM - Raise a system dimmer

STOPDIM - Stop a dimmer raise/lower

FADEDIM - Fade a system dimmer

FLASHDIM - Flash a system dimmer

STOPFLASH - Stop flashing a system dimmer

Format

[processor : link : address] maximum of 10 address per command see device address formatting description

STOPDIM

Syntax

STOPDIM, <address 1>, ..., <address n>

Stop a dimmer raise/lower

Parameter Description

address system address of zones to fade

Format

[processor : link : address] maximum of 10 address per command see 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> STOPDIM, [1:1:0:2:3]

See Also

RAISEDIM - Raise a system dimmer

LOWERDIM - Lower a system dimmer

FADEDIM - Fade a system dimmer

FLASHDIM - Flash a system dimmer

STOPFLASH - Stop flashing a system dimmer

FLASHDIM

Syntax

FLASHDIM, <intensity>, <flash rate>, <address 1>, ..., <address n>

Flash a dimmer

Parameter Description

intensity flash rate address

Intensity to flash the dimmers to

The amount of time the dimmers are on/off system address of zones to fade

Format

0 - 100 (percent)

HH:MM:SS example: 00:00:05 for 5 seconds see time formatting description if omitted, flash rate defaults to 2 seconds

[processor : link : address] maximum of 10 address per command see device address formatting description

Description

Starts flashing one or more system zones at a specified rate. The dimmer is flashed between the specified intensity and Off.

Example

Start flashing processor 1, link1, MI address 0, RPM module 2, zone 3 once a second

L232> FLASHDIM, 100, 1, [1:1:0:2:3]

See Also

STOPFLASH - Stop flashing a system dimmer

FADEDIM - Fade a system dimmer

RAISEDIM - Raise a system dimmer

LOWERDIM - Lower a system dimmer

STOPDIM - Stop a dimmer raise/lower

STOPFLASH

Syntax

STOPFLASH, <address 1>, ..., <address n>

Parameter Description

address system address of zones to fade

Stop flashing a dimmer

Description

Stops flashing one or more system zones

Example

Stop flashing processor 1, link1, MI address 0, RPM module 2, zone 3

L232> STOPFLASH, [1:1:0:2:3]

See Also

FLASHDIM - Flash a system dimmer

FADEDIM - Fade a system dimmer

RAISEDIM - Raise a system dimmer

LOWERDIM - Lower a system dimmer

STOPDIM - Stop a dimmer raise/lower

Format

[processor : link : address] maximum of 10 address per command see device address formatting description

DBP

Syntax

DBP, <address>, <button number>

Dimmer Button Press

Parameter

address

Description

system address of the H48 or RF dimmer/switch button number button number to press

Format

see device address formatting description

1

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. This does not simulate a true keypad button press that is followed by an immediate release or a delayed hold and release. This does not simulate the press action of the tap switch for a D48 dimmer/switch. This does not simulate the press action of the raise/lower rocker for any dimmer.

Example

Press H48 tap switch on processor 1, link 4, router 1, bus 3, dimmer 2.

L232> DBP, [1:4:1:3:2], 1

Press RF tap switch on processor 1, link 8, dimmer address 54. (The device type is 1 for all RF dimmers/switches.)

L232> DBP, [1:8:1:54], 1

See Also

DBDT - Dimmer button double tap

DBDT

Syntax

DBDT, <address>, <button number>

Dimmer Button Double Tap

Parameter

address

Description

system address of the H48 or RF dimmer/switch button number button number to double tap

Format

see device address formatting description

1

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. This does not simulate a true keypad button double tap that is preceded by a press and release and followed by a second release. This does not simulate the double tap action of the tap switch for a D48 dimmer/switch.

Example

Double tap H48 tap switch on processor 1, link 4, router 1, bus 3, dimmer 2.

L232> DBDT, [1:4:1:3:2], 1

Double tap RF tap switch on processor 1, link 8, dimmer address 54. (The device type is 1 for all RF dimmers/switches.)

L232> DBDT, [1:8:1:54], 1

See Also

DBP - Dimmer button press

RDL

Syntax

RDL, <address>

Processor responds with

DL, <address>, <level>

Request a Dimmer Level

Parameter Description

address system address of zone to query level current level of the queried zone

Format

[processor : link : interface : module or bus : zone] see device address formatting description

0 - 100 (percent)

Description

Returns the current or target level for any zone in the sysyem

Example

Request the current intensity of processor 1, link 1, MI address 0, RPM module 2, zone 4

L232> RDL, [1:1:0:2:4]

DL, [01:01:00:02:04], 50

See Also

FRPM - Fade an RPM Dimmer

FV - Fade Vareo Dimmer

SVSS

Syntax

SVSS, <address>, <state>, <delay time>

Parameter Description address system address of Sivoia control state Sivoia state to select delay time time for Sivoia to delay before activating a state

Sivoia State Select

Format

[processor : link : address] see device address formatting description

1 = Preset 1

2 = Preset 2

3 = Preset 3

R or r = Raise

L or l = Lower

O or o = Open

C or c = Close

S or s = Stop

HH:MM:SS example: 00:00:05 for 5 seconds see time formatting description if omitted, time defaults to 0 seconds

Description

Selects the state on any Sivoia control in the system.

Example

Select Preset 2 on processor 1, link 6, Sivoia control address 1.

L232> SVSS, [1:6:1], 2

See Also

RSVS - Request Current Sivoia State

RSVS

Syntax

RSVS, <address>

Processor responds with

SVS, <address>, <state>, <status>

Parameter Description address system address of Sivoia control to query

Request Current Sivoia State

state Sivoia state currently selected on the Sivoia status current status of the Sivoia

Description

Returns the current state and status on the specified Sivoia

Example

Request the current state for processor 1, link 6, Sivoia control address 4

Response is stopped at Preset 2

L232> RSVS, [1:6:4]

SVS, [01:06:04], 2, STOPPED

See Also

SVSS -Select Sivoia State

Format

[processor : link : address] see device address formatting description

1 = Preset 1

2 = Preset 2

3 = Preset 3

R = Raise

L = Lower o = Open

C = Close

S = Stop

STOPPED or MOVING

GSS

Syntax

GSS, <address>, <scene number>

Parameter

address

Description

system address of GRAFIK Eye to control scene number scene number to select

Description

Selects a scene on any GRAFIK Eye in the system

Example

Select scene 2 on processor 1, link 5, GRAFIK Eye address 1

L232> GSS, [1:5:1], 2

See Also

RGS - Request current GRAFIK Eye scene

GRAFIK Eye Scene Select

Format

[processor : link : address] see device address formatting description

0 - 16

0 = Off

1 - 16 = scene 1 - scene 16

RGS

Syntax

RGS, <address>

Processor responds with

GSS, <address>, <scene number>

Parameter

address

Description

system address of GRAFIK Eye to query scene number scene number selected on the GRAFIK Eye

Request a GRAFIK Eye's current scene

Format

[processor : link : address] see device address formatting description

0 - 16

0 = Off

1 - 16 = scene 1 - scene 16

Description

Returns the current scene on the specified GRAFIK Eye

Example

Request the current scene for processor 1, link 6, GRAFIK Eye address 4

L232> RGS, [1:6:4]

GSS, [01:06:04], 2

See Also

GSS -Select a GRAFIK Eye scene

ST

Syntax

ST, <time>

Processor Responds

Processor Time: <time>

Parameter Description

time current time of day in 24 hour format

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> ST, 14:34:00

Processor Time: 14:34

See Also

RST - Request system time

SD - Set system date

RSD - Request system date

Format

HH:MM:SS in 24 Hour format see time address formatting description the seconds must be specified

Set Time

SD

Syntax

SD, <date>

Processor Responds

Processor Date: <date>

Parameter Description

date current date

Format

MM/DD/YYYY see 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> SD, 03/10/1999

Processor Date: Wednesday 03/10/1999

See Also

RSD - Request system date

ST - Set system time

RST - Request system time

Set Date

TCE

Syntax

TCE

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

Timeclock Enable

TCD

Syntax

TCD

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

Timeclock Disable

RST

Syntax

RST

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

Request System Time

RST2

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

Request System Time with seconds

RSD

Syntax

RSD

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

Request System Date

TCS

Syntax

TCS

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

Timeclock State

SUNRISE

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

Today's sunrise time

SUNSET

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

Today's sunset time

SSB

Syntax

SSB, <timeout>

Parameter Description

timeout number of minutes scene saver mode will be running

Processor Responds

Scene Saver Mode Begin

Description

Begins scene saver mode with the specified timeout

Example

Begin scene saver mode without a timeout

L232> SSB, CONT

Scene Saver Mode Begin

See Also

SST - Scene saver mode terminate

SSS - Request scene saver mode state

KBSS - Keypad button scene save

KBSR - Keypad button scene restore

Scene Saver Mode Begin

Format

CONT = continuous (no timeout)

0 = 1 minute

1-1440

SST

Syntax

SST

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

Scene Saver Mode Terminate

KBSS

Syntax

KBSS, <address>, <button number>

Keypad Button Scene Save

Parameter

address

Description

system address of the keypad

Format

[processor : link : address] see device address formatting description

1 - 24 button number button number to scene save

Processor Responds

Preset Saved

Description

Scene save the current levels of the preset on the button that has scene saver option checked.

Example

Scene save the preset on button 1 on processor 1, link 6, keypad address 10.

L232> KBSS, [1:6:10], 1

Preset Saved

See Also

SSB - Scene saver mode begin

SST - Scene saver mode terminate

SSS - Request scene saver mode state

KBSR - Keypad button scene restore

KBSR

Syntax

KBSR, <address>, <button number>

Keypad Button Scene Restore

Parameter

address

Description

system address of the keypad

Format

[processor : link : address] see device address formatting description

1 - 24 button number button number to scene save

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.

Example

Restore the preset on button 1 on processor 1, link 6, keypad address 10.

L232> KBSR, [1:6:10], 1

Preset Restored

See Also

SSB - Scene saver mode begin

SST - Scene saver mode terminate

SSS - Request scene saver mode state

KBSS - Keypad button scene save

SSS

Syntax

SSS

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

SST - Scene saver mode terminate

KBSS - Keypad button scene save

KBSR - Keypad button scene restore

Scene Saver Mode State

VMR

Syntax

VMR

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 - Request Vacation Mode State

Vacation Mode Record

VMP

Syntax

VMP

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 - Request Vacation Mode State

Vacation Mode Playback

VMD

Syntax

VMD

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 - Request Vacation Mode State

Vacation Mode Disable

VMS

Syntax

VMS

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

VMD - Vacation Mode Disable

Request Vacation Mode State

SMB

Syntax

SMB

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

Security Mode Begin

SMT

Syntax

SMT

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

Security Mode Terminate

SMS

Syntax

SMS

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

Security Mode State

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. Login denied.

Parameter

password port address processor address

Description

system password defined in the programming software the specific port to login.

Reply from a processor

Format

maximum 32 characters, caseinsensitive, spaces and commas not allowed pp:ll:aaa (see RS232 Port Addressing )

This parameter is optional. If omitted, the system will perform a systemwide login (all RS232 ports) allowed

1-16

Description

Used to gain access to a system that has not been successfully logged into. The login/logout feature can be used to add a layer of protection against other people gaining access to the system. When logged-out of the system, only two L232 commands are recognized, LOGIN and HELP.

This means that database changes and L232 control of the processor cannot be done until after a successful login. This feature is typically used on systems that utilize a modem for remote programming.

Example

Do a systemwide login to a system with password "lutron" and processors 1, 2 and 3 present

L232> LOGIN, lutron

Processor 1 logging in RS232 ports

Processor 2 RS232 ports logged in

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

LOGOUT

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

Logout of the system

Parameter

port address processor address

Description

the specific port to login.

Reply from a processor

Format

pp:ll:aaa (see RS232 Port Addressing )

This parameter is optional. If omitted, the request will default to the port that receives the command allowed

1-16

Description

Used to logout of the system. The login/logout feature can be used to add a layer of protection against other people gaining access to the system.

When logged-out of the system, only two L232 commands are recognized, LOGIN and HELP. This means that database changes and L232 control of the processor cannot be done until after a successful login. This feature is typically used on systems that utilize a modem for remote programming.

Example

Logout of the port connected to

L232> LOGOUT

Logging out RS232 port 01:03:001

Example

Logout of RS232 port 7 on processor 2

L232> LOGOUT, 2:7:1

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

See Also

LOGIN - Login to the system

PROMPTOFF

Turn off the Prompt

(L232>/LNET>/>)

Syntax

PROMPTOFF

Description

When the prompt is turned off, a new L232>/LNET>/> 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.

Example

Turn the L232> prompt off

L232> PROMPTOFF

See Also

PROMPTON - Turn the prompt on

PROMPTON

Turn on the Prompt

(L232>/LNET>/>)

Syntax

PROMPTON

Description

Re-enables the prompt. After every command execution, a new L232>/LNET>/> prompt will be issued.

Example

Turn the L232> prompt on.

PROMPTON

L232>

See Also

PROMPTOFF - Turn the prompt off

SETBAUD

RS-232 only

Syntax

SETBAUD, < port address > , <baud rate>

Set RS-232 port 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

port address (optional) baud rate

Description

the port address the command is for new RS-232 port baud rate

Format

pp:ll (see RS232 Port Addressing ) This parameter is optional. If omitted, the request will default to the port that receives the command 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 on position, the processor RS232 port baud rate is fixed at 9600 baud. When dip switch #1 is in the off 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 set to the on 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 the new baud rate to take effect, you must cycle the processor power.

The port settings will be set to 8 data bits, No parity, and 1 Stop bit.

Example

Set RS-232 port baud rate to 115200 bps on link 7 of procesor 2

L232> SETBAUD, 2:7, 115200

For the new baud rate to take effect, you must cycle the processor power.

The port settings will be set to 8 data bits, No parity, and 1 Stop bit.

See Also

GETBAUD - Request the RS-232 port baud rate

SETHAND

RS-232 only

Syntax

SETHAND, < port address >, <handshaking>

Processor Responds with one of the following

No handshaking enabled

Hardware handshaking enabled

Set RS-232 port handshaking type

Parameter

port address (optional) handshaking

Description

the port address the command is for new RS-232 port handshaking type

Format

pp:ll (see RS232 Port Addressing ) This parameter is optional. If omitted, the request will default to the port that receives the command 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 HomeWorks processor will ignore the

CTS input, and always transmit data. When set to HW (hardware), the HomeWorks 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

Example

Set RS-232 port handshaking to Hardware on link 7 of processor 2

L232> Sethand, 2:7, HW

Hardware handshaking enabled

See Also

GETHAND - Request RS-232 port handshaking type

RESET232

RS-232 only

Syntax

RESET232

Reset RS-232 port settings

Processor responds with one of the following

For the new RS-232 port parameters to take effect for this port, you must cycle the processor power.

Description

This command is used to reset all RS-232 port settings to the serial driver settings assigned to that port using the HomeWorks Illumination 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.

All ports will immediately switch to the driver settings except the port connected to.

Example

Reset all RS-232 ports settings for all processors.

L232> RESET232

For the new RS-232 port parameters to take effect for this port, you must cycle the processor power.

PROCADDR

Syntax

PROCADDR

Processor Responds with

Processor Addresss : <address>

Processor Address

Parameter

address

Description

the address of the processor that received the command

Format

1 - 16

Description

Returns the address of the processor that received the command

Example

Request the processor address

L232> PROCADDR

Processor Addresss : 01

SYNCDB

Syntax

SYNCDB, <processor address>

Processor response (no devices with errors)

Upload Mode started

********

Upload Mode Term - Errs: 0

Processor response (devices with errors exist)

Upload Mode started

********

Devices with invalid DBs:

<address 1>

<...>

<address N>

Upload Mode Term - Errs: <N>

Parameter Description

Send Database to All RF Devices

processor address The processor address address 1

... address N

The RF device addresses with errors

Format

1-16

[processor : link : device type : device] see device address formatting description

N The number of devices that did not receive the database Integer

Description

Sends the current project stored in the RF processor to each of its RF devices (keypads, dimmers, and switches). Note: A database must be uploaded to the processor before this command will work.

After the upload mode starts, the RF Activity LEDs (TX and RX) on the RF processor will be flashing. Note: It could take several minutes for all devices to receive databases. If all RF devices have an updated database, the processor returns with no errors. Otherwise, the number and addresses of the RF devices that do not have the current project is returned.

Example 1 (no devices with errors)

Send the current project stored in RF processor 1 to each of its RF devices (40 total). After ten minutes, all devices have an updated database.

L232> SYNCDB, 1

Upload Mode started

********

Upload Mode Term - Errs: 0

Example 2 (devices with errors exist)

Send the current project stored in RF processor 1 to each of its RF devices (40 total). After ten minutes, all devices have an updated database except for three RF dimmers addressed 1, 2, and 3.

L232> SYNCDB, 1

Upload Mode started

********

Devices with invalid DBs:

[01:08:01:01]

[01:08:01:02]

[01:08:01:03]

Upload Mode Term - Errs: 3

See Also

RETRYDB - Send Database to All RF Devices with Errors

SENDDB - Send Database to One RF Device

RFDBSTAT - Request RF Devices with Errors

Send Database to All RF Devices with

RETRYDB

Errors

Syntax

RETRYDB, <processor address>

Processor response (no devices with errors)

Upload Mode started

********

Upload Mode Term - Errs: 0

Processor response (devices with errors exist)

Upload Mode started

********

Devices with invalid DBs:

<address 1>

<...>

<address N>

Upload Mode Term - Errs: <N>

Parameter Description

processor address The processor address

Format

1-16 address 1

... address N

The RF device addresses with errors [processor : link : device type : device] see device address formatting description

N The number of devices that did not receive the database Integer

Description

Sends the current project stored in the RF processor to each of its RF devices (keypads, dimmers, and switches) with errors, i.e. RF devices without an updated database. Note: A database must be uploaded to the processor before this command will work.

After the upload mode starts, the RF Activity LEDs (TX and RX) on the RF processor will be flashing while uploading databases. Note: It could take several minutes for all devices to receive databases. If all RF devices have an updated database, the processor returns with no errors. Otherwise, the number and addresses of the RF devices that do not have the current project is returned.

Example

Send the current project stored in RF processor 1 to each of its RF devices (40 total). After ten minutes, all devices have an updated database except for three RF dimmers addressed 1, 2, and 3.

L232> SYNCDB, 1

Upload Mode started

********

Devices with invalid DBs:

[01:08:01:01]

[01:08:01:02]

[01:08:01:03]

Upload Mode Term - Errs: 3

Troubleshoot the communication problem with the three devices. In this example, their FASS sliders were in the OFF position.

Retry sending the current project stored in RF processor 1 to each RF device that failed (3 total). After fifteen seconds, all devices have an updated database.

L232> RETRYDB, 1

Upload Mode started

********

Upload Mode Term - Errs: 0

See Also

SYNCDB - Send Database to All RF Devices

SENDDB - Send Database to One RF Device

RFDBSTAT - Request RF Devices with Errors

SENDDB

Syntax

SENDDB, <device address>

Processor response (no devices with errors)

Upload Mode started

Upload Mode Term - Errs: 0

Processor response (devices with errors exist)

Upload Mode started

Devices with invalid DBs:

<address 1>

<...>

<address N>

Upload Mode Term - Errs: <N>

Send Database to One RF Device

Parameter Description Format

device address The RF device address to send the database to address 1

... address N

The RF device addresses with errors

[processor : link : device type : device] see device address formatting description

[processor : link : device type : device] see device address formatting description

N The number of devices that did not receive the database Integer

Description

Sends the current project stored in the RF processor to one RF device (keypad, dimmer, or switch). Note: A database must be uploaded to the processor before this command will work.

After the upload mode starts, the RF Activity LEDs (TX and RX) on the RF processor will be flashing. If all RF devices have an updated database, the processor returns with no errors. Otherwise, the number and addresses of the RF devices that do not have the current project is returned.

Example 1 (success, no other devices with errors)

Send the current project stored in RF processor 1 to an RF switch addressed 4. After three seconds, the database is transferred successfully. The processor reports that all devices have an updated database.

L232> SENDDB, [01:08:01:04]

Upload Mode started

Upload Mode Term - Errs: 0

Example 2 (success, other devices with errors exist)

Send the current project stored in RF processor 1 to an RF switch addressed 4. After three seconds, the database is transferred successfully. The processor reports that three RF dimmers addressed 1, 2, and 3 still require an updated database.

L232> SENDDB, [01:08:01:04]

Upload Mode started

********

Devices with invalid DBs:

[01:08:01:01]

[01:08:01:02]

[01:08:01:03]

Upload Mode Term - Errs: 3

Example 3 (failure)

Send the current project stored in RF processor 1 to an RF switch addressed 4. After five seconds, the database transfer fails. The processor reports that three RF dimmers addressed 1, 2, and 3 and the RF switch addressed 4 still require an updated database.

L232> SENDDB, [01:08:01:04]

Upload Mode started

********

Devices with invalid DBs:

[01:08:01:01]

[01:08:01:02]

[01:08:01:03]

[01:08:01:04]

Upload Mode Term - Errs: 4

See Also

SYNCDB - Send Database to All RF Devices

RETRYDB - Send Database to All RF Devices with Errors

RFDBSTAT - Request RF Devices with Errors

GETBAUD

RS-232 only

Syntax

GETBAUD, < port address >

Processor responds with the following

RS232 port baud rate on port <port address> is <baud rate>

Parameter

port address (optional)

Description

the port address the request is for

Get RS-232 port baud rate

Format

pp:ll (see RS232 Port Addressing ) This parameter is optional. If omitted, the request will default to the port that receives the command the processor will respond with one of the following

300, 600, 1200, 2400, 4800, 9600,

19200, 38400, 57600, 115200 baud rate the RS-232 port baud rate

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 is 115200

Example

Get RS-232 port baud rate for link 7 on processor 2

L232> GETBAUD, 2:7

RS232 port baud rate on port 02:07 is 115200

See Also

SETBAUD - Set RS-232 port baud rate

GETHAND

RS-232 only

Syntax

GETHAND, <port address>

Get RS-232 port handshaking type

Processor responds with the following

RS232 port handshaking on processor <port address> is <handshaking type>

Parameter

port address (optional) handshaking type

Description

the port address the request is for the RS-232 port handshaking type

Format

pp:ll (see RS232 Port Addressing ) This parameter is optional. If omitted, the request will default to the processor that receives the command

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 is Hardware Handshaking

Example

Get RS-232 port handshaking for link 7 on processor 2

L232> GETHAND, 2:7

RS232 port handshaking on port 02:06 is None

See Also

SETHAND - Set RS-232 port handshaking type

OSREV

Syntax

OSREV

Processor responds with the following for each processor in the system

Processor <processor address> O/S Rev = <O/S Rev>

Parameter

processor address

O/S Rev

Description

The processor address

Revision number of the currently installed O/S

Description

Returns the O/S revision for all processors in the system

Example

Request the O/S revisions of a system with 3 processors

L232> OSREV

Processor 01 O/S Rev : 22

Processor 02 O/S Rev : 22

Processor 03 O/S Rev : 22

Request O/S revision

Format

1-16

1-100

RFDBSTAT

Syntax

RFDBSTAT, <processor address>

Processor response (no devices with errors)

No invalid databases

Processor response (devices with errors exist)

Devices with invalid DBs:

<address 1>

<...>

<address N>

Request RF Devices with Errors

Parameter

processor address address 1

... address N

Description

The processor address

The RF device addresses with errors

Format

1-16

[processor : link : device type : device] see device address formatting description

Description

Requests a list of all RF devices with errors on an RF processor, i.e. RF devices without an updated database. This updated database contains device specific information about the current project. It is stored in processor and is vital for the RF device to operate in the system. Note: RF dimmers and switches without an updated database will have local function only.

If all RF devices have an updated database, the processor returns with no errors. Otherwise, a list of the RF devices that do not have the current project is returned.

Example

Request all RF devices with errors on RF processor 1. The processor returns three RF dimmers addressed 1, 2, and 3 that do not have an updated database.

L232> RFDBSTAT, 1

Devices with invalid DBs:

[01:08:01:01]

[01:08:01:02]

[01:08:01:03]

Troubleshoot the communication problem with the three devices. In this example, their FASS sliders were in the OFF position.

Retry sending the current project stored in RF processor 1 to each RF device that failed (3 total). After fifteen seconds, all devices have an updated database.

L232> RETRYDB, 1

Upload Mode started

********

Upload Mode Term - Errs: 0

See Also

SYNCDB - Send Database to All RF Devices

RETRYDB - Send Database to All RF Devices with Errors

SENDDB - Send Database to One RF Device

CLEANMEM

Syntax

CLEANMEM

Clear Database Memory

Processor responds with the following.

Memory Cleaned

Description

Clears the database memory. This operation can be done in Boot Mode or OS Mode.

Boot Mode is denoted with the '>' prompt and OS Mode is denoted with the 'OSM>' prompt.

To enter OS Mode, use the command UPDATEINOS . To enter Boot Mode, use the command UPDATEOS ( Note: Boot Mode does not support

Ethernet connections).

Use the OSSTART command to get back into normal operating mode.

Example in OS Mode (recommended method)

Clear the database memory of all processors in the system (this example shows a 3 processor system).

Using an RS232 connection:

L232> UPDATEINOS

OSM> CLEANMEM, FFFF

Proc 01 Memory Cleaned.

Proc 02 Memory Cleaned.

Proc 03 Memory Cleaned.

OSM> OSSTART

Using an Ethernet connection:

LNET> UPDATEINOS

LNET:OSM> CLEANMEM, FFFF

Proc 01 Memory Cleaned.

Proc 02 Memory Cleaned.

Proc 03 Memory Cleaned.

LNET:OSM> OSSTART

Example in Boot Mode

Clear the database memory for a 3 processor system.

Using an RS232 connection:

L232> UPDATEOS

> CLEANMEM, 1

Memory Cleaned.

> CLEANMEM, 2

Memory Cleaned.

> CLEANMEM, 3

Memory Cleaned.

> OSSTART

Note: Boot mode does not support Ethernet connections!

back to the table of contents...

HELP

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> HELP,KBP

Keypad button press

Usage: KBP,<address>,<button number>

NETSTAT

Print Network Statistics

Syntax

NETSTAT

Description

The NETSTAT command gives all the information information relating to the Ethernet connection.

- IP Address – This is the address used to direct communication to the processor

- Subnet Mask – This determines the range of IP addresses allowed for the processor to be on the Local Area Network (LAN).

- Gateway – This determines the processor’s access to the outside connection. Typically this is the address of the router.

Example

Print the network statistics.

L232> NETSTAT

Processor 01:

L232> MAC Address: 00-0f-e7-00-18-93

IP Address : 10.21.3.41 (Obtained through DHCP)

Subnet Mask: 255.255.0.0

Gateway : 10.21.1.1

Telnet Port: 23

FTP Port : 21

HTTP Port : 80

Buffer HWM = 00001

Socket HWM = 00006

Successful Tx = 00817

Error Tx = 00000

Ping response: ENABLED

End of network statistics back to the table of contents...

SETIP

Set processor’s IP Address

Syntax

SETIP, processor number, xxx.xxx.xxx.xxx

Description

This command sets the IP Address of a specific processor. The IP address will not be updated until processor is reset or RESETIP command is sent.

Example

Enter:

L232> setip, 1, 192.168.1.100

Response:

Processor 01:

IP Address: 192.168.1.100

Subnet Mask: 255.255.255.0

Gateway: 192.168.1.1

Telnet Port: 23

FTP Port: 21

HTTP Port: 80

Buffer HWM: 00001

Socket HWM: 00006

Successful TX: 00048

Error TX: 00000

Successful RX: 00000

Error RX: 00000

Ping Response: ENABLED back to the table of contents...

SETGATEWAY

Set the Gateway Address

Syntax

SETGATEWAY, <processor>, <xxx.xxx.xxx.xxx>

Description

This command sets the gateway address on the given processor. The gateway address is specifically needed when the processor is on a network and / or is connected to through the Internet. The gateway address will not be updated until processor is reset or RESETIP command is sent.

Example

Enter:

L232> SETGATEWAY, 1, 192.168.1.1

Response:

Processor 01:

MAC Address: 00-0f-e7-00-18-0a

IP Address : 192.168.1.100

Subnet Mask: 255.255.255.0

Gateway : 192.168.1.1

Telnet Port: 23

FTP Port : 21

HTTP Port : 80

Buffer HWM = 00001

Socket HWM = 00006

Successful Tx = 00112

Error Tx = 00000

Successful Rx = 00000

Error Rx = 00000

Ping response: ENABLED

End of network statistics

This will not take effect until processor is reset or RESETIP command is sent

See Also

SETSUBNET

SETIP back to the table of contents...

SETSUBNET

Set processor’s subnet

Syntax

SETSUBNET, processor number, xxx.xxx.xxx.xxx

Description

This sets a processor’s subnet which will not be updated until the processor is reset or the RESETIP command is sent.

Example

Enter:

L232> SETSUBNET, 1, 255.255.255.0

Response

Processor 01:

MAC Address: 00-0f-e7-00-18-0a

IP Address : 192.168.1.100

Subnet Mask: 255.255.255.0

Gateway : 192.168.1.1

Telnet Port: 23

FTP Port : 21

HTTP Port : 80

Buffer HWM = 00001

Socket HWM = 00006

Successful Tx = 00019

Error Tx = 00000

Successful Rx = 00000

Error Rx = 00000

Ping response: ENABLED

End of network statistics back to the table of contents...

SETFTP

Syntax

SETFTP, <processor>, <port>

Description

This sets the FTP port on a specific processor to a chosen port number.

Example

Set the FTP port on the selected processor, address 1, to port 1021.

L232> SETFTP,1, 1021

Processor responds with:

Processor 01:

MAC Address: 00-0f-e7-00-18-0a

IP Address : 192.168.250.1 (Obtained through DHCP)

Subnet Mask: 255.255.255.0

Gateway : 192.168.1.1

Telnet Port: 23

FTP Port : 1021

HTTP Port : 80

Buffer HWM = 00001

Socket HWM = 00006

Successful Tx = 03406

Error Tx = 00000

Successful Rx = 00000

Error Rx = 00000

Ping response: ENABLED

End of network statistics

This will not take effect until processor is reset or RESETIP command is sent

See Also

SETTELNET back to the table of contents...

Sets the FTP port number

SETTELNET

Set Telnet port

Syntax

SETTELNET, processor number, port

Description

This command sets the Telnet port on a specific processor. The port will not be used until the processor is reset or the RESETIP command is sent.

Example

Set the Telnet port on the selected processor, address 1, to port 1023.

L232> SETTELNET, 1, 1023

Processor Response:

Processor 01:

MAC Address: 00-0f-e7-00-18-0a

IP Address : 192.168.250.1 (Obtained through DHCP)

Subnet Mask: 255.255.255.0

Gateway : 192.168.1.1

Telnet Port: 1023

FTP Port : 21

HTTP Port : 80

Buffer HWM = 00001

Socket HWM = 00006

Successful Tx = 03398

Error Tx = 00000

Successful Rx = 00000

Error Rx = 00000

Ping response: ENABLED

End of network statistics

This will not take effect until processor is reset or RESETIP command is sent back to the table of contents...

CLEARIP

Clear the processor TCP/IP settings

Syntax

CLEARIP

Description

This command is used to clear the current TCP/IP settings. They are cleared to the default settings for TCP/IP, and will not take effect until the processor is reset or RESETIP command is sent. The default settings are the following:

IP Address: 192.168.250.processor #.

Subnet Address: 255.255.255.0

Gateway: 0.0.0.0

Example

Clear the processor TCP/IP settings.

L232> CLEARIP, 1

Response:

Processor 01:

MAC Address: 00-0f-e7-00-18-0a

IP Address : 192.168.250.1 (Obtained through DHCP)

Subnet Mask: 255.255.255.0

Gateway : 0.0.0.0

Telnet Port: 23

FTP Port : 21

HTTP Port : 80

Buffer HWM = 00001

Socket HWM = 00006

Successful Tx = 03390

Error Tx = 00000

Successful Rx = 00000

Error Rx = 00000

Ping response: ENABLED

End of network statistics

This will not take effect until processor is reset or RESETIP command is sent back to the table of contents...

5.2 Boot Mode Commands

Contents

5.1.1 Specs and Formatting

5.1.2 System Commands

5.1.1 Specs and Formatting

Technical Specs

Command Format

Time Format

Date Format

5.1.2 System Commands

Port

Actions: Disable All Other Ports

Enable All Ports

Set RS232 Port Baud Rate

Set Baud Rate for Specific RS232 Port

Processor

Actions: Clean Processor's Databases

Login Processor

Requests: Check if Processor Present

Display Processor's Address

Display Processor's Serial Number

Display Processor's Status Information

System

Actions: Switch System to OS (Normal Mode)

Set Date

Set Time

Requests: Display System Date

Display System Time

Time Formatting

z z z

Time formats are used for setting the internal processor clock

When setting the system time, 24 hour format must be used

HH:MM:SS

HH = Hours

MM = Minutes

SS = Seconds z

Examples

4:23 AM = 04:23:00

3:15 PM = 15:15:00

MM / DD / YYYY

Date Formatting

z z z z z

Dates are used when setting the internal processor calendar.

The month and day must have 2 digits, and the year must have 4 digits.

American date formatting is used.

HomeWorks Illumination is year 2000 compliant.

The following format must be used for entering the date:

MM = Month

DD = Day of month

YYYY = Year z

Example

July 12, 2000 = 07/12/2000

ONEPORT

RS232 Only

Syntax

ONEPORT

Disable all other RS232 Ports

Processor Responds

>

Description

Disables all RS232 ports on the processor, except the one that receives the ONEPORT command. Disabled RS232 ports will not accept commands or transmit results.

Example

Disable all other RS232 ports

> ONEPORT

See Also

ALLPORTS - Enable all RS232 Ports

ALLPORTS

RS232 Only

Syntax

ALLPORTS

Enable all RS232 Ports

Processor Responds

>

Description

Enables all RS232 ports on this processor. All RS232 ports on this processor will now process commands and respond with results.

Example

Enable all RS232 ports on this processor

> ALLPORTS

See Also

ONEPORT - Disable all other RS232 Ports

Set the RS-232 port baud rate

Syntax

SETBAUD2, <baud rate>

Processor Response

For the new baud rate to take effect, you must cycle the processor power.

The port settings will be set to 8 data bits, No parity, 1 stop bit.

Parameter Description Format

baud rate new RS-232 port baud rate 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, or 115200

Description

Sets the baud rate for the RS232 port that receives the command. When dip switch #1 on S2 is in the up position, the processor RS232 ports 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 or

SETBAUD2 commands are 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 the RS-232 port baud rate to 57600 bps.

> SETBAUD, 57600

For the new baud rate to take effect, you must cycle the processor power.

The port settings will be set to 8 data bits, No parity, 1 stop bit.

See Also

SETBAUD2 - Set baud rate for a specific RS232 port.

STATUS - Displays the processor's status information.

SETBAUD2

Syntax

SETBAUD2, <baud rate>, <processor>, <link>

Set the RS-232 port baud rate

Processor Response

For the new baud rate to take effect, you must cycle the processor power.

The port settings will be set to 8 data bits, No parity, 1 stop bit.

Parameter Description Format

baud rate new RS-232 port baud rate 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, or 115200 processor processor number link link number

1-16

3 or 7

Description

When dip switch #1 on S2 is in the up position, the processor RS232 ports baud rate is fixed at 9600 baud. When dip switch #1 on S2 is in the down position, the processor RS232 ports baud rate will be set to the user setting determined by the SETBAUD or SETBAUD2 commands. 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 Processor 3 Link 3 baud rate to 57600 bps.

> SETBAUD2, 57600, 3, 3

For the new baud rate to take effect, you must cycle the processor power.

The port settings will be set to 8 data bits, No parity, 1 stop bit.

See Also

SETBAUD - Set baud rate for RS232 port connected to.

STATUS - Displays the processor's status information.

CLEANMEM

Deletes all of a processor's programming

Syntax

CLEANMEM, <processor address>

Processor responds with the following

Memory Cleaned

Description

Deletes all programming data from the processor's memory.

Warning

This erases all programming information. You will not be able to extract the database after this command is used.

Example

Clean the databases of the processor you are connected to.

> CLEANMEM

Memory Cleaned

Example

Clean databases of processor 2.

> CLEANMEM, 2

Memory Cleaned

LOGIN

Login to all of a processor's ports

Syntax

LOGIN, <processor address>

Processor responds with the following

Logging in processor <processor address>

OR

Already logged in processor <processor address>

Description

This will login all RS232 ports for the processor specified. If none are specified, then it will login only to the processor you are connected to.

Logging in to a processor in the Boot will result in the processor being logged in when it switches to the OS.

Example

Login to the processor that you are connected to. (Processor is currently logged out)

> LOGIN

Logging in processor 01

Example

Login processor 2. (Processor is currently logged in)

> LOGIN, 2

Already logged in processor 02

PING

Syntax

PING, <processor address>

Processor responds with the following

Processor <processor> OK

Description

Checks a remote processor to see if it is present and communicating properly

Example

Check if processor 2 is present.

> PING, 2

Processor 02 OK

See Also

PROCADDR - Displays the processor address

SERIAL - Displays the processor's serial number

STATUS - Displays the processor's status information

Check if a processor is present

PROCADDR

Syntax

PROCADDR

Processor responds with the following

Processor Address : <processor address>

Description

Displays the address of the processor you are connected to

Example

Display the address of the processor you are connected to

> PROCADDR

Processor Address : 01

See Also

PING - Check if processor is present

SERIAL - Displays the processor's serial number

STATUS - Displays the processor's status information

Display a processor's address

SERIAL

Display the processor's serial number

Syntax

SERIAL, <processor address>

Processor responds with the following

Serial on processor <processor>: <Serial Number>

Description

Each processor has a unique serial number. This command displays the serial number for a specific processor.

Example

Display the serial number of the processor you are connected to.

> SERIAL

Serial on processor 01: 1903834216,0000000174

Example

Display the serial number of processor 2.

> SERIAL, 2

Serial on processor 02: 1907896936,0000000195

See Also

PING - Check if processor is present

PROCADDR - Displays the processor address

STATUS - Displays the processor's status information

STATUS

Display the status of a processor

Syntax

STATUS, <processor address>

Processor responds with the following

---------------------------------------

Processor address : <processor address>

Build Date <date(yymmdd).time(hhmm)> of the boot build date

The time is set to: <current time>

The date is set to: <current date>

Boot flash : <PGM GOOD> or <ERASED>

Boot rev : <boot revision>

Boot upload date : <date(mmddyy)> the Boot was uploaded

OS flash : <PGM GOOD> or <ERASED>

OS rev : <OS revision>

OS upload date : <date(mmddyy)> the OS was uploaded

User baud rate : <Link 3 baud rate>, <Link 7 baud rate>

Processor is <LOGGED IN> or <LOGGED OUT>

A power cycle will start : <OS> or <BOOT>

The boot mode was : <forced via switch S1-1> or <started via command>

Description

Displays the status information for a processor. The description of each status is shown above.

Example

Display the status information for the processor you are connected to.

> STATUS

---------------------------------------

Processor address : 01

Build Date 000403.0947

The time is set to: 11:04:40

The date is set to: 04/10/00

Boot flash : PGM GOOD

Boot rev : 20

Boot upload date : 040500

OS flash : PGM GOOD

OS rev : 40

OS upload date : 040300

User baud rate : 115K, 115K

Processor is LOGGED OUT

A power cycle will start : the OS

The boot mode was : forced via switch S1-1

Example

Display the status information for processor 2.

> STATUS, 2

---------------------------------------

Processor address : 02

Build Date 000403.0947

The time is set to: 11:04:40

The date is set to: 04/10/00

Boot flash : PGM GOOD

Boot rev : 20

Boot upload date : 040500

OS flash : PGM GOOD

OS rev : 40

OS upload date : 040300

User baud rate : 115K, 115K

Processor is LOGGED OUT

A power cycle will start : the OS

The boot mode was : forced via switch S1-1

See Also

PING - Check if processor is present

PROCADDR - Displays the processor address

SERIAL - Displays the processor's serial number

OSSTART

Switches all processors to the OS mode

Syntax

OSSTART

Processor responds with the following (assuming connected to processor 1, processors 2 & 3 in the system, error messages are shown)

Processor: 02

Switching to OS

Processor: 03

Not valid OS present. Remaining in boot.

Processor: 04

Processor: 05

Processor: 06

Processor: 07

Processor: 08

Processor: 09

Processor: 10

Processor: 11

Processor: 12

Processor: 13

Processor: 14

Processor: 15

Processor: 16

Processor: 01

OS will start when S1-1 is flipped down

Description

Switches all processors to the OS Mode. If an OS is not present (as with processor 3 above) or the dip switch 1-1 is up (as with processor 1 above) then a processor will not switch to the OS.

Example

Switch all processors to OS Mode.

> OSSTART

Processor: 02

Switching to OS

Processor: 03

Switching to OS

Processor: 04

Processor: 05

Processor: 06

Processor: 07

Processor: 08

Processor: 09

Processor: 10

Processor: 11

Processor: 12

Processor: 13

Processor: 14

Processor: 15

Processor: 16

Processor: 01

Switching to OS

SD

Syntax

SD, <date>

Processor Responds (Assuming connection to processor 1, processor 2 & 3 in system)

Processor: 02

The date on processor 02 is <date>

Processor: 03

The date on processor 03 is <date>

Processor: 04

Processor: 05

Processor: 06

Processor: 07

Processor: 08

Processor: 09

Processor: 10

Processor: 11

Processor: 12

Processor: 13

Processor: 14

Processor: 15

Processor: 16

Processor: 01

The date on processor 01 is <date>

Parameter Description

date current date

Format

MM/DD/YYYY see 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, 2000

> SD, 03/10/2000

Processor: 02

The date on processor 02 is 03/10/00

Processor: 03

The date on processor 03 is 03/10/00

Processor: 04

Processor: 05

Processor: 06

Processor: 07

Processor: 08

Processor: 09

Processor: 10

Processor: 11

Processor: 12

Processor: 13

Processor: 14

Processor: 15

Processor: 16

Processor: 01

The date on processor 01 is 03/10/00

See Also

RSD - Request system date

ST - Set system time

RST - Request system time

Set Date

ST

Syntax

ST, <time>

Processor Responds (Assuming connection to processor 1, processor 2 & 3 in system)

Processor: 02

The time on processor 02 is <time>

Processor: 03

The time on processor 03 is <time>

Processor: 04

Processor: 05

Processor: 06

Processor: 07

Processor: 08

Processor: 09

Processor: 10

Processor: 11

Processor: 12

Processor: 13

Processor: 14

Processor: 15

Processor: 16

Processor: 01

The time on processor 01 is <time>

Parameter Description

time current time of day in 24 hour format

Description

Sets the system time. This will update the time on all processors in the system.

Example

Set the time to 08:04 PM

> ST, 20:04:00

Processor: 02

The time on processor 02 is 20:04:00

Processor: 03

The time on processor 03 is 20:04:00

Processor: 04

Processor: 05

Processor: 06

Processor: 07

Processor: 08

Processor: 09

Processor: 10

Processor: 11

Processor: 12

Processor: 13

Processor: 14

Processor: 15

Processor: 16

Processor: 01

The time on processor 01 is 20:04:00

See Also

RST - Request system time

SD - Set system date

RSD - Request system date

Format

HH:MM:SS in 24 Hour format see time address formatting description the seconds must be specified

Set time

RSD

Syntax

RSD

Processor Responds

The date on processor <processor address> is <date>

Description

Queries the current system date

Example

Request the system date

> RSD

The date on processor 01 is 04/10/00

See Also

SD - Set system date

ST - Set system time

RST - Request system time

Request system date

RST

Syntax

RST

Processor Responds

The time on processor <processor address> is <time>

Description

Queries the current time for the processor you are connected to

Example

Request the processor's time

> RST

The time on processor 01 is 14:04:46

See Also

ST - Set system time

SD - Set system date

RSD - Request system date

Request the system time

advertisement

Was this manual useful for you? Yes No
Thank you for your participation!

* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project

Related manuals

Download PDF

advertisement