Liebert SiteScan Reference Manual

Revision B.33 2/25/2011

Liebert Monitoring Group – Development

Liebert® SiteScan®

Protocol Reference Document for

SiteScan Web versions up to 3.0

Including Modbus and BACnet object

Listings

Reference document is based on the assumption that the

connecting module is of exec. 6 or exec. B firmware type unless

otherwise noted.

Page 1 of 149

Liebert Monitoring Group – Development

Revision

Date

Description

B.5

11/8/00

Added: revision level update chart, HiPulse support, and NPower support

B.6

2/19/01

Revised NPower definition

B.7

4/4/02

Added support for HiMod LNA

B.8

5/3/02

Revised Modbus explanation (Hi Byte / Lo Byte)

B.9

10/1/02

Corrected NPower table (typing error)

B.10

1/22/03

Added support for DataMate

B.11

7/23/03

Added support for STS-2

B.12

4/19/04

Corrected ModBus register addressing for STS-2 alarms. PM2 – removed duplicate Output Voltage THD Alarm. Added XDP Unit. Added LDS5000 Unit. Added Universal Monitor. Added BACNet/IP for: WDU, MM4, SC4, PM2 & LAM. Added Run Hours for MM2

B.13

5/24/04

Removed non-existent alarms for MM2. Added BacNet/IP Point addresses for MM2.

B.14

8/19/200 4

Track issue 3576 – Make BacNet points consistent with Modbus Points.

B.15

11/22/20 04

Added ESP-2 based UPS Units that use OC485 card. Includes Nx, HiNet, PSI, and GXT

B.16

5/18/05

Added “High Water Humidifier Pan” alarm to L00. Corrected alarm points for BACNet and Modbus addressing on STS-2.

B.17

7/1/05

Added Remote shutdown alarm to LAM. Added Note about Alarms “BACNet auto

discovery” to CCM, L00, LAM, MMS, PM2, PMP, SCC. Added note to STS2 that it is

for units with or without PDU. Changed breaker status register for STS2 from bits1-8 to 0-7.

B.18

7/21/05

Added XDC Unit. Added control point note for units with on/off control as follows: Bit 0 on=unit off Bit 1 on=unit on. Removed cables 3 & 4 on LDS5000 and marked these registers as spares.

B.19

11/30/05

Corrected revision level and date in header on this document.

B.20

12/14/05

SMS – Added Scale factor for kVA & kW. Revised note on page 1 to state module type rather than “SS2000 Hardware”.

B.21

8/9/06

Series 610 UPS – added note that Series 610 is the same as series 600. SC4-SM4

changed “Bypass Breaker Closed” alarm from “Bypass Breaker Open”. Added note to

LAM that iCOM w/native IGM also applies.

B.22

8/10/06

Nfinity UPS (pnf), Nx (pnx), STS-2 (st2) – deleted status and setpoint points that are not displayed in SiteScan. XDC, XDP added scale factor notes for Ref, Fluid and CW temps.

B.23

3/16/07

PMP – Local Alarm #1 was Load Alarm, Added Local Alarm #2, Corrected Modbus addressing from 40290:04 to 40290:07

B.24

4/16/07

AC8 – Added Unit tables to reference library

B.25

4/30/07

MM2 – Corrected entire table due to MS Word problems.

B.26

5/2/07

Corrected major MS Word formatting problems throughout document.

B.27

11/15/07

Added iCOM DS unit for 2mb modules (small version), SM3 corrected reversed Modbus addressing for kW & kVA. Noted that pages for Series 600 UPS also apply to series 610.

B.28

6/24/08

Added iCOM-XDP unit

B.29

7/11/08

Corrected alarm info for Npower (IMP) unit.

B.30

5/13/09

Corrected revision number in page header B.30 from B.9. Changed XDP unit description on page 53 from XD. Corrected miscellaneous document formatting errors. Added WDU definition back in document from accifental deletion.

B.31

10/13/09

