Command and Response Message Format

Transcription

1 Date: Mar 31, 2000 Subject: Lightolier Controls Proprietary 232/485 Communications Protocols The Lightolier Controls Proprietary 232/485 Communications Protocols are defined in this document. The products that comply with these protocols are as follows: UNIT DESCRIPTION RS232 RS485 MS232 RS232 Multiset Unit CL232 RS232 Compli Lytemode Unit WB232 RS232 Unit BRMSM Brilliance II Multiset card BRSYS Brilliance II Compli Lytemode card BRRLY Brilliance II Relay card BRCOMM Brilliance II PC Comm card BM6R/BM8R Brilliance II Master Control Unit The protocol is designed around a simple ASCII command set. All units are designed to either respond to a command issued by the Host Computer (or Controller) or send a status response if its status has changed. Units that have an RS232 interface will echo all commands and responses on the RS485 network to the connected Computer. The units with an RS232 interface have been programmed to isolate the Computer and serve as a gateway into the internal RS485 network. Since the RS485 network has strict communications requirements such as collision avoidance and recovery, timing constraints, and network pacing rules, the preferred and easiest way to connect to these Lightolier Controls products is by the RS232 interface. Command and Response Message Format This next section is designed to provide insight into the command and response message formats. All RS232 and RS485 commands and responses conform to the following format: ##QC<cr> Where: ## - Is the Unit ID in the form of 2 ASCII number characters ( 0 to 9 ). Unit IDs of 0 to 9 must be expressed as 00 to 09. Valid Unit IDs are from 00 to 31 with 99 reserved as a Global Unit ID. The Brilliance II, valid Unit IDs are from 00 to 63 and 99. Q - Is the Command/Response Qualifier. It is used to further define the command. Any non numeric character (not 0 to 9 ) can be used as a qualifier. If not included, the message is 4 characters in length. If included, the message is 5 characters in length and the command/response is further defined based on the type of qualifier used. C - Command/Response character describes the primary action to take. <cr> - Carriage Return (0DH) is used to signal the end of the command/response message. Samples of commands and responses using this format are as follows: 03A<cr> 03IA<cr> 21FN<cr> - Causes unit 3 to fade to its A scene at its normal fade rate. - Unit 3 will respond with a 03a<cr> - Causes unit 3 to fade to its A scene at its rapid rate. - Unit 3 will respond with a 03a<cr> - Causes unit 21 to start a fade On. 1

2 21FS<cr> 11V<cr> 99X<cr> - Unit 21 will respond with a 21n<cr> - Causes unit 21 to stop any fades. - Unit 21 will not respond. - Causes unit 11 to return its software verson. - A 11bv<cr> response decodes as version 2. - Causes all units (global) to fade Off. - All units will respond with a ##x<cr> (## = unit number). Future commands can be added as long as they are 4 (no qualifier) or 5 (qualifier) bytes in length. Each unit must be programmed to ignore any command it cannot directly use. Commands that send values can be added to the set such as an through jn to increase brightness by 10% through 100% (this causes an MS232 to output an ON pulse for.3 sec through 3.0 sec). Commands ax through jx will decrease brightness in the same way. An alternative method of sending higher precision command values (0 to 100) is to define the Qualifier as an ASCII value greater then 127. Qualifier ASCII values 128 through 228 are used to send values 0 through 100. This can be done when a computer program is sending the commands and not just a dumb terminal. At present only ASCII characters are used (values < 128). 2

3 RS232 Communications The RS232 interface is designed for 8 bits, no parity, 1 stop bit. Selectable baud rates are 1200, 2400, 4800, and 9600 baud. Lower baud rates allow longer cable lengths while higher baud rates require shorter cables. The following table can be used to as a general rule of thumb for selecting baud rates and cable length. Baud Max distance Max distance Rate (Shielded cable) (Unshielded cable) ft 1000 ft ft 500 ft ft 250 ft ft 125 ft These units are designed to interface to a standard PC using a 9 wire serial communications cable (although only 4 signals are used). A 4 wire cable can be made as follows: RS232 DB9 RS232 DB9 PC Male Conn Female Conn Signal Receive Transmit Ground Clear to Send Since the RS485 network operates at a fixed 4800 baud rate, several things need to be noted when a computer attaches to the RS232 port. At baud rates of 1200 and 2400 baud, some responses may be lost whenever global commands are sent or 32 units all change states within a one second window (most unlikely). To overcome this limitation, don t send global commands in installations of 10 or more units. Use only commands that address specific units. If the computer is connected to a unit with a low Unit ID (1-10) it can send out pacing characters on the RS485 network to slow it down and avoid missing responses at these low baud rates. At 9600 baud, it is possible that the attached computer can overrun the buffer on the MS232. A CTS signal (DB9 pin 8) is sent back to the attached computer to halt communications until buffer space is available. The computer should use the CTS signal whenever possible. 3

4 RS485 Communications The internal RS485 interface is designed for 4800 baud, 8 bits, no parity, and 1 stop bit. Each unit that connects to the network will have its own unique Unit ID (0 to 31) (0 to 63 for Brilliance II). To help prevent collisions and better manage traffic the network is designed to provide each unit a specific time slot for gaining access to the network. When a unit needs to access the network it will wait for its time slot (based on its Unit ID) and start transmitting. It may continue transmitting until all of its messages have been sent. Every character that is transmitted on the network is used to re-sync all units to the network timing. More specific, when a unit sees any communication activity on the network it will set its network timer to 5.08 ms. This will allow a transmitting unit to hold onto the network an additional 5 ms before releasing it to the other units. This timer will be allowed to count down only when communication activity has stopped. At this time all units will wait for their unique time slot (0.988 ms times its Unit ID) before transmitting any message on the network. Transmit Slot = 5.08 ms + (0.988 ms X Unit ID) Note: While the attempt was made to have even 5 ms and 1 ms timings, due to crystal and processor timing constraints the above calculation is based on actual timings of the MS232 and CL232 units. All future units should use these timings whenever possible. Example: Unit 0 will wait 5.08 ms while Unit 31 will wait ms to start a transmission. traffic 5.08 ms delay series of ms delays //////// Time Slots => / = Network traffic - =.247 ms = Available time slot These time slots will continue to cycle (time slot 0 will follow time slot 31 by ms) until a new message is sent. Each unit s time slot will cycle every ms (32 * ms). In high traffic environments, this keeps all units in sync and prevents any collisions from occurring. The only possibility of a collision is when, after a period of long inactivity on the network, two units have their time slots drift to become in sync. All units will therefore sample the network one last time before starting a transmission (this provides additional collision protection). If both sample the network and find it inactive and then start a transmission a collision would occur. While the probability of a collision is still present, it should be very rare. To guarantee an absolute collision free network, an attached computer, or PC Interface card could transmit either a sync character every minute to keep all units in sync, or send out a single sync character, then wait 2 to 3 ms prior to sending any commands. A sync character can be any ASCII character such as a. or <cr>. After receiving this sync character all units will ignore it, but immediately fall into a collision free timing sync. 4

