plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial...

8
THIS IS A PREMININARY DOCUMENT AND NOT MEANT FOR GENERAL DISTRIBUTION. CONTENTS OF THIS DOCUMENT MAY CHANGE WITHOUT NOTICE Application Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller Network lighting control panels. These serial commands are sent using the TCP/IP protocol over the building LAN to an Ethernet Interface Module (EIM) or ControlKeeper M (CKM) panel. The EIM or CKM will then forward the serial commands onto the lighting control system RS-485 network. Serial integration can be used to allow AV, BMS or other systems to send commands to the Room Controller Network panels and set dimmer levels, relay states or trigger remote commands. Command Types Supported Commands Manual Commands Relay (On/Off) Dimmer Commands Dimmers (0 100%) Remote Commands Remote (On/Off) Disclaimer This document defines the implementation of the Eaton Lighting Systems RS232 and network protocol used by the Room Controller products. The specifications, descriptions and information provided here are believed to be correct at the time of printing. However, specifications are continually being upgraded and are subject to change without notice. Eaton Lighting Systems shall not be liable for technical or editorial omissions made herein; nor for incidental or consequential damages resulting from the furnishing, performance or use of this material.

Transcript of plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial...

Page 1: plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller

THIS IS A PREMININARY DOCUMENT AND NOT MEANT FOR GENERAL DISTRIBUTION.

CONTENTS OF THIS DOCUMENT MAY CHANGE WITHOUT NOTICE

Application Note Greengate

Room Controller Network Serial Integration

Overview

Third party systems are able to send serial commands to Room Controller Network lighting control

panels. These serial commands are sent using the TCP/IP protocol over the building LAN to an Ethernet

Interface Module (EIM) or ControlKeeper M (CKM) panel. The EIM or CKM will then forward the serial

commands onto the lighting control system RS-485 network.

Serial integration can be used to allow AV, BMS or other systems to send commands to the Room

Controller Network panels and set dimmer levels, relay states or trigger remote commands.

Command Types Supported Commands

Manual Commands Relay (On/Off)

Dimmer Commands Dimmers (0 – 100%)

Remote Commands Remote (On/Off)

Disclaimer

This document defines the implementation of the Eaton Lighting Systems RS232 and network protocol

used by the Room Controller products. The specifications, descriptions and information provided here

are believed to be correct at the time of printing. However, specifications are continually being

upgraded and are subject to change without notice. Eaton Lighting Systems shall not be liable for

technical or editorial omissions made herein; nor for incidental or consequential damages resulting from

the furnishing, performance or use of this material.

Page 2: plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller

www.eaton.com/lightingsystems 2

Connection

The Room Controller Network system connects to the Building LAN via an Ethernet Interface Module

(EIM). The system requesting serial integration must also connect to the Building LAN and be able to

make a TCP connection to the EIM. Consult your local IT expert to insure proper IP routing can be

achieved.

The Ethernet Interface Module must be properly configured and installed. Consult the EIM installation

instructions shipped with the unit or via the web site.

http://www.cooperindustries.com/content/dam/public/lighting/controls/products/documents/greenga

te/instruction_sheets/eim_install.pdf

B lue

R ed

B lack

B rown

Oc

cu

pa

nc

y S

en

so

r C

ou

ple

rM

od

el: O

CC

-RJ

45

Al l Off

F ull Lights

Hal f Lights

Wal ls ta tions

S ta tion

S li der

S ensor s

Qui

ck

Co

nn

ec

t C

ab

les

S witchpack

B MS/Out

R eceptacle

S ensor s

Ad

jus

tab

le S

ky

ligh

ts

W hite

R ed

B lack

Green

-+-+-+

Inte

gra

tion

Co

ntr

ols

-+

Mode

A /V

R esponse

D emand

Mode

A lert

C lock

T ime

Vac ( default)Occ

40%

30%

20%

D efault 10%

4321

N ot UsedOccupancyD emand R esponse

E nerg y Op tions D IP Switch

Pur

ple

- L

oa

d 3

Ou

t

Red

- L

oad

2 O

ut

Ye

llo

w

- Lo

ad 1

Ou

t

Blu

e -

Lo

ad

In

Wh

ite

/Ora

ng

e - 2

77

V N

Wh

ite

/Bla

ck

- 1

20

V N

Bla

ck

- L

ine

In

CA

UT

ION

: B

on

din