Added local Alarms 2,3 &4 for MM2, L00 & LSM. Local alrm 3=High Water for MM2

B.32

4/23/10

Clarified LAM/iCOM program usage and added iCOM 16mb version. Added examples and notes sections. Removed discontinued modules.

B.33

2/2/11

Removed General Alarm from iCOM_DS. Added Hi Water Humidifier Pan to L8T. Moved Generator Disconnected from Alarm to Status in NX unit.

Revision Level Updates:

Revision B.33 2/25/2011

Page 2 of 149

Revision B.33 2/25/2011

Liebert Monitoring Group – Development

How to use the Reference Library Charts

This document contains a dedicated sheet for each Liebert Unit and associated controller. The title of each chart contains the name of the Liebert Controller used such as L00 for a Level-0 Air unit or PMP for a Power Monitoring Panel for Power Center.

Every documented unit assumes the maximum possible optional points and configuratios of the specific unit family. The specific points that will be used depend on the unit being read as that unit will only report values and alarms that the specific unit supports.

The first section, Compatible Hardware, indicates the equipment associated with this particular controller as follows:

The next section, Available Points, contains six categories providing the following information:

Page 5 of 149

Liebert Unit ID Chart

3-Letter ID

Environmental Products

3-Letter ID

UPS Products

L00

Level 00, Level 1

SMS

Single Module Series UPS - S300, S500, S600 (Prior to 1/98)

L10

Level 2, Level 3, and Level 10

SM3

Single Module Series 30x (latest version)

LAM

Level 15 and Level AM/AG, HiMod (LNA), iCOM control w/ native IGM terminal 77/78

SM4

Single Module Series 600/610 - Extended Protocol (1/98 or later)

LSM

Level SM and Level 0 w/ On/Off Control

US3

UPStation S3 UPS

L0B

Small Systems Controller

MMS

Multi Module Series 500-600 UPS (Prior to 1/98)

MM2

Small Systems Controller - Mini Mate II, DataMate

MM4

Multi Module Series 600/610 UPS Extended Protocol (1/98 or later)

C10

Atlas Air Environmental Control (LECS15)

SCC

System Control Cabinet Series 500-600 (Prior to 1/98)

CSE

Chiller w/ Econocoil

SC4

System Control Cabinet Series 600/610Extended Protocol (1/98 or later)

CSU

Chiller

SSM

Single Module Series UPS - SICE 7200 & HiPulse

XDP

Xtreme Density Unit Environmental Control

SMM

Multi Module Series UPS - SICE 7200 & HiPulse

CDU

Xtreme Density Coolant Distribution Unit

SSC

System Control Cabinet - SICE 7200

iCOM

DS Unit with iCOM control or Deluxe System 3 with iCOM control retrofit using optional IS485 interface with 16mb SiteLink.

IMP

NPower (S300 Replacement)

iCOM-2mb

DS Unit with iCOM control or Deluxe System 3 with iCOM control retrofit using optional IS485 interface with 2mb SiteLink.

PNX

NX UPS – ESP2 Protocol

HIA

Hiross Hiromatic Air unit

PHN

HiNet UPS – ESP2 Protocol

Static Switch PDU

PNF

Nfinity UPS – ESP2 Protocol

EDS

Static Switch PDU (Single Output Breaker, Prior to 1/99)

PGX

GXT UPS – ESP2 Protocol

STS

Static Switch PDU (Dual Output Breaker Option, 1/99 or later)

PPS

PSI UPS – ESP2 Protocol

Miscellaneous

CCM

All IGM Contact Modules CM200 / RCM8 / VSM

RAC

Remote Autochangeover Module - RAC2-8

THM

Temperature / Humidity Module

Power Products PDU

WDU

Liquid Detection LDS750 or LDS1000

PMP

Precision Power & Datawave w/ PMP (latest LCD display)

WD5

Liquid Detection LDS5000

VCF

All Voltage-Current-Frequency Panels (Old Red LED Display)

UVM

Universal Monitor

VCM