5 Since units with low Unit IDs will have quicker access to the network during high traffic situations, network control devices such as PC s should be given low Unit IDs. Unit ID 00 is reserved for an attached network computer (or a CL232 stand alone unit). Once network activity has stopped for 40 ms or more, network access should be evenly distributed. Note: In order to work within the above network constraints, BM6R/BM8R devices when added to the RS485 network will subtract 32 from their Unit ID and then offset the result by an additional ms (0.988 ms / 2). This allows a total of 64 units on the network. They will use the following network access calculation: Transmit Slot = ( ) ms + (0.988 ms X (Unit ID-32)) Because as many as 64 devices can be connected to the network low load RS485 receivers are used in Brilliance II cards and BM6R/BM8R remote switch units. 5

6 Command and Responses The following sections define the command and responses by product. MS232 / CL232 / WB232 / BRMSM / BRSYS Commands and Responses COMMAND ACTION RESPONSE ##N 1 ON Scene (Fade) ##n ##IN 1 ON Scene (Instant) ##n ##A A Scene (Fade) ##a ##IA A Scene (Instant) ##a ##B B Scene (Fade) ##b ##IB B Scene (Instant) ##b ##C C Scene (Fade) ##c ##IC C Scene (Instant) ##c ##D D Scene (Fade) ##d ##ID D Scene (Instant) ##d ##E E Scene (Fade) ##e ##IE E Scene (Instant) ##e ##F F Scene (Fade) ##f ##IF F Scene (Instant) ##f ##G G Scene (Fade) ##g ##IG G Scene (Instant) ##g ##H H Scene (Fade) ##h ##IH H Scene (Instant) ##h ##I I Scene (Fade) ##i ##II I Scene (Instant) ##i ##J J Scene (Fade) ##j ##IJ J Scene (Instant) ##j ##K K Scene (Fade) ##k ##IK K Scene (Instant) ##k ##L L Scene (Fade) ##l ##IL L Scene (Instant) ##l ##X 1 OFF Scene (Fade) ##x ##IX 1 OFF Scene (Instant) ##x ##FN Begin Fade ON ##n ##FX Begin Fade OFF ##n, (##x if ##FS follows to quickly) ##FS Stop any fading No Response Note: If the ##FS command is transmitted within.3 seconds after either the ##FN or the ##FX command, the attached MS5 s will interpret the resulting purple wire signal as a Tap instead of a Hold signal. When an MS5 senses a Tap it will react as if it received a ##N, or ##X, command. 6

7 MS232 / CL232 / WB232 / BRMSM / BRSYS Commands and Responses (continued) COMMAND ACTION RESPONSE ##an Raise unit 5% ##n (or No Response) ##bn Raise unit 10% ##n (or No Response)... ##tn Raise unit 100% ##n (or No Response) ##ax Lower unit 5% ##n (or No Response) ##bx Lower unit 10% ##n (or No Response)... ##tx Lower unit 100% ##n (or No Response) ##V 1 Return Version Returns the system Version ##av = Version 1, ##bv = Version 2,... ##zv = Version 26 Additional Model information MAY be returned ##Av = MS232 ##Bv = BRMSM ##Cv, ##Dv = Not Defined ##Ev = CL232 ##Fv = BRSYS ##Gv, ##Hv = Not Defined ##Iv = WB232 ##Jv = BRRLY ##Kv, ##Lv = Not Defined ##Mv = BM6R ##Nv = BM8R ##Ov, ##Pv = Not Defined ##Qv = BRTCLK ##Rv = BRCOMM ##Sv - ##Zv = Not Defined ##? 1 Poll status Returns one of the above responses as status Note 1: These commands are the only WB232 valid commands Note 2: ## defines a unique Unit ID. Valid ranges are 01 to 31 (00 to 63 for Brilliance II). A global command is issued when ## = 99. When a global command is issued, all units will respond. 7

8 CL232 / BRSYS Additional Commands and Responses COMMAND ACTION RESPONSE ##S Simulates pressing Set button No Response ##RU Simulates pressing Fade Up button No Response ##RD Simulates pressing Fade Down button No Response ##ac Selects channel 1 No Response ##bc Selects channel 2 No Response... ##pc Selects channel 16 No Response Note: The next command received will apply to the selected channel only. Acceptable next commands are ##FN, ##FX, ##an - ##tn, ##ax - ##tx. A ##FS command does not require the Select Channel Command. CL232 Additional Commands and Responses ##QN Remote ON Scene ##n ##QA Remote A Scene ##a ##QB Remote B Scene ##b ##QC Remote C Scene ##c ##QD Remote D Scene ##d ##QE Remote E Scene ##e ##QF Remote F Scene ##f ##QG Remote G Scene ##g ##QH Remote H Scene ##h ##QI Remote I Scene ##i ##QJ Remote J Scene ##j ##QK Remote K Scene ##k ##QL Remote L Scene ##l ##QX Remote OFF Scene ##x ##GR Begin Remote Fade ON No Response ##GL Begin Remote Fade OFF ##GS Stop any Remote fading Note: CL232 s and BRSYS s have an additional response. When they receive a command that requires a fade, they will issue a ##z response when the fade has completed. This can be used by the network computer to time when the next fade command can be issued since only one fade command can take place at a time. 8