g b

etw

ee

n c

on

dui

t co

nne

cti

on

s i

s n

ot

au

tom

ati

c a

nd

mu

st b

e p

rov

ide

d a

s p

ar

t of

the

ins

tall

atio

n.

Blu

e -

EM

Lo

ads

Ou

t

Blu

e -

EM

Lin

e I

n -+ + -

Dimm er 1D im mer 2D imm er 3

+ -0-10V Dimming Outputs

0-1 0V Dimming

-++ --+Dim mer 1Dimm er 2Dimm er 3

Ad

jus

tme

nt

0-1

0V

Ga

in

Re

se

tS

tatu

s

Op

tio

ns

En

erg

y

Hig

h E

ndL

ow

En

dA

dju

sta

ble

Sk

ylig

hts

Inte

gra

tion

Co

ntr

ols

6

5

4

3

2

1

Blue

Red

Black

Brown

Oc

cu

pa

nc

y S

en

so

r C

ou

ple

rM

od

el: O

CC

-RJ

45

(Occupancy Coupler)OCC-RJ45

(OAWC-DT-120W)

Vacancy Sensor

Occupancy/

Slider StationWallstation

Control

�20A Receptacle SPRC-R-20-120 (DSRC-FMOIR)

Daylight sensor

(GGRC-COUPLER)

QuickConnect Coupler

(Occupancy Coupler)OCC-RJ45

(OAWC-DT-120W)

Vacancy Sensor

Occupancy/

Slider StationWallstation

Control

�20A Receptacle SPRC-R-20-120 (DSRC-FMOIR)

Daylight sensor

(GGRC-COUPLER)

QuickConnect Coupler

(Occupancy Coupler)OCC-RJ45

(OAWC-DT-120W)

Vacancy Sensor

Occupancy/

Slider Station

All Off

Wallstation

F ul l Li ghts

H alf Li ghts

Control

�20A Receptacle SPRC-R-20-120

Wal ls tations

Sta ti on

S lider

Sensors

Qui

ck

Co

nn

ec

t C

ab

les

Switchpack

BMS/Out

Recep tacle

Sensors

Ad

jus

tab

le S

ky

ligh

ts

White

Red

Black

Gr een

-+-+-+

Inte

gra

tion

Co

ntr

ols

-+

Mode

A/V

Response

Demand

Mode

Alert

Clock

Time

Vac ( default)Occ

40%

30%

20%

Default 10%

4321

Not UsedOccupancyDemand Res ponse

Ene rgy Option s DIP Switch

Pur

ple

- L

oa

d 3

Ou

t

Red

- L

oad

2 O

ut

Ye

llo

w

- Lo

ad 1

Ou

t

Blu

e -

Lo

ad

In

Wh

ite

/Ora

ng

e - 2

77

V N

Wh

ite

/Bla

ck

- 1

20

V N

Bla

ck

- L

ine

In

CA

UT

ION

: B

on

din

g b

etw

ee

n c

on

dui

t co

nne

cti

on

s i

s n

ot

au

tom

ati

c a

nd

mu

st b

e p

rov

ide

d a

s p

ar

t of

the

ins

tall

atio

n.

Blu

e -

EM

Lo

ads

Ou

t

Blu

e -

EM

Lin

e I

n -+ + -

Dimm er 1Dim mer 2Dimm er 3

+ -0-10V Dimming Outputs

0- 10 V Dimming

-++ --+Dimm er 1Dimm er 2Dimm er 3

Ad

jus

tme

nt

0-1

0V

Ga

in

Re

se

tS

tatu

s

Op

tio

nsE

ne

rgy

Hig

h E

ndL

ow

En

dA

dju

sta

ble

Sk

ylig

hts

Inte

gra

tion

Co

ntr

ols

6

5

4

3

2

1

(DSRC-FMOIR)

Daylight sensor

(GGRC-COUPLER)

QuickConnect Coupler

TouchScreenControlKeeper

EIM

Receptacle Required120V Power

Blue

Red

Black

Br own

Oc

cu

pa

nc

y S

en

so

r Co

uple

rM

od

el: O

CC

-RJ

45

Al l Off

F ull Lights

Hal f Lights

Wallstations

StationSlider

Sensors

Qu

ick

Co

nn

ec

t C

ab

les

Switchpack

BMS/Out

Receptacle

Sensors

Ad

jus

tabl

e S

ky

ligh

ts