All Voltage-Current Monitoring Panels (Old Red LED Display)

AC8

Autochangeover Controller

PM2

Precision Power & Datawave w/ PMP (latest LCD display and extended protocol EPROM version 3.290.0, manufactured and shipped after 4/99)

Revision B.33 2/25/2011

Liebert Monitoring Group – Development

Page 6 of 149

Revision B.33 2/25/2011

Liebert Monitoring Group – Development

Open Communications

Default Mapping for Modbus & BACnet Objects

This model represents the standard configuration for a Liebert Sitelink-12 module. Consecutive register / object mapping is utilized, regardless of the SiteLink-12 population. All ports that do not have a Liebert IGM attached will be assigned “null values” (or zero’s) for their corresponding registers. The default “slave ID” or “Device ID” follows the CMNet address of the unit. The address can be visually checked by looking at the address dip-switch or rotary switch settings. However, the address can be changed in software to suit specific needs.

Please note that the SiteLink hardware places a limit on the quantity of Modbus registers available. Therefore, it is possible there will be more data points available using BACnet than using Modbus.

How to use this table:

The unit or model specific reference sheets assume that the desired unit is attached to port 1 of the SiteLink module. If the desired unit is attached to a different port, the table below indicates the starting register or object number for the unit.

For example: The register for “temperature” for a L00 type unit attached to port 1 is identified as

40001. If an additional L00 type unit were attached to port 2, the “temperature” value would be located in

register 40025. The same type unit attached to port 3 = 40049…etc.

Modbus Notes:

Modbus Registers start at 40001. All registers are unsigned integers.

BACnet Notes:

BACnet Objects start at 1. All “Status” and “Alarm” objects are “AI’s” (analog inputs). The “Control” objects are “AO’s” (analog outputs)

Page 7 of 149

Revision B.33 2/25/2011

Register Offset

Object Type

Port Assignment

1-24

Status

1

25-48

Status

2

49-72

Status

3

73-96

Status

4

97-120

Status

5

121-144

Status

6

145-168

Status

7

169-192

Status

8

193-216

Status

9

217-240

Status

10

241-264

Status

11

265-288

Status

12

289-293

Alarms

1

294-298

Alarms

2

299-303

Alarms

3

304-308

Alarms

4

309-313

Alarms

5

314-318

Alarms

6

319-323

Alarms

7

324-328

Alarms

8

329-333

Alarms

9

334-338

Alarms

10

339-343

Alarms

11

344-348

Alarms

12

349-351

Control

1

352-354

Control

2

355-357

Control

3

358-360

Control

4

361-363

Control

5

364-366

Control

6

367-369

Control

7

370-372

Control

8

373-375

Control

9

376-378

Control

10

379-381

Control

11

382-384

Control

12

Liebert Monitoring Group – Development

** See reference libraries for unit specific objects.

Page 8 of 149

Revision B.33 2/25/2011

Physical

Port

Transmission

Mode

Baud Rate

Data Bits

Parity Bits

Stop Bits

Default

EIA-232 –

DB9 DCE

RTU

9600

8

None

1

Yes

EIA-232 –

DB9 DCE

ASCII

1200 –

38.4kbd

(19.2kbd omit)

Configurable

No

EIA-485 – 2

or 4 wire

RTU or ASCII

1200 –

38.4kbd

(19.2kbd omit)

Configurable

No

Liebert Monitoring Group – Development

Modbus Communications

Connectivity to SiteLink modules using Modbus

This design specification describes the Modbus communications protocol as supported by the SiteLink module. It includes information on how to pass information to and from the SiteLink module via Modbus. It is also intended to help facilitate answering questions regarding supported types, frame format, function code support etc.

Implementation Basics

Protocol controls the language structure or message format between devices in other words, the rules for communication. The rules for communication include how master and slave devices initiate communications, as well as unit identification, message handling and error checking. Modbus protocol simply refers to the control of the query and response cycles between master and slave devices.