9 BRRLY Commands and Responses The BRRLY card contains 4 Relays and 4 Inputs. There can be up to 2 relay cards in a Brilliance II system (one per cabinet). The Primary/Secondary cabinet card has an ID of 31/32. Each Relay and Input has an LED and a pushbutton switch associated with it that is used to display, program, and toggle its state. The board also has 6 DIP Switches. Switches 1-4 are used to modify the action of the 4 Inputs (DIPSW 1 modifies Input 1, etc.). Switch 5 is not used. Switch 6 is used to control the Display Mode of the 4 Input LEDs. When Switch 6 is OFF, each Input LED will turn ON when its associated Input is shorted to GND, or OFF when its associated Input is released from GND. When switch 6 is ON, all Input LEDs will turn ON or OFF based on their Scene, Room, or Phantom rules. The following table describes the various modes of the Relays and Inputs. Input/ Modifying DIPSW Output Mode DIPSW Setting Action Relay 1-4 Pulse Pulses ON for 1/2 Sec then OFF. Relay 1-4 Latch Can be latched ON or latched OFF. Input 1-4 Scene 0 SW1-4 OFF High to Low (shorted to GND) sends its Command String. Input 1-4 Scene 1 SW1-4 ON High to Low (shorted to GND) Reads present (Alarm) Network Status and then sends out its Command String. Low to High (released from GND) restores the previous Network Status. Input 1-4 Room 0 SW1-4 OFF High to Low (shorted to GND) toggles between sending out its Command String or its OFF Command String. Input 1-4 Room 1 SW1-4 ON High to Low (shorted to GND) sends its Command String. Low to High (released from GND) sends its OFF Command String. Input 1-4 Phantom 0/1 High to Low (shorted to GND) sends its LED ON response. Low to High (released from GND) sends its LED OFF response. The following responses are sent whenever a Relay or Input pushbutton switch is pressed, or when an Input or DIP switch changes state. They are also used in any Read or Store Command as part of the transmitted string. The DIPSW responses are read only and cannot be changed through programming. The Relay/Input LED Status responses are sent whenever the LED changes state, an Input String is transmitted COMMAND ACTION RESPONSE The following responses will be sent whenever a pushbutton is pressed, an Input changes status, or as part of a Read/Store String command. Relay 1 Mode Relay 2 Mode Relay 3 Mode Relay 4 Mode Input 1 Mode Input 2 Mode Input 3 Mode Input 4 Mode ##Ar, ##Er (Pulse, Latch) ##Br, ##Fr (Pulse, Latch) ##Cr, ##Gr (Pulse, Latch) ##Dr, ##Hr (Pulse, Latch) ##Ir, ##Mr, ##Qr (Scene, Room, Phantom) ##Jr, ##Nr, ##Rr (Scene, Room, Phantom) ##Kr, ##Or, ##Sr (Scene, Room, Phantom) ##Lr, ##Pr, ##Tr (Scene, Room, Phantom) 9