White

Red

Black

Green

-+

-+-+

Int

egra

tio

n C

on

tro

ls

-+

Mode

A/V

Resp onseDem and

Mode

Ale rt

Clock

Time

Vac (de fa ult)

Occ

40 %

30%

20 %

Default 10%

4321

Not UsedOccupancyDemand Response

Energ y Op tions DIP Switch

Pu

rple

- L

oa

d 3

Ou

tR

ed

- L

oa

d 2

Ou

t

Ye

llo

w -

Lo

ad

1 O

ut

Blu

e -

Lo

ad

In

Whi

te/O

ran

ge

- 2

77

V N

Whi

te/B

lac

k -

12

0V N

Bla

ck

- L

ine

In

CA

UT

ION

: B

on

din

g be

twe

en

con

du

it c

on

ne

cti

on

s i

s n

ot

au

tom

ati

c a

nd

mu

st

be

pro

vid

ed

as

par

t o

f th

e in

sta

lla

tion

.

Blu

e - E

M L

oa

ds

Ou

t

Blu

e - E

M L

ine

In -+ + -

Dimm er 1Dimmer 2Dimmer 3

+ -0- 10V Dimming Outputs

0- 10 V D imm in g

-++ --+Dim mer 1Dimm er 2Dimmer 3

Ad

jus

tme

nt

0-1

0V G

ain

Re

se

tS

tatu

s

Op

tio

ns

Ene

rgy

Hig

h E

nd

Lo

w E

nd

Adj

usta

ble

Sk

yli

ghts

Inte

gra

tio

n C

on

tro

ls

6

5

4

3

2

1

The Ethernet Interface Module (EIM)

may be connected to any ControlKeeper panel in the system using the RS-232 cable