The SiteLink module is configured to act as a slave device on a common network. The common network can be point-to-point over EIA-232, where one master communicates to one slave device or in a multi-drop configuration over EIA-485, where multiple slaves reside on a common wire or loop.

Documented write points can cause read errors if you attempt to read a write-only point. For example: an LAM air unit has separate Setpoint View and Setpoint Set registers and if you read a write-to register it can and most likely will result in a Modbus exception response. Do not include setpoint set registers in batch read commands as one point read error will result in an exception response for the entire batch read.

Transmission Format

The SiteLink module supports both Modbus RTU (Remote Terminal Unit) and ASCII (American Standard Code for Information Interchange) transmission modes. The SiteLink module has a choice of transmission medium, baud

rate, character parity and number of stop bits. See chart below.

Page 9 of 149

Revision B.33 2/25/2011

Liebert Monitoring Group – Development

Modbus Packet Format

Each Modbus packet consists of the following fields:

Device Address Function Code Data Field(s) Error Check Field

Device Address:

The address field immediately follows the beginning of the frame and consists of 8-bits (RTU) or 2 characters (ASCII). These bits indicate the user assigned address of the slave device that is to receive the message sent by the attached master device.

Each slave must be assigned a unique address and only the addressed slave will respond to a query that contains its address.

Function Code:

The function code field tells the addressed slaves what function to perform. Function codes are specifically designed invoke a specific action by the slave device. The function code range is from 1 to 127. However, the

SiteLink module primarily uses Function Code 3 (Read Holding Registers), Function Code 6 (Preset Single Register) and Function Code 16 (Preset Multiple Registers).

Data Field(s):

The data field varies in length depending on whether the message is a request or a response to a packet. This field typically contains information required by the slave device to perform the command specified or to pass back data to the master device.

Error Check Field:

The Error Check Field consists of a 16-bit (2 byte) Cyclical Redundancy Check (CRC16). It allows the receiving device to detect a packet that has been corrupted with transmission errors.

Page 10 of 149

Revision B.33 2/25/2011

Slave

Address

Function

Code

Starting

Register

―Hi Byte‖

Starting

Register

―Lo Byte‖

Number of

Registers

―Hi Byte‖

Number of

Registers ―Lo Byte‖

CRC16

―Hi Byte‖

CRC16

―Lo Byte‖

02

03

00

32

00

03

E5

FA

Slave

Address

Function

Code

Count:

Bytes of

Data

Register

40051 Data

Hi Lo

Register

40052 Data

Hi Lo

Register

40053 Data

Hi Lo

CRC16

―Hi Byte

CRC16

―Lo Byte‖

02

03

6

01 58

00 FA

00 54

1B

0D

Frame

Start

Slave

Address

Function

Code

Data

Error

Check

End of

Frame

CR

Ready for

Data

LF

:

2 Char 16-bits

N x 4 Char N x 16-bits

B3

0D

0A

Liebert Monitoring Group – Development

RTU Framing

The example below shows a typical Q/R from a SiteLink module. In common terms, the master device initiates a query asking slave device 2 for holding registers starting at holding register 40051 (decimal 50) and including next 2 Registers (3 total).

Query Sample

Response Sample

Slave address 2 responds to Function Code 3 with 6 bytes of hexadecimal data and ends with CRC16 checksum.

Register values: 40051 = 158(hex) = 344(decimal)

40052 = FA (hex) = 250 (decimal) 40053 = 54 (hex) = 84 (decimal)

ASCII Framing:

Framing in ASCII transmission mode is accomplished by the use of the unique colon (:) to indicate the beginning of the frame and a carriage return (CR) line feed (LF) to delineate the end of the frame. The line feed also serves as a synchronizing character which indicates that the transmitting station is ready to receive an immediate reply.

ASCII Example

Char = Character: 1 Character = 7 data bits, 1 start bit, 1 or 2 stop bits and 1 parity bit (optional)

Page 11 of 149

Revision B.33 2/25/2011

Class 1

Class 4

Class 2