10 COMMAND ACTION RESPONSE The following Status (or LED) responses will be sent whenever a pushbutton is pressed, an Input changes state (shorted to GND or released from GND), a Relay ON/OFF command is received or the Return Switch LED Status (##* ) is received. Relay 1 Status (LED) Relay 2 Status (LED) Relay 3 Status (LED) Relay 4 Status (LED) Input 1 Status (Input) Input 2 Status (Input) Input 3 Status (Input) Input 4 Status (Input) DIPSW 1 Status (OFF/ON) DIPSW 2 Status (OFF/ON) DIPSW 3 Status (OFF/ON) DIPSW 4 Status (OFF/ON) ##ar, ##er (OFF, ON) ##br, ##fr (OFF, ON) ##cr, ##gr (OFF, ON) ##dr, ##hr (OFF, ON) ##ir, ##mr (Released, Shorted to GND) ##jr, ##nr (Released, Shorted to GND) ##kr, ##or (Released, Shorted to GND) ##lr, ##pr (Released, Shorted to GND) ##qr, ##ur (OFF, ON) ##rr, ##vr (OFF, ON) ##sr, ##wr (OFF, ON) ##tr, ##xr (OFF, ON) The following commands are used to turn the Relays ON, and OFF. If a relay is programmed as Pulsed, a Relay OFF or ON command will cause it to pulse. ##AR Turn Relay 1 OFF ##ar, ##er ##ar Relay 1 OFF, Pulsed ##BR Turn Relay 2 OFF ##br, ##fr ##br Relay 2 OFF, Pulsed ##CR Turn Relay 3 OFF ##cr, ##gr ##cr Relay 3 OFF, Pulsed ##DR Turn Relay 4 OFF ##dr, ##hr ##dr Relay 4 OFF, Pulsed ##ER Turn Relay 1 ON ##er, ##er ##ar Relay 1 ON, Pulsed ##FR Turn Relay 2 ON ##fr, ##fr ##br Relay 2 ON, Pulsed ##GR Turn Relay 3 ON ##gr, ##gr ##cr Relay 3 ON, Pulsed ##HR Turn Relay 4 ON ##hr, ##hr ##dr Relay 4 ON, Pulsed The following commands will return the present status of the associated Input. If the selected Input is programmed as a Phantom Mode, the following commands will turn the LED OFF or ON (DIPSW 6 must be ON). They are used as part of a command string to indicate a desired action. A master device programmed to turn ON its LED whenever Input 1's LED is turned ON will include 31MR as part of its programmed string. ##IR Input 1 Status (OFF) ##ir, ##mr Inp 1 Released, Shorted to GND ##JR Input 2 Status (OFF) ##jr, ##nr Inp 2 Released, Shorted to GND ##KR Input 3 Status (OFF) ##kr, ##or Inp 3 Released, Shorted to GND ##LR Input 4 Status (OFF) ##lr, ##pr Inp 4 Released, Shorted to GND ##MR Input 1 Status (ON) ##ir, ##mr Inp 1 Released, Shorted to GND ##NR Input 2 Status (ON) ##jr, ##nr Inp 2 Released, Shorted to GND ##OR Input 3 Status (ON) ##kr, ##or Inp 3 Released, Shorted to GND ##PR Input 4 Status (ON) ##lr, ##pr Inp 4 Released, Shorted to GND 10

11 COMMAND ACTION RESPONSE The following commands are used to read the Mode and Command String stored for each Input. The ##ur Command is used to read the Mode of all 4 Relays. ##qr Read Input 1 Command Transmits Input 1 Command String. ##rr Read Input 2 Command Transmits Input 2 Command String. ##sr Read Input 3 Command Transmits Input 3 Command String. ##tr Read Input 4 Command Transmits Input 4 Command String. ##ur Read Relay 1-4 Command Transmits Relay 1-4 Mode String. The following commands are used to store the Mode and Command String for each Input. The ##UR Command is used to store the Mode for all 4 Relays. ##QR Store Input 1 Command ##z after string has been stored. ##RR Store Input 1 Command ##z after string has been stored. ##SR Store Input 1 Command ##z after string has been stored. ##TR Store Input 1 Command ##z after string has been stored. ##UR Store Relay 1-4 Command ##z after string has been stored. When the ##* command is received, the status of all 8 LED s and 4 DIP Switches will be returned. ##* Return all Relay/Input/DIP Switch LED Status. When the ##Q command is received, all Relay OFF/ON commands sent within the next 2 seconds will NOT return the relay s present state OR its Pulsed/Latched mode. This option is NOT available in version 1.0 of the Relay code, but is available in all versions from 2.0 and later. See examples for its effect on Relay responses. ##Q Disables sending Relay present status and mode prior to executing any Relay OFF/ON commands during the next 2 seconds. The following commands/responses are used to indicate the Start of a string of commands/responses and the End of the string. ##zr ##ZR Start of String. This Command/Response is required to disable other Relay boards or BMR s from processing the following string sequence as valid scene changes. The units will stop processing for the next 2 seconds or until a ##ZR is received. End of String Examples (all commands assume ID=31) Action: Relay 1 pushbutton switch is pressed (Relay 1 is in Pulse Mode) Response: 31ar 31Ar 31er 31ar (Relay LED 1 was OFF, Relay is in Pulse Mode, LED 1 (and Relay 1) pulses OFF then back ON) Action: Relay 1 pushbutton switch is pressed (Relay 1 is in Latch Mode) Response: 31er 31Er 31ar (Relay LED 1 was ON, Relay is in Latch Mode, LED 1 (and Relay 1) turns OFF) 11

12 Action: Relay 1 is turned OFF by a 31AR command (Relay 1 is in Latch Mode) Response: 31er 31Er 31ar (Relay LED 1 was ON, Relay is in Latch Mode, LED 1 (and Relay 1) turns OFF) Action: Relay 1 is turned OFF by the 31Q 31AR commands (Relay 1 is in Latch Mode) Response: 31ar (LED 1 (and Relay 1) turns OFF) Action: Relay 1 is turned ON by a 31ER command (Relay 1 is in Pulse Mode) Response: 31ar 31Ar 31er 31ar (Relay LED 1 was OFF, Relay is in Pulse Mode, LED 1 (and Relay 1) turns ON, LED 1 (and Relay 1) turns OFF) Action: Relay 1 is turned ON by the 31Q 31ER commands (Relay 1 is in Pulse Mode) Response: 31er 31ar (LED 1 (and Relay 1) turns ON, LED 1 (and Relay 1) turns OFF) Action: Relay 1 is turned OFF by a 31AR command (Relay 1 is in Pulse Mode) Response: 31ar 31Ar 31er 31ar (Relay LED 1 was OFF, Relay is in Pulse Mode, LED 1 (and Relay 1) turns ON, LED 1 (and Relay 1) turns OFF) Action: Relay 1 is turned OFF by the 31Q 31AR commands (Relay 1 is in Pulse Mode) Response: 31er 31ar (LED 1 (and Relay 1) turns ON, LED 1 (and Relay 1) turns OFF) Action: Input 1 is pulled low (turned ON) (Input 1 is in Scene 0 Mode) Response: 31ir 31Ir 01A 03A 31mr (LED 1 was OFF, Rooms 1 and 3 to Scene A, LED 1 ON) Action: After the above action, Room 1 is turned to a B scene (receives a 01b ) Response: No response is sent since Input 1 is still ON Action: After the above action, Input 1 is released (turned OFF) Response: 31ir (LED 1 OFF) Action: Input 1 is pulled low (turned ON) (Input 1 is in Scene 1 Mode, Rooms 1 and 3 are in Scenes D and OFF) Response: 31ir 31Ir 01IN 03IN 31mr (LED 1 was OFF, Rooms 1 and 3 to Instant ON Scene LED 1 ON) Action: After the above action, Input 1 is released (turned OFF) Response: 31mr 31Ir 01D 03X 31ir (LED 1 was ON, Rooms 1 and 3 to D and OFF Scene LED 1 OFF) Action: Input 1 is pulled low (turned ON) (Input 1 is in Room 0 Mode) Response: 31ir 31Mr 01A 03B 31mr (LED 1 was OFF, Rooms 1 and 3 to scene A and B, LED 1 ON) Action: After the above action, Input 1 is released (turned OFF) Response: 31ir (LED 1 was OFF) Action: After the above action, Input 1 is pulled low again (turned ON) Response: 31mr 31Mr 01X 03X 31mr (LED 1 was ON, Rooms 1 and 3 to OFF scene, LED 1 ON) Action: After the above action, Input 1 is released (turned OFF) Response: 31ir (LED 1 was OFF) Action: Input 1 is pulled low (turned ON) (Input 1 is in Room 1 Mode) Response: 31ir 31Mr 01A 03B 31mr (LED 1 was OFF, Rooms 1 and 3 to scene A and B, LED 1 ON) Action: After the above action, Input 1 is released (turned OFF) Response: 31mr 31Mr 01X 03X 31ir (LED 1 was ON, Rooms 1 and 3 to OFF scene, LED 1 OFF) Action: 31* Return Switch LED command received 12

13 Response: 31ir 31nr 31kr 31pr 31ar 31fr 31cr 31hr 31qr 31rr 31wr 31xr (Input LED s 1/2/3/4 are OFF/ON/OFF/ON, Relay LED s 1/2/3/4 are OFF/ON/OFF/ON, DIP Switches 1/2/3/4 are OFF/OFF/ON/ON) Action: 31qR Read Input 1 Command String Response: 31zR 31Ir 01a 03a 31ZR (Start of String, Input 1 is in Scene mode, Rooms 1 and 3 set to Scene A, End of String) Action: 31uR Read Relays 1-4 Command String Response: 31zR 31Ar 31Br 31Gr 31Hr 31ZR (Start of String, Relays 1/2/3/4 are set Pulse/Pulse/Latched/Latched mode, End of String) Action: 31QR 31zR 31Ir 01a 03a 31ZR (Store Input 1 Command String, Start of String, Scene Mode, Rooms 1 and 3 set to Scene A, End of String) Response: 31z (EEPROM has been updated) Action: 31UR 31zR 31Ar 31Br 31Gr 31Hr 31ZR (Start of String, Set Relays 1/2/3/4 to Pulse/Pulse/Latched/Latched mode, End of String) Response: 31z (EEPROM has been updated) Action: 31? or 99? (Poll Command received) Response: 31a 13

14 BM6R/BM8R Commands and Responses BM6R s and BM8R s have valid Unit IDs of 33 to 62. COMMAND ACTION RESPONSE The following responses will be sent whenever a pushbutton is pressed, an LED ON/OFF command is received, or as part of a Read/Store String command. Switch 1 pressed (ON/E) Switch 2 pressed (OFF/F) Switch 3 pressed (A/G) Switch 4 pressed (B/H) Switch 5 pressed (C/I) Switch 6 pressed (D/J) Switch 7 pressed (Raise/K) Switch 8 pressed (Lower/L) ##Am ##Im ##Qm (Scene, Room, Phantom) ##Bm ##Jm ##Rm (Scene, Room, Phantom) ##Cm ##Km ##Sm (Scene, Room, Phantom) ##Dm ##Lm ##Tm (Scene, Room, Phantom) ##Em ##Mm ##Um (Scene, Room, Phantom) ##Fm ##Nm ##Vm (Scene, Room, Phantom) ##Gm ##Om ##Wm (Scene, Room, Phantom) ##Hm ##Pm ##Xm (Scene, Room, Phantom) The following Status (or LED) responses will be sent whenever a pushbutton is pressed, an LED changes status, or the Return Switch LED Status (##* ) is received. LED 1 Status (LED) LED 2 Status (LED) LED 3 Status (LED) LED 4 Status (LED) LED 5 Status (LED) LED 6 Status (LED) LED 7 Status (LED) LED 8 Status (LED) ##am, ##im (OFF, ON) ##bm, ##jm (OFF, ON) ##cm, ##km (OFF, ON) ##dm, ##lm (OFF, ON) ##em, ##mm (OFF, ON) ##fm, ##nm (OFF, ON) ##gm, ##om (OFF, ON) ##hm, ##pm (OFF, ON) The following 8 commands will turn the selected LED OFF if the switch is in the Phantom Mode. If the Phantom LED was ON prior to receiving the LED OFF command, the LED OFF response will be returned. These commands will be ignored and no response returned if the switch is in the Scene or Room Mode. ##am Turn Switch 1 LED OFF ##am (OFF) ##bm Turn Switch 2 LED OFF ##bm (OFF) ##cm Turn Switch 3 LED OFF ##cm (OFF) ##dm Turn Switch 4 LED OFF ##dm (OFF) ##em Turn Switch 5 LED OFF ##em (OFF) ##fm Turn Switch 6 LED OFF ##fm (OFF) ##gm Turn Switch 7 LED OFF ##gm (OFF) ##hm Turn Switch 8 LED OFF ##hm (OFF) 14

15 COMMAND ACTION RESPONSE The following 8 commands will turn the selected LED ON if the switch is in the Phantom Mode. If the Phantom LED was OFF prior to receiving the LED ON command, the LED ON response will be returned. If the selected Switch is in the Scene or Room Mode, these commands will activate the selected switch (send out its command string). ##AM Turn Switch 1 LED ON Turns LED 1 ON or Activates Switch 1 ##BM Turn Switch 2 LED ON Turns LED 2 ON or Activates Switch 2 ##CM Turn Switch 3 LED ON Turns LED 3 ON or Activates Switch 3 ##DM Turn Switch 4 LED ON Turns LED 4 ON or Activates Switch 4 ##EM Turn Switch 5 LED ON Turns LED 5 ON or Activates Switch 4 ##FM Turn Switch 6 LED ON Turns LED 6 ON or Activates Switch 5 ##GM Turn Switch 7 LED ON Turns LED 7 ON or Activates Switch 6 ##HM Turn Switch 8 LED ON Turns LED 8 ON or Activates Switch 7 The following commands are used to read the Mode and Command String stored for each switch. ##im Read Switch 1 Command Transmits Switch 1 Response String. ##jm Read Switch 2 Command Transmits Switch 2 Response String. ##km Read Switch 3 Command Transmits Switch 3 Response String. ##lm Read Switch 4 Command Transmits Switch 4 Response String. ##mm Read Switch 5 Command Transmits Switch 5 Response String. ##nm Read Switch 6 Command Transmits Switch 6 Response String. ##om Read Switch 7 Command Transmits Switch 7 Response String. ##pm Read Switch 8 Command Transmits Switch 8 Response String. The following commands are used to store the Mode and Command String stored for each switch. ##IM Store Switch 1 Command ##z when String stored to EEPROM ##JM Store Switch 2 Command ##z when String stored to EEPROM ##KM Store Switch 3 Command ##z when String stored to EEPROM ##LM Store Switch 4 Command ##z when String stored to EEPROM ##MM Store Switch 5 Command ##z when String stored to EEPROM ##NM Store Switch 6 Command ##z when String stored to EEPROM ##OM Store Switch 7 Command ##z when String stored to EEPROM ##PM Store Switch 8 Command ##z when String stored to EEPROM When the ##* command is received, the status of all 8 LED s will be returned. ##* Return Switch LED Status When the ##Q command is received, all Switch ON commands sent within the next 2 seconds will NOT return the switch LED s present status OR its Pulsed/Latched mode. This option is NOT available in version 1.0 of the code, but is available in all versions from 2.0 and later. See examples for its effect on Switch responses. ##Q Disables sending Switch present status and mode prior to executing any LED OFF/ON commands during the next 2 seconds. 15

16 COMMAND ACTION RESPONSE The following commands/responses are used to indicate the Start of a string of commands/responses and the End of the string. ##zm ##ZM Start of String. This Command/Response is required to disable other Relay boards or BMR s from processing the following string sequence as valid scene changes. The units will stop processing for the next 2 seconds or until a ##ZR is received. End of String Examples (all commands assume ID=33 and BMR6 Action: ON Switch is pressed or the ##AM Command is received (ON Switch is in the Scene Mode) Response: 33am 33Am 01A 03A 33im (ON Switch was OFF, ON Switch is in the Scene Mode, Rooms 1 and 3 are set to the A Scene, ON Switch is now ON) Action: ON Switch is pressed or the ##AM Command is received (##Q Command NOT sent) (ON Switch is in the Room Mode) Response: 33am 33Im 01A 03A 33im (ON Switch was OFF, ON Switch is in the Room Mode, Rooms 1 and 3 are set to the A Scene, ON Switch is now ON) Action: After the above action, the ON Switch is pressed or the ##AM Command is received again Response: 33im 33Im 01X 03X 33am (ON Switch was ON, ON Switch is in the Room Mode, Rooms 1 and 3 are set to the OFF Scene, ON Switch is now OFF) Action: The ##Q, ##AM Commands are received (ON Switch is in the Room Mode) Response: 01A 03A 33im (Rooms 1 and 3 are set to the A Scene, ON Switch is now ON) Action: After the above action, the ##Q, ##AM Commands are received again Response: 01X 03X 33am (Rooms 1 and 3 are set to the OFF Scene, ON Switch is now OFF) Action: ON Switch is pressed or the ##AM Command is received (##Q Command NOT sent) (ON Switch is in the Phantom Mode and its LED is presently OFF) Response: 33am 33Qm 33im (ON Switch was OFF, ON Switch is in the Phantom Mode, ON Switch is now ON) Action: After the above action, the ##AM Command is received again Response: 33am 33Qm (ON Switch was ON, ON Switch is in the Phantom Mode) Action: The ##Q, ##AM Commands are received (ON Switch is in the Phantom Mode and its LED is presently OFF) Response: 33im (ON Switch is now ON) Action: After the above action, the ##Q, ##AM Commands are received again Response: no response (LED did not change status) Action: The 33* Command is received Response: 33am 33jm 33cm 33lm 33em 33nm (ON/OFF/A/B/C/D LED s are OFF/ON/OFF/ON/OFF/ON) 16

17 Action: 33iM Read Switch 1 Command String Response: 33zM 33Am 01a 03a 31ZM (Start of String, Switch 1 is in Scene mode, Rooms 1 and 3 set to Scene A, End of String) Action: 33IM 33zM 33Am 01a 03a 33ZM (Store Switch 1 Command String, Start of String, Scene Mode, Rooms 1 and 3 set to Scene A, End of String) Response: 33z (EEPROM has been updated) Action: 33? or 99? (Poll Command received) Response: 33a (BM6R) or 33b (BM8R) or 33c (BM6R-Classic) or 33d (BM8R Classic) 17

18 BRRLY/BM6R/BM8R Quiet Command (Version 2) When the BRRLY, BM6R and BM8R code was first released (version 1.0 code), the Turn Relay OFF/ON commands (##AR, ##BR, ##CR, ##DR, ##ER, ##FR, ##GR, ##HR ) and the Turn Switch LED ON commands (##AM, ##BM, ##CM, ##DM, ##EM, ##FM, ##GM, ##HM ) were designed to simulate the press of a switch. The response would always start with the present state of the LED, followed by the Relay or Switch Mode. This allowed control code to track any switch activations. When control code was developed to use this feature, several unplanned side effects were noted. Relay side effects: 1 User taps a relay indicator on a PC screen that presently shows the relay OFF (indicator OFF) 2 Computer turns indicator ON (showing tap was processed) 3 Computer sends 31ER command to latch relay 1 ON (Primary Relay Card) 4 Relay card first returns 31ar (Relay/LED presently OFF) 4a This causes PC to turn relay indicator back OFF 5 Relay card next returns 31Er (Relay in Latch Mode) 6 Relay card next returns 31er (Relay/LED now ON) 6a This causes PC to turn relay indicator back ON The effect to the user will be an indicator that blips ON then OFF then back ON. While this is a visual nuisance, any control code that looks for the relay switching from ON to OFF will mistakenly execute. BM6/8R side effects: 1 User taps a Master Phantom switch indicator on a PC screen that presently shows the LED is OFF 2 Computer turns Master switch indicator ON (showing tap was processed) 3 Computer sends 33AM command to turn Switch/LED 1 ON (ID = 33) 4 Master first returns 33am (LED presently OFF) 4a This causes PC to turn Master switch indicator back OFF 5 Master next returns 33Qm (Switch in Phantom Mode) 6 Master next returns 33im (LED now ON) 6a This causes PC to turn the Master switch indicator back ON The effect to the user will be an indicator that blips ON then OFF then back ON. While this is a visual nuisance, any control code that looks for the switch switching from ON to OFF will mistakenly execute. BM6/8R side effects (LED toggle): 1 User presses a Master s Phantom switch (LED OFF) to indicate they want the feature to be enabled (LED ON) 2 Computer receives the 33am 33Qm responses 3 The Computer sends the sends the 33AM command to turn the LED ON 4 Master first returns 33am (LED presently OFF) 5 Master next returns 33Qm (Switch in Phantom Mode) 5a The Computer (thinking this is a second switch press) sends a second 33AM command to turn the LED ON. Go to Step 4. 5b This results in a continuous loop. Solutions (all versions of code): 1 Prior to sending a Relay or Master ON command, set a status bit that will ignore the next LED status response. While this works, it requires 248 status bits (2 relays * 4 relays) + (30 masters * 8 LEDs). If any commands or responses are missed due to noise or process errors, the latch will ignore the next valid LED response. 2 Prior to sending a Relay or Master ON command, set a timer (0.25 to 0.5 sec) that will ignore the next LED status response. Ignore LED status responses until timer times out. Individual timers may be needed to prevent a second simultaneous switch press from a different Master from being ignored. While this works better then Solution 1, it requires 248 timers (2 relays * 4 relays) + (30 masters * 8 LEDs). 18

19 3 Prior to sending a Relay or Master ON command, set a single timer that will ignore the next LED status response. Ignore all LED status (or switch pressed) responses until timer times out. While this works similar to Solution 2, but would ignore a second simultaneous switch press from a different Master. This is a valid solution if the control code does not have memory or response time to handle multiple Timers. The only drawback is that every once in a while a Phantom switch press may be ignored. The User will notice the no response and press the switch again. Solution (Versions 2.0 and above): 1 Keep a list of all Masters and Relay Cards Versions. 1a Prior to sending a Relay or Master ON command, if the Version is 1.0 then set a single timer (0.25 to 0.5 sec) that will ignore any LED status or switch press responses. Ignore all LED status responses until timer times out. The ##Q command Will be ignored by all Version 1.0 code. 1b Prior to sending a Relay or Master ON command, send the Quiet Command ##Q if the Version is 2.0 or higher. There is no need for a timer to be set. 2 Send a Global Version command 99V on power up. If no Relay Cards or Masters come back as Version 1.0, then just send the ##Q command prior to any Relay/LED Commands. I any Version 1.0 code is detected see Solution 1 above. All code shipped after Mar 30, 2000 is Version 2.0 code. 19

20 PCCOMM Timed Events Command and Responses The PCCOMM card has the following features: RS232 Interface to an External Computer RS422 Interface to an External Computer Real Time Clock (RTC) that keeps track of Time and Date Information RTC is Y2K compatible RTC is accurate to +/- 1 minute/year (typical) RTC can be set to automatically correct for Daylight Savings Can store up to 500 timed events. Timed events can be defined to activate with the following criteria: Identified as Program 1, 2, 3, or 4 Timed Event Actual Hour:Minute (24 hour clock) Time Before Sunrise (Hour:Minute) Time After Sunrise (Hour:Minute) Time Before Sunset (Hour:Minute) Time After Sunset (Hour:Minute) Select Day of Week (any combination) Send any combination of ON, OFF, and Scenes A-L commands to any Rooms (1 through 30) Send ON and Off commands to Relay Cards RTC can be controlled by both an External Computer and/or a BM8R Master set to ID 29 and have all of its Switches set to Phantom Mode RTC Control (External Computer or Master 29) is as follows: Select which program to execute (Program 1, 2, 3, or 4) Suspend event processing Skip next event to be processed Execute the next event now Select new program to start at Midnight RTC Control (External Computer or Master 29) is as follows: Enable/Disable use of Master 29 control Enable/Disable automatic Daylight Savings switching Read/Set Time and Date Read/Set location s Latitude, and today s Sunrise and Sunset times All PCCOM commands and responses (except for the ##z command completed response) start and end with the ASCII bracket characters [ ] and a carriage return. All data is ASCII characters. The commands must be sent directly to the PCCOMM card (the internal RS485 network does not support these commands. 20

21 The following Commands and Responses are used to read and set the RTC Parameters: Read Time Command: [T] Response: [thhmmss] Where: HH = RTC Hour (00 to 23) MM = RTC Minutes (00 to 59) SS = RTC Seconds (00 to 59) Set Time Command: [THHMMSS] Response: 00z - If command processed properly (no response if command not accepted) Where: HH = RTC Hour (00 to 23) MM = RTC Minutes (00 to 59) SS = RTC Seconds (00 to 59) Example: [T130347] = Set Time to 1:03:47 PM Read Date Command: [D] Response: [dwmmddyyyy] Where: W = RTC Day of Week (1 to 7) [1=Sunday, 2=Monday, 7=Saturday] MM = RTC Month (01 to 12) [01=January, 12=December] DD = RTC Day of Month (01 to 31) YYYY = RTC Year (0000 to 9999) Set Date Command: [DWMMDDYYYY] Response: 00z - If command processed properly (no response if command not accepted) Where: W = RTC Day of Week (1 to 7) [1=Sunday, 2=Monday, 7=Saturday] MM = RTC Month (01 to 12) [01=January, 12=December] DD = RTC Day of Month (01 to 31) YYYY = RTC Year (0000 to 9999) Example: [D ] = Set Date to Monday, Dec 25,

22 Read RTC Status Command: [S] Response: [spsixnpdm] Where: P = Program presently executing [1=Program 1, 4=Program 4] S = Suspend/Run timed events [S=Suspend,. =Run] I = Ignore (Skip)/Execute next timed event [I=Ignore,. =Execute] X = Execute Now next timed event [X=Execute Now,. =Ignore] N = Switch to Next Day Program at midnight [N=Next Day,. =Ignore] p = Next Day Program [1=Program 1, 4=Program 4] D = Enable/Disable automatic Daylight Savings switching [D=Enable,. =Disable] M = Enable/Disable Master 29 control [M=Enable,. =Disable] Set RTC Status Command: [SPSIXNpDM] Response: 00z - If command processed properly (no response if command not accepted) Where: P = Program presently executing [1=Program 1, 4=Program 4] S = Suspend/Run timed events [S=Suspend,. =Run] I = Ignore (Skip)/Execute next timed event [I=Ignore,. =Execute] X = Execute Now next timed event [X=Execute Now,. =Ignore] N = Switch to Next Day Program at midnight [N=Next Day,. =Ignore] p = Next Day Program [1=Program 1, 4=Program 4] D = Enable/Disable automatic Daylight Savings switching [D=Enable,. =Disable] M = Enable/Disable Master 29 control [M=Enable,. =Disable] Note: if a? is sent in the place of any of the above command characters the PCCOMM will not update that control. This allows the External Computer to effect just one or two controls. Examples: Command: [S1 N2DM] Response: 00z - The RTC will Execute Program 1 Events, Switch to Program 2 Events at Midnight, Enable Automatic switching for Daylight Savings, and Enable Master 29 for RTC Control Command: [S?S??????] Response: 00z - The RTC will be Suspended Command: [S?.??????] Response: 00z - The RTC will be Execute Command: [S2???????] Response: 00z - The RTC will be Execute Program 2 events Command: [S????N4??] Response: 00z - The RTC will be Execute Program 4 events starting at midnight Command: [S????????] Response: 00z - Nothing will happen 22

23 Read Latitude, Sunrise, Sunset Command: [L] Response: [lllrrrrssss] Where: LL = Unit Location (degrees North Latitude) [30, 35, 40, 45, or 50] RR = Sunrise hours (must be AM) [00 to 11] rr = Sunrise in minutes [00 to 59] SS = Sunset hours (must be PM) [12 to 23] ss = Sunset in minutes [00 to 59] Set Latitude, Sunrise, Sunset Command: [LLLRRrrSSss] Response: 00z - If command processed properly (no response if command not accepted) Where: LL = Unit Location (degrees North Latitude) [30, 35, 40, 45, or 50] RR = Sunrise hours (must be AM) [00 to 11] rr = Sunrise in minutes [00 to 59] SS = Sunset hours (must be PM) [12 to 23] ss = Sunset in minutes [00 to 59] Examples: Command: [S ] Response: 00z - The RTC will set Latitude to 35 degrees North Latitude, Sunrise is 6:15 AM, and Sunset is 6:47 PM. 23

24 Read Timed Event Command: [E###] Response: [e###hhmmesmtwtfs.prrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr] Where: ### = Event number [001 to 500, 999=Last Event] HH = Event Hours [00 to 23] MM = Event Minutes [00 to 59] E = Event Type [. =Actual time, r=before Sunrise, R=After Sunrise, s=before Sunrise, S=After Sunrise] SMTWTFS = Days of week Event is active [S=Sunday, M=Monday, T=Tuesday, W=Wednesday, T=Thursday, F=Friday, S=Saturday, or. =Not active] (Position is important). = For future use P = Event Program number [1=Program 1, 4=Program 4 RRRRRRRRRRRRRRRRRRRRRRRRRRRRRR = Room (1-30) Scene to activate (position is Important [x=off, n=on, a=scene A, l=scene L,. =ignore] rrrrrrrr = Relay (Primary Relay 1-4, Secondary Relay 1-4) OFF/ON to activate (position is Important [x=off, n=on,. =ignore] Set Timed Event Command: [E###HHMMESMTWTFS.PRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRrrrrrrrr] Response: 00z - If command processed properly (no response if command not accepted) Where: ### = Event number [001 to 500] HH = Event Hours [00 to 23, 99=Last Event] MM = Event Minutes [00 to 59, 99=Last Event] E = Event Type [. =Actual time, r=before Sunrise, R=After Sunrise, s=before Sunrise, S=After Sunrise] SMTWTFS = Days of week Event is active [S=Sunday, M=Monday, T=Tuesday, W=Wednesday, T=Thursday, F=Friday, S=Saturday, or. =Not active] (Position is important). = For future use P = Event Program number [1=Program 1, 4=Program 4 RRRRRRRRRRRRRRRRRRRRRRRRRRRRRR = Room (1-30) Scene to activate (position is Important [x=off, n=on, a=scene A, l=scene L,. =ignore] rrrrrrrr = Relay (Primary Relay 1-4, Secondary Relay 1-4) OFF/ON to activate (position is Important [x=off, n=on,. =ignore] Example: Command: [E S..W..S.2a..b..c..d..e..f..g..h..i..j..x.n..n.x] Response: 00z - The RTC Event stored will activate on Sundays, Wednesdays, and Saturdays, at 1:45PM if Program 2 is active. When it is activated, it will send the following commands: Room 1 Scene A, Room 4 Scene B, Room 7 Scene C, Room 10 Scene D, Room 13 Scene E, Room 16 Scene F, Room 19 Scene G, Room 22 Scene H, Room 25 Scene I, Room 28 Scene J, Primary Relay 1 OFF, Primary Relay 3 ON, Secondary Relay 2 ON, Secondary Relay 4 OFF Command: [E SSMTWTFS.1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...] Response: 00z - The RTC Program 1 Event stored will activate every day of the week at 1 hour 30 minutes after Sunset. When it is activated, it will send an OFF command to every room in the house. 24

25 Brilliance II Unit IDs The Brilliance II System is designed to have up to 64 Unit IDs. They are defined as follows: UNIT ID UNIT TYPE 00 PC Interface Card in Primary Cabinet BRMSM or BRSYS cards for rooms 1 through 12 in the Primary Cabinet BRMSM or BRSYS cards for rooms 13 through 24 in the Secondary Cabinet Additional MS232 Units 31 Relay Card in Primary Cabinet 32 Relay Card in Secondary Cabinet BM6R/BM8R Master Control Units 63 Real Time clock Interface Card in Primary Cabinet 25