included (Material #: 52-018703-00)

3rd Party Serial Integration

Building LAN/

Network Switch

Figure 1: Room Controller Network Serial Integration Connection

Page 3: plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller

www.eaton.com/lightingsystems 3

Packet Format

Packet: [Flag] [Length] [Physical To Address] [Physical From Address] [To/From Address] [Type Flag]

[DATA] [LRC]

Flag: (1 byte) All data information coming from any external device must be preceded by an AA

hexadecimal (170 decimal). If the incoming information is not preceded by the AA hex then the

information will be ignored by the Room Controller Network.

Length: (1 byte) This byte informs the LCP receiving the message of the number of bytes

following this byte up to and including the LRC.

Physical TO Address: (1 byte) This byte is the address of the LCP (in hexadecimal) that this

message is for. All LCP’s have hardware which allows them to reside at a certain "logical"

address. This address range is from 1 to 254. Only the LCP at this specific address will listen to

the message. Please note that address 0 and 255 should not be used.

Physical FROM Address: (1 byte) The byte for the Physical FROM Address field is always zero

(00).

Logical TO/FROM Address: (1 byte) Transmissions entering the panel RS232 port will always be

zero (00) for this field.

Type Flag: (1 byte) The type flag defines the exact function of the data being transmitted. The

supported type flags are described below.

DATA: (N bytes) The variable-length field associated with each Command field is detailed in

section 5 ”Command Types Flag”.

LRC: The (1 byte) Linear Redundancy Check (LRC) is an XOR of all the bytes in the frame

transmission including the flag character, up to but not including the LRC byte. This byte is used

to check for valid transmissions of data to the Lighting Control Panel. The calculation for the LRC

is shown below:

lrc = 0;

for ( index = 0; index < message length; index = index + 1 )

{

lrc = lrc XOR data[ index ];

}

Page 4: plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller

www.eaton.com/lightingsystems 4

Type Flags

The command Type Flag defines the type of protocol packet to be sent to the LCP. The type number is

in hexadecimal.

Type 02 - Remote Command

In a Room Controller Network, remote commands are used to send preset commands to the Room

Controller. Remotes can trigger allow groupings of relays within the controller or controllers to respond

to a single command. The status field returned will include some indication of whether or not the

controller could perform the requested function with 1=OK and 0=not done.

Function Type Remote Name Remote State ACK Status

Remote Command 02 8 Byte Hex Name 02 = OFF

03 = ON

Remote Acknowledge 02 8 Byte Hex Name 02 = OFF

03 = ON

1 = OK

0 = No remote by this name

Remote Command Examples

Below are some examples of the use of remote commands. The examples are listed in hexadecimal.

“FF” in the Physical To Address field is a Global and will be sent to all lighting control panels on the

network. When “FF” is in the Physical To Address field no Acknowledgement is sent from the panels. If

a Remote Command is sent to a specific panel address a Remote Acknowledgement is sent.

Remote

Name

ON Command OFF Command

TIM3 AA 0E FF 00 00 02 [54 49 4D 33 20 20 20 20] 03 39 AA 0E FF 00 00 02 [54 49 4D 33 20 20 20 20] 02 38

NOTE: The LRC of each transmission will be different based on the panel address and data information changes.

See the calculating LRC section for examples.

Type Flag Description

Type 02 Remote Command

Type 03 Manual Command

Type 0E Dimmer Command

Page 5: plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller

www.eaton.com/lightingsystems 5

Type 03 - Manual Command

This is used to command a single digital output (relay) on the network to an ON or OFF state. This

command is sent to the relay name.

Function Type Relay Name Relay State ACK Status

Relay Command 03 8 Byte ASCII Hex Name 01 = ON

02 = OFF

Relay Acknowledge 03 8 Byte ASCII Hex Name 01 = ON

02 = OFF

1 = OK

0 = No relay by this name

Manual Command Examples

Below is an example of a manual relay commands to Room Controller Network panel address #1. The

example is listed in hexadecimal.

Relay # ON Command OFF Command

Relay 1 AA 03 01 00 00 03 [52 65 6C 61 79 20 31 20] 01 D5 AA 03 01 00 00 03 [52 65 6C 61 79 20 31 20] 02 D4

Relay 2 AA 03 01 00 00 03 [52 65 6C 61 79 20 32 20] 01 D6 AA 03 01 00 00 03 [52 65 6C 61 79 20 32 20] 02 D7

Relay 3 AA 03 01 00 00 03 [52 65 6C 61 79 20 33 20] 01 D7 AA 03 01 00 00 03 [52 65 6C 61 79 20 33 20] 02 D6

NOTE: The LRC of each transmission will be different based on the panel address and data information changes.

See the calculating LRC section for examples.

Page 6: plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller

www.eaton.com/lightingsystems 6

Type 0E - Dimmer Commands

This is used to command a single dimmer level within a Room Controller on the network to a % light

level (0-100%). This command is sent to the dimmer name.

Function Type Dimmer Name DB Point Static Fields % Output

Dimmer Command 0E 8 Byte Hex

Name

01 06=Dim1

07=Dim2

08=Dim3

00 04 01 08 00 00 00

00 00 00 00

1 Byte Hex

Dimmer Acknowledge 0E 8 Byte Hex

Name

01 06=Dim1

07=Dim2

08=Dim3

00 04 01 08 00 00 00

00 00 00 00

1 Byte Hex

plus

01 = OK

Dimmer Command Examples

Below are examples of a manual dimmer commands to Room Controller Network panel address # 218.

The example is listed in hexadecimal.

Dim # Command % Dim Level

Dim 1 AA 1B DA 00 00 0E [44 69 6D 20 31 20 20 20] 01 06 00 04 01 08 00 00 00 00 00 00 00 32 2C 50%

Dim 2 AA 1B DA 00 00 0E [44 69 6D 20 32 20 20 20] 01 07 00 04 01 08 00 00 00 00 00 00 00 19 05 25%

Dim 3 AA 1B DA 00 00 0E [44 69 6D 20 33 20 20 20] 01 08 00 04 01 08 00 00 00 00 00 00 00 64 76 100%

NOTE: The LRC of each transmission will be different based on the panel address and data information changes.

See the calculating LRC section for examples.

Page 7: plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller

www.eaton.com/lightingsystems 7

ASCII Chart

Below is a sample ASCII chart showing the relationship between the ASCII value, HEX value and Decimal

value.

Page 8: plication Note Greengate - Cooper Industries Note Greengate Room Controller Network Serial Integration Overview Third party systems are able to send serial commands to Room Controller

www.eaton.com/lightingsystems 8

Eaton 1000 Eaton Boulevard Cleveland, OH 44122 United States Eaton.com

Eaton Lighting systems 203 Cooper Circle Peachtree City, GA www.eaton.com/lightingsystems Eaton is a registered trademark.

© 2015 Eaton All Rights Reserved Printed in USA Publication No. APxxxxxxx January 30, 2016

All trademarks are property of their respective owners.