Class 5

Class 3

x

Class 6

Clock

Files

HHWS

Reinitialize

PCWS

Virtual Operator Interface

Event Initialization

Virtual Terminal

Event Response

Device Communications

COV Event Initiation

Time Master

COV Event Response

Liebert Monitoring Group – Development

BACnet Communications

BACnet Protocol Implementation Conformance Statement Rev. 2.1

Vendor Name: Liebert Corporation Product Name: SiteLink Module Product Model Number: SiteLink (All)

Point Documentation:

The points in this document are listed by object reference name and each exposed BACnet point has information in the description field detailing what the point is. Both of these BACnet properties can be read and discovered remotely in addition to the points present value property. This document is not able to define specific object instance numbers because they are dynamically assigned when the programming for the module is created and will vary from situation to situation. A report detailing reference name, description and object instance number can be requested from the startup engineer at the time of the modules commissioning.

If after startup if changes are made or new programs are added the dynamically built AV/BV points list will shift for all points.

Product Description:

The SiteLink module provides a BACnet Point-to-Point communication exchange between proprietary Liebert Environmental, Power, UPS units to other BACnet compliant devices. The connection to the SiteLink module is via EIA-232, 9600 baud, no parity, 8 data bits, 1 stop bit (9600,N,8,1 default.) The SiteLink modules are available in 12 port and 4 port configurations (i.e. 1 port per/ Liebert Unit, 12 Liebert units per/ SiteLink module maximum.)

BACnet Conformance Class Supported:

BACnet Functional Groups Supported:

Page 12 of 149

Liebert Monitoring Group – Development

Application Service

Initiate

Requests

Execute Requests

AcknowledgeAlarm

ConfirmedCOVNotification

ConfirmedEventNotification

GetAlarmSummary

GetEnrollmentSummary

SubscribeCOV

UnconfirmedCOVNotification

UnconfirmedEventNotification

AtomicReadFile

AtomicWriteFile

AddListElement

RemoveListElement

CreateObject

DeleteObject

ReadProperty

X

ReadPropertyConditional

ReadPropertyMultiple

X

WriteProperty

X

WritePropertyMultiple

X DeviceCommunicationControl

ConfirmedPrivateTransfer

UnconfirmedPrivateTransfer

ReinitializeDevice

ConfirmedTextMessage

TimeSynchronization

Who-Has

X

I-Have

X

Who-Is

X

I-Am

X

VT-Open

VT-Closed

VT-Data

Authenticate

Request Key

BACnet Standard Application Services Supported:

Revision B.33 2/25/2011

Page 13 of 149

Revision B.33 2/25/2011

Object Type

Supported

Dynamically

Creatable

Dynamically

Deleteable

Optional

Properties

Writable

Properties

Analog Input

X None

Analog Output

X

Present Value

Analog Value

Binary Input

Binary Output

Binary Value

Calendar

Command

Device

Event Enrollment

File

Group

Loop

Multi-State Input

Multi-State Output

Notification Class

Program

Schedule

Segmented Requests Supported

No

Segmented Responses Supported

No

Router

No

Liebert Monitoring Group – Development

BACnet Standard Application Services Supported (continued):

Data Link Layer:

Point-to-Point, EIA-232, baud rates: 9600 & 38,400

Character Set Supported:

ANSI X3.4

Special Functionality:

Page 14 of 149

Revision B.33 2/25/2011

SiteScan Availability

Modbus Register

BACnet

Instance

(Exec. 6

Modules)

BACnet

Instance

(Exec. B

Modules)

Notes:

Control Points (Set)

Unit On/Off

40349

349

BC01_x

Bit 0 on=unit off Bit 1 on=unit on

Temperature Setpoint

40350

350

BC02_x

Temperature Tolerance

40350

350

BC02_x

Multiply desired value by 1000

Humidity Setpoint

40351

351

BC03_x

Humidity Tolerance

40351

351

BC03_x

Multiply desired value by 1000

Reheat Lockout

40349

349

BC01_x

Bit 2 on=RH off Bit 3 on=RH on

Humidifier Lockout

40349

349

BC01_x

Bit 2 on=HL off Bit 3 on=HL on

Function

Command if

BIT=1

BIT

Number

Value sent from

BMS

Resulting Action

Unit On/Off

―Off‖

BIT 0 1 Units turns ―Off‖

Unit On/Off

―On‖

BIT 1 2 Unit turns ―On‖

Reheat Lockout

―Off‖

BIT 2 4 Reheat Lockout turns ―Off‖

Reheat Lockout

―On‖

BIT 3 8 Reheat Lockout turns ―On‖

Humidifier Lockout

―Off‖

BIT 4

16

Humidifier Lockout turns ―Off‖

Humidifier Lockout

―On‖

BIT 5

32

Humidifier Lockout turns ―On‖

Control Points (Set)

Temperature Setpoint

40350

350

BC02_x

Temperature Tolerance

40350

350

BC02_x

Multiply desired value by 100

Humidity Setpoint

40351

351

BC03_x

Humidity Tolerance

40351

351

BC03_x

Multiply desired value by 100

Liebert Monitoring Group – Development

Liebert Environmental Units

Using Unit Control Points

This section is an example of how to utilize Liebert environmental unit Setpoints Set registers. In all cases the Setpoints View section contains the value that the unit itself is reporting and can be used to confirm that the unit received the transmitted command.

Example table from this document:

The above notes in the document refer to binary bits. Notice that register 40349 is used more than once in the table. The table below shows the integer number in the value set from BMS column.

For the setpoint registers, the setpoint and tolerance are in the same register. Writing a zero to the field will result in no change.

Some examples of valid values to send:

To make the Temperature Setpoint “70”, send a “70” to the register. To make the Temperature Tolerance “+/- 2.5 degrees”, send “2500” to the register. To make the Temperature Tolerance “+/- 2.5 degrees” and Setpoint “70”, send “2570” to the register. To make the Humidity Setpoint “50%”, send a “50” to the register. To make the Humidity Tolerance “+/- 5%”, send “5000” to the register. To make the Humidity Tolerance “+/- 5%” and Setpoint “50%”, send “5050” to the register.

Page 15 of 149

Revision B.33 2/25/2011

Hardware Compatibility

Liebert Units:

Challenger 3, Logicool, Modular Plus, LS400, Mini-Tower, System 4

SiteScan Interface Modules:

SiteLink (All)

BMS interface Modules:

SiteLink (All)

Available Points

SiteScan Availability

Modbus Register

BACnet

Instance

(Exec. 6

Modules)

BACnet

Instance

(Exec. B

Modules)

Notes:

Status Points (View)

Temperature

40001

1

BS01_x

Humidity

40002

2

BS02_x

Cooling

40003

3

BS03_x

1=on / 0=0ff

Heating

40004

4

BS04_x

1=on / 0=0ff

Humidification

40005

5

BS05_x

1=on / 0=0ff

Dehumidification

40006

6

BS06_x

1=on / 0=0ff

Econ-o-Cycle

40007

7

BS07_x

1=on / 0=0ff

Stages

40008

8

BS08_x

% Capacity

40009

9

BS09_x

Alarm Points

Discrete BACnet alarm objects available – use auto-discover for this unit

Communications

40289:0

289:0

BA01_x:00

High Head Pressure 1

40289:1

289:1

BA01_x:01

High Head Pressure 2

40289:2

289:2

BA01_x:02

Loss of Airflow

40289:3

289:3

BA01_x:03

Liquid Detected

40289:4

289:4

BA01_x:04

Change Filters

40289:5

289:5

BA01_x:05

High Temperature

40289:6

289:6

BA01_x:06

Low Temperature

40289:7

289:7

BA01_x:07

High Humidity

40289:8

289:8

BA01_x:08

Low Humidity

40289:9

289:9

BA01_x:09

Local Alarm 1

40289:10