BC2000, NIC-Series, XC-Series

Controller

Telnet Feature

24 x7 Installation and Technical Support

1-866-240-6614
Page 1 of 22

Version 1.0

DO6000000231

April, 2007

1 Purpose
The purpose of this manual is to guide the user in connecting to the controller via
Telnet, and issuing commands to the controller.
This document assumes that the user has already set the controller up onto a
network and the controller has a known, proper IP address. For more
information on connecting the controller to a network see D0600000228
BC2000 JC2000-Series Web Interface.

2 Connecting to the controller

This section will guide you through establishing a Telnet connection with the
controller. The example used in this manual, PuTTY, is available on the CD that
comes with the controller unit. Any Telnet program will work in place of PuTTY.
2.1

PuTTY

The main screen can be seen in Figure 1.

Figure 1 PuTTY Configuration Window

To use, enter in the IP address of the Valere LAN Module and ensure that the
Telnet option is selected. If you desire, enter a session name and press the
Save button for easy loading in the future.
Page 2 of 22

Version 1.0

DO6000000231

April, 2007

Once the settings are accurate press the Open button. At this point, Figure 2
shows the resulting screen.

Figure 2 PuTTY Login Window

Enter in the appropriate username (press <ENTER>) and password (press

<ENTER>). The default username is Admin, and the default password is 5001. If
successful you will see the system identifier command prompt:
Unassigned>
Note: A unique name can be created for the system.
If login is not successful the application will exit.
From the command prompt, type help for a short list of commands
In addition, the results of each command entered will be one of the following:
REQUEST_OK or REQUEST_FAIL.
To complete your Telnet session, type in logout and the Telnet session will end.
Use the following sections for additional commands

3 General Commands
The following categories list all the different commands available via the Telnet
session. There can be a delay of several seconds between changing (set
command) a value and reading (get command) that value back.
Commands are available within the Telnet session by using the command get
help. This command will provide the user with a list of objects. The user then
Page 3 of 22

Version 1.0

DO6000000231

April, 2007

can use the object in the command get object help for a list of tokens for that
object.
3.1

System Commands

System commands will allow the user to view and change general system
setpoints such as float voltage and alarms.
Example: To set the system Preset to Preset A use the following command
Unassigned>set system PresetA
System Commands
Verb
Object
get
system

Token
location

set
get
get
get
get

system
system
system
system
system

location
state
voltage
current
alarm

get
set
get
set

system
system
system
system

preset
preset
DateTime
DateTime

get
set

system
system

AdjustClock
AdjustClock

get
get

system
system

info
batHour

get

system

pm24Hour

get

system

pm15Minute

get

system

pmdata

Data

Description

Response
Returns system identifier

X = a valid Location/System Identifier Name

with a 20 character limit
Request_OK
System State :: System Normal/Alarm
voltage = X
current = X
System OK = any active alarm

X = Preset A, Preset B, or Preset C

X = MM/DD/YYYY HH:MM:SS

X = +326 to -164

Current parameters based on configuration:

preset = Preset X (X is the desired preset value)
Request_OK
DateTime = Day, MM/DD/YYYY, HH:MM:SS
Request_OK
RTC Calibration (seconds) = X.
Note:
1. Adjustments are added to the current RTC
setting. 2. Range +326..-164 (seconds) based on
30 day observations. A value of 0 (zero) resets
calibration to none. 3. Internally it is converted into
a nu
Request_OK
Location, State, Voltage, Current, Type, Battery
Current, Runtime, Alarms (if any)
batHour = X
Retrieves system Vmax, Vmin, Imax, Imin, IBmax,
IBmin, Tmax, TEmax, TEmin, ACF for a 24 hour
period
Retrieves system V, ILoad, IBat, AmbT, ExtT,
ACF for every 15 minutes in a 24 hour period
Retrieves system V, ILoad, IBat, AmbT, ExtT,
ACF for every 15 minutes in a 24 hour period

Table 1 System Commands

The following system tokens are available by entering: get system help

location The user defined name of the controller

state The current system state, either System Normal or System

Alarm

voltage The current system voltage

current The system current

alarm Displays any active system alarms

preset The most recently activated Preset. Presets are factory

defined values that are not user settable.

DateTime The system date and time

AdjustClock Allows the user to adjust the system clock to

compensate for lost or gained time on the real time clock. Generally

Page 4 of 22

Version 1.0

DO6000000231

April, 2007

the system runs for a 30 day period before the clocks are analyzed for
lost or gained time.

3.2

Info Displays all system information

batHour Displays the battery hour. This feature is obsolete.

pm24Hour Displays the load history everyday for the past three (3)
years

pm15Minute Displays the load history every 15 minutes for the last
24 hours

pmdata Displays the load history for every 15 minutes for the last 24
hours

Setpoint Commands

Setpoint commands will allow the user to view and change setpoint values.
Example: To set the float voltage to 54.00V use the following command
Unassigned>set setpoint FloatV 54
Setpoint Commands
Verb
Object
get
setpoint
set
setpoint
get
setpoint
set
setpoint
get
setpoint
set
setpoint
get
setpoint
get
setpoint
set
setpoint
get
setpoint
set
setpoint
get
setpoint
set
setpoint
get
setpoint
set
setpoint
get
setpoint
set
setpoint
get
setpoint
set
setpoint
get
setpoint
set
setpoint

Token
FloatV
FloatV
HVSD
HVSD
CurLmtState
CurLmtState
CurLimit
HVAlarm
HVAlarm
BDAlarm
BDAlarm
LVAlarm
LVAlarm
CommAlarm
CommAlarm
CommAsACF
CommAsACF
IShare
IShare
RedunAlarm
RedunAlarm

Description

Data
X

X = a valid float voltage value

X = a valid HVSD value

X = enabled or disabled

X = a valid HVAlarm value

X = a valid BDAlarm value

X = a valid LVAlarm value

X = enabled or disabled

X = enabled or disabled

X = enabled or disabled

X = enabled or disabled

Response
FloatV = X
Request_OK
HVSD = X
Request_OK
CurLmtState = enabled or disabled
Request_OK
CurLimit = X
HVAlarm = X
Request_OK
BDAlarm = X
Request_OK
LVAlarm = X
Request_OK
CommAlarm = enabled or disabled
Request_OK
CommAsACF = enabled or disabled
Request_OK
IShare = enabled or disabled
Request_OK
RedunAlarm = enabled or disabled
Request_OK

Table 2 Setpoint Commands

The following setpoint tokens are available by entering: get setpoint help

FloatV The voltage to which the rectifiers will regulate the plant
voltage during float mode (Volts)

HVSD The controller will shut down the rectifiers if the plant voltage
exceeds the high voltage shutdown value (Volts)

CurLmtState The state of the system current limit feature

CurLimit The controller will limit the current of each rectifier in the
system to this value (Amps)

Page 5 of 22

Version 1.0

DO6000000231

April, 2007

3.3

HVAlarm The controller will issue a high voltage alarm if the plant
voltage exceeds this value (Volts)

BDAlarm The controller will issue a battery-on-discharge alarm if the

plant voltage falls below this value (Volts)

LVAlarm The controller will issue a low voltage alarm if the plant
voltage falls below this value (Volts)

CommAlarm An alarm is set if any rectifier either stops

communicating or is removed from the shelf. User action is required to
clear the alarm from the front display.

CommAsACF Associates an AC failure alarm with the removal of a

rectifier. This is most useful for a loss of AC power to all rectifiers.

IShare Displays the state of the current share (IShare) alarm. An

alarm is set if the output current of any rectifier exceeds current
sharing tolerances.

RedunAlarm Displays the state of the system redundancy (N+1)

alarm. An alarm is set if the number of installed rectifiers will not
support N+1 redundancy required by the load.

Temperature Commands

Temperature commands will allow the user to view and change temperature
settings such as over temperature setpoints.
Example: To set the internal over temperature setpoint to 90 C use the following
command
Unassigned>set temp inthighlimit 90
Temperature Commands
Verb
Object
get
temp
get

temp

Token
internal
probeY
(Y = 1 - 4)

get
get
set

temp
temp
temp

all
unit
unit

get

temp

intlowlimit

get

temp

inthighlimit

get

temp

extlowlimit

get

temp

get

temp

set

temp

exthighlimit
ProbeYType
(Y = 1 - 4)
ProbeYType
(Y = 1 - 4)

Data

Description

X = C or F

X = disabled, TProbe, Encl NO, Encl NC,

Dist NO, Dist NC

Response
internal = X degree C/F
probeY = enabled, disabled, EnclAlarm,
DistAlarm, X degree C/F, or removed
internal = X degree C, probe1-4 = enabled or
disabled
unit = degree C or F
Request_OK
any valid temperature value between
30C/86F and 93C/199F
any valid temperature value between
30C/86F and 98C/208F
any valid temperature value between
30C/86F and 93C/199F
any valid temperature value between
30C/86F and 98C/208F
ProbeYType = disabled, TProbe, Encl NO,
Encl NC, Dist No, or Dist NC
Request_OK

Table 3 Temperature Commands

The following temperature tokens are available by entering: get temp help

internal Displays the internal temperature value (degree

celcius/fahrenheit)

Page 6 of 22

Version 1.0

DO6000000231

April, 2007

3.4

probeY (Y = 1 - 4) Displays the external temperature values for

selected probes 1, 2, 3, or 4 (degree celcius/fahrenheit)

all Displays all the external temperature values for probes 1 to 4

(degree celcius/fahrenheit)

unit The temperature unit (C or F) used for all temperature setpoints

intlowlimit The internal temperature value at which the controller will

release an over temperature alarm

inthighlimit The internal temperature value at which the controller

will trigger an over temperature alarm

extlowlimit The external temperature value at which the controller

will release an over temperature alarm

exthighlimit The external temperature value at which the controller

will trigger an over temperature alarm

ProbeYType (Y = 1 - 4) The type of the indicated input port:

Probe1Type, Probe2Type, Probe3Type, or Probe4Type

Rectifier Commands

Rectifier commands will allow the user to view and change rectifier settings such
as float voltage.
Example: To set the float voltage setpoint to 52.5V use the following command
Unassigned>set rect FloatV 52.5
Rectifier Commands
Verb
Object

Token

get
get
set
get
set
get
set
get
get
get
set
get
set
get
set
get
set

info
FloatV
FloatV
HVSD
HVSD
CurLmtState
CurLmtState
CurLimit
status
select
select
output
output
FBackState
FBackState
FBackVolt
FBackVolt

rect
rect
rect
rect
rect
rect
rect
rect
rect
rect
rect
rect
rect
rect
rect
rect
rect

Description

Data

X = a valid Float Voltage value

X = a valid HVSD setpoint

X = enabled or disabled

X = Shelf#, Module#

X = enabled or disabled

X = enabled or disabled

X = any valid Fallback value

Response
shelf#, module#, current output, rectifier
capacity, SerialNumber, Model#, status
FloatV = X
Request_OK
HVSD = X
Request_OK
CurLmtState = enabled or disabled
Request_OK
CurLimit = X
shelf#, module#, and status code
Selected Rect: Shelf#, Module#
Request_OK
Output (#,#) = enabled or disabled
Request_OK
FBackState = enabled or disabled
Request_OK
FBackVolt = X
Request_OK

Table 4 Rectifier Commands

The following rectifier tokens are available by entering: get rect help

info Displays information for all installed rectifiers

FloatV Displays the voltage to which the rectifiers will regulate the
plant during float mode

Page 7 of 22

Version 1.0

DO6000000231

April, 2007

3.5

HVSD The controller will shutdown the rectifiers if the plant voltage
exceeds this setpoint

CurLmtState Displays the state of the rectifier current limit feature

CurLimit The controller will limit the current of each rectifier to the
current limit value

status The status code of all rectifiers installed

select The shelf# and module# of the rectifier currently selected for
disabling the output

output The output status of the rectifier selected either enabled or

disabled. Warning: Disabling the outputs of all rectifiers can cause
loss of communication with the controller.

FBackState The status of the fallback feature. Fallback provides a

safe voltage to which the rectifiers will output when they lose
communication with the controller for more than one minute.

FBackVolt The voltage setpoint for the fallback feature

Low Voltage Disconnect (LVD) Commands

LVD commands will allow the user to view and change LVD settings such as
LVD open voltage. An LVD contactor must be installed in the system for the
commands to be useful.
Example: To set the LVD open voltage for disconnect1 to 42 V DC use the
following command
Unassigned>set LVD disconnect1 42.00
LVD Commands
Verb
Object

get

LVD

get

LVD

Token

set

LVD

info
disconnectY
= 1 - 4)
disconnectY
= 1 - 4)
discoDelayY
= 1 - 4)
discoDelayY
= 1 - 4)
reconnectY
= 1 - 4)
reconnectY
= 1 - 4)
recoDelayY
= 1 - 4)
recoDelayY
= 1 - 4)
auxinputY
= 1 - 4)
auxinputY
= 1 - 4)
contYRelay
= 1 - 4)
contYRelay
= 1 - 4)

get

LVD

all

set

LVD

get

LVD

set

LVD

get
set
get

LVD
LVD
LVD

set

LVD

get

LVD

set

LVD

get

LVD

Description

Data

Response
Encl#, Mod#, Cnt1, Cnt2, Batt-V, Plant-V,
Current, Serial Number, Model Number,
Status

(Y
disconnect1 to 4 = X
(Y
X

X = a valid LVD Open value

X = a valid Disconnect Delay

Request_OK

(Y
discoDelay1 to 4 = HH:MM:SS
(Y
Request_OK

(Y
reconnect1 to 4 = X
(Y
X

X = a valid reconnect value (V)

Request_OK

(Y
recoDelay1 to 4 = HH:MM:SS
(Y
X

X = a valid Reconnect Delay

Request_OK

(Y
auxinput1 to 4 = NormClose or NormOpen
(Y
X

X = NormClosed or NormOpen

Request_OK

(Y
Relay X
(Y
X

X = a valid contYRelay value

Request_OK
LVD# Configuration: Disconnect,
DiscoDelay, Reconnect, RecoDelay

Page 8 of 22

Version 1.0

DO6000000231

April, 2007

Table 5 LVD Commands

The following LVD tokens are available by entering: get LVD help

3.6

info Displays information for all installed LVDs

disconnectY (Y = 1 - 4) Displays the disconnect1 to 4 value (Volts).

The system LVD contactor will open if the battery voltage falls below
this setpoint

discoDelayY (Y = 1 - 4) Displays the discoDelay1 to 4 value. The

amount of time (HH:MM:SS) that the plant voltage must be below the
LVD disconnect setpoint prior to disconnecting the LVD contactor.

reconnectY (Y = 1 - 4) Displays the reconnect1 to 4 value (Volts).

The system LVD contactor will reconnect if the battery voltage exceeds
this point.

recoDelayY (Y = 1 - 4) Displays the recoDelay1 to 4 value. The

amount of time (HH:MM:SS) that the plant voltage must exceed the
LVD reconnect setpoint prior to reconnecting the LVD contactor.

auxinputY (Y = 1 - 4) Displays the alarm state of the auxiliary input

port 1 to 4.

contYRelay (Y = 1 - 4) The association between the auxiliary input

alarm with a controller output alarm (A-H) relay: cont1Relay,
cont2Relay, cont3Relay, and cont4Relay. For example, to set the
cont1Relay to associate with output alarm relay A use the command
set LVD cont1Relay A.

all Displays all information for all installed LVDs

Distribution Commands

Distribution commands allow the user to view information from distribution

modules (DM). Not all systems have the capability of using distribution
monitoring devices. Consult the Installation and Operation Manual for the
respective shelf for information on the use of DM devices.
Distribution Commands
Verb
Object

Token

get

info

distrib

Data

Description

Response
Bay, Enc, Mod, Currnt1, Currnt2, Currnt3,
Currnt4, SerialNumber, ModelNum, Status

Table 6 Distribution Commands

The following Distribution tokens are available by entering: get distrib help

info Displays all distribution information

Page 9 of 22

Version 1.0

DO6000000231

April, 2007

3.7

Converter Commands

Converter commands will allow the user to view and change settings for DC - DC
converters.
Example: To set the converter output voltage to 54.00V use the following
command
Unassigned>set conv outVsp 54.00
Conversion Commands
Verb
Object
get
conv
get
conv
get
conv
get
conv
set
conv
get
conv
set
conv
get
conv
set
conv
get
conv
set
conv

Token
info
voltage
current
outVsp
outVsp
hvsdsp
hvsdsp
CurLmtState
CurLmtState
CurLimit
CurLimit

Description

Data

X = a valid outVsp value

X = a valid hvsdsp value

X = enabled or disabled

X = a valid current limit value

Response
# of converter modules present
voltage = X
current = X
outVsp = X
Request_OK
hvsdsp = X
Request_OK
CurLmtState = enabled or disabled
Request_OK
CurLimit = X
Request_OK

Table 7 Conversion Commands

The following Converter tokens are available by entering: get conv help

3.8

info Displays the information for all converters installed

voltage Displays the output voltage of the DC - DC converters

current Displays the output current of the DC - DC converters

outVsp The voltage to which the controller will regulate the output of
the converters

hvsdsp The voltage at which the controller will shutdown the

converters

CurLmtState - Displays the state of the converter current limit feature.

The controller will limit the output current of the converters to the
CurLimit setpoint.

CurLimit - Displays the value to which the converters will be limited

Ringer Commands

Ringer commands will allow the user to view and change ringer settings. A
ringer must be installed in the Valere Power system for the commands to be
useful. Not all systems are available with an option for a ringer.
Example: To set the ringer AC output voltage to 86 V AC use the following
command
Unassigned>set ringer voltac 86.00

Page 10 of 22

Version 1.0

DO6000000231

April, 2007

Ringer Commands
Verb
Object

Token

get
get
set
get
set
get
set
get

info
voltac
voltac
voltdc
voltdc
freq
freq
active

ringer
ringer
ringer
ringer
ringer
ringer
ringer
ringer

Description

Data

X = a valid ringer AC voltage

X = a valid ringer DC voltage

X = a valid ringer frequency

Response
Shlf, Mod, Ac-V, Dc-V, Hz, SrNum,
ModelNum, RTime, Status
voltac = X
Request_OK
voltdc = X
Request_OK
freq = X
Request_OK
active = none, main, backup

Table 8 Ringer Commands

The following Ringer tokens are available by entering: get ringer help

3.9

info Displays information for installed ringers

voltac AC voltage setpoint for the ringer output

voltdc The DC value at which the ringer RMS value is offset. The
value should be the same value as the float voltage.

freq Displays the ringer frequency setpoint

active Displays the number of active ringers

TRIO Commands

TRIO commands will allow the user to view and change ringer settings such as
ringer setpoints. A TRIO must be installed in the Valere Power system for the
commands to be useful. Not all systems are available with an option for a TRIO.
Available TRIOs include J-TRIO (JK), H-TRIO-02 Mini System (HK-series), and
the CANTRIO (PM86000).
Example: To change the AlarmOutput relay name B to Minor use the following
command
Unassigned>set TRIO rname B = Minor
TRIO Commands
Verb
Object

Token

get

TRIO

info

get

TRIO

relay

get
set
get
set

TRIO
TRIO
TRIO
TRIO

rname
rname
select
select

get

TRIO

id

Data

Description

X = new name

X = a valid output relay

X, Y

X = a valid enclosure, Y = module number

Response
Enc, Mod, Temp1 - Temp8, RelayState,
Status
PulseWidth = HH:MM:SS, Relay Name,
Type, Polarity, State
Usage : set TRIO name, R = nameString or
clear, Where : R is relay letter (A-F) to
change
Request_OK
Selected TRIO : Encl X, Module X
Request_OK
Enc, Mod, SerialNumber, ModelNum, FwVer,
TestDate, TestTime, Status

Table 9 TRIO Commands

The following TRIO tokens are available by entering: get TRIO help

info Displays all information for installed TRIO devices/peripheral

monitoring (PM) devices

Page 11 of 22

Version 1.0

DO6000000231

April, 2007

relay Displays the state of the output relays for all TRIOs installed

rname Displays the name assigned to the output alarm relays on a

TRIO device

select Displays selected TRIO enclosure and module. A TRIO must

be selected to display specific information concerning that TRIO.

id Displays the enclosure, module, serial number, model number,

and status of the TRIOs

3.10 Temperature Compensation Commands

Temperature compensation commands will allow the user to view and change
temperature compensation settings.
Example: To set the start temperature to 35 C use the following command
Unassigned>set tcomp hiStartTemp 35
Temperature Compensation Commands
Verb
Object
Token
get
tcomp
adminState
set
tcomp
adminState
get
get
set
get
set
get
set
get
set
get
set
get
set
get
set
get
set
get
set
get
set

tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp
tcomp

operState
sense
sense
hiStartTemp
hiStartTemp
hiSlope
hiSlope
hiStopVolt
hiStopVolt
lowStartTemp
lowStartTemp
lowSlope
lowSlope
lowStopVolt
lowStopVolt
runawayTemp
runawayTemp
runawayStopVolt
runawayStopVolt
BoostAdjust
BoostAdjust

Data

Description
X

X = enabled or disabled

X = internal or external

X = a valid hiStartTemp value

X = a valid hiSlope value

X = a valid hiStopVolt value

X = a valid lowStartTemp

X = a valid lowSlope value

X = a valid lowStopVolt value

X = a valid runawayTemp value

X = a valid runawayStopVolt value

X = enabled or disabled

Response
adminState = enabled or disabled
Request_OK
operState = Inactive, Active Lo, Active Hi,
RunawayT
sense = internal or external
Request_OK
hiStartTemp = X degrees C
Request_OK
hiSlope = X
Request_OK
hiStopVolt = X
Request_OK
lowStartTemp = X degrees Celcius
Request_OK
lowSlope = X
Request_OK
lowStopVolt = X
Request_OK
runawayTemp = X degrees C
Request_OK
runawayStopVolt = X
Request_OK
BoostAdjust = enabled or disabled
Request_OK

Table 10 Thermal Compensation Commands

The following Temperature Compensation tokens are available by entering:

get tcomp help

adminState Displays the state of the temperature compensation

feature

operState Displays the current operating state of the temperature

compensation feature

sense Selects a temperature sensing device to use for battery

temperature compensation. Internal sensor or external temperature
probes. The controller will autosense when an external probe is
attached and automatically adjusts value to external.

Page 12 of 22

Version 1.0

DO6000000231

April, 2007

hiStartTemp The temperature at which the controller activates the

high temperature compensation feature

hiSlope The slope value at which the controller will reduce the float
voltage per degree if high temperature compensation is active

hiStopVolt The minimum voltage to which the controller will reduce

the plant voltage for high temperature compensation

lowStartTemp The temperature at which the controller activates the

low temperature compensation feature

lowSlope The slope value at which the controller will increase the
float voltage per degree if low temperature compensation is active

lowStopVolt The maximum voltage to which the controller will

increase the plant voltage for low temperature compensation

runawayTemp The temperature at which the controller will activate

the thermal runaway feature

runawayStopVolt The voltage to which the rectifiers will reduce for

temperatures above the runaway temperature

BoostAdjust Displays the thermal compensation BoostAdjust status

3.11 Boost Feature Commands

Boost commands will allow the user to view and change boost settings such as
boost voltage setpoints.
Example: To set the boost voltage to 56 V DC use the following command
Unassigned>set boost Voltage 56.00

Page 13 of 22

Version 1.0

DO6000000231

April, 2007

Boost Feature Commands

Verb
Object
get
boost
set
boost
get
boost
set
boost
get
boost
set
boost
get
boost

Token
Data
ManualMode
ManualMode
X
PeriodicMode
PeriodicMode
X
Period
Period
X
TimeOfDay

set
get
set
get
set
get
set
get
set
get

boost
boost
boost
boost
boost
boost
boost
boost
boost
boost

TimeOfDay
AutoCurMode
AutoCurMode
CurDelay
CurDelay
StartCur
StartCur
ACFMode
ACFMode
PwrOutDly

X = a valid input between 00:00:00 23:59:59

X = enabled or disabled

X = a valid input between 0 - 10

X = a valid StartCur value

X = enabled or disabled

set
get
set

boost
boost
boost

PwrOutDly
DropVoltage
DropVoltage

X = a valid input between 00:00:00 23:59:59

X = a valid DropVoltage value

get
get

boost
boost

OperState
Duration

set
get
set
get
set
get

boost
boost
boost
boost
boost
boost

Duration
Voltage
Voltage
StopCur
StopCur
actualtime

X = a valid input between 00:00:00 23:59:59

X = a valid Voltage value

X = a valid StopCur value

get

boost

results

get

boost

all

Description
X = enabled or disabled
X = enabled or disabled
X = a valid input between 1 - 365

Response
ManualMode = enabled or disabled
Request_OK
PeriodicMode = enabled or disabled
Request_OK
Period = # (days)
Request_OK
TimeOfDay = HH:MM:SS
Request_OK
AutoCurMode = enabled or disabled
Request_OK
CurDelay = 0 to 10
Request_OK
StartCur = X
Request_OK
ACFMode = enabled or disabled
Request_OK
PwrOutDly = HH:MM:SS
Request_OK
DropVoltage = X
Request_OK
OperState = Stop, Manual, Start, Periodic,
AutoCur, ACFMode
Duration = HH:MM:SS
Request_OK
Voltage = X
Request_OK
StopCur = X
Request_OK
actualtime = HH:MM:SS
results = stopped, successful, aborted, or
active
all = ManualMode, PeriodicMode, Period,
TimeOfDay, AutoCur mode, Current delay,
Start current, ACF Mode, PwrOutDly, Drop
Voltage, Operating State, Duration, Voltage,
Actual Time, Results

Table 11 Boost Feature Commands

The following Boost tokens are available by entering: get boost help

ManualMode Enables or disables the manual boost mode feature

PeriodicMode Enables or disables automatic boost mode that runs

a boost test every X number of days

Period The number of days in between periodic boost tests

TimeOfDay The time of day the periodic boost mode will start
(HH:MM:SS). 24 hour format.

AutoCurMode Enables or disables the current based autoboost test.

When enabled the boost feature will automatically start if the start
current value is exceeded.

CurDelay The amount of time the start current must be exceeded

before the test will start (minutes).

StartCur The value at which the current autoboost test will start
(Amps).

Page 14 of 22

Version 1.0

DO6000000231

April, 2007

ACFMode Enables or disables the AC fail based autoboost test.

When enabled the boost feature will automatically start if an AC failure
lasted longer than the AC fail duration.

PwrOutDly The length of time (HH:MM:SS) the AC failure must last

to trigger the autoboost feature

DropVoltage The voltage the batteries must drop below during the
AC failure to trigger the autoboost feature (V)

OperState The current state of the boost feature

Duration Duration of time the boost charge is active (HH:MM:SS)

Voltage The voltage at which the boost feature will increase the float
voltage to boost charge the batteries

StopCur The lower limit (Amps) at which the boost test will stop.
0 = disabled. Requires battery shunt.

actualtime Displays the amount of time the boost test ran

results Displays the results of the boost test

all Displays all boost information

3.12 Battery Discharge Test (BDT) Commands

Battery discharge test commands will allow the user to view and change battery
discharge settings.
Example: To set the discharge test alarm voltage to 48 V DC use the following
command
Unassigned>set bdt alarmvoltage 48.00

Page 15 of 22

Version 1.0

DO6000000231

April, 2007

Battery Discharge Test (BDT) Commands

Verb
Object
Token
get
get
set
get

bdt
bdt
bdt
bdt

operState
manualMode
manualMode
duration

set
get

bdt
bdt

duration
alarmvoltage

set
get

bdt
bdt

alarmvoltage
abortvoltage

set
get
set
get
get
get

bdt
bdt
bdt
bdt
bdt
bdt

abortvoltage
TCompAdjust
TCompAdjust
actualtime
startvoltage
endvoltage

get
get
set

bdt
bdt
bdt

set
get
set
get
set

bdt
bdt
bdt
bdt
bdt

results
alarm
alarm
SchedY
= 1 - 12)
SchedY
= 1 - 12)
oppMode
oppMode
alarmDelay
alarmDelay

get

bdt

all

get

bdt

Description

Data

X = enabled or disabled

X = a valid input between 00:00:00 23:59:59

Sets the BDT alarm voltage (must be 2 V

greater than LVD Open) X = a valid
alarmvoltage value

Sets the BDT abort voltage (must be 1V

greater than LVD Open) X = a valid
abortvoltage value

X = enabled or disabled

X = active or inactive

Response
operState = Stop, Manual, Start, Periodic,
AutoCur, ACFMode
manualMode = enabled or disabled
Request_OK
duration = HH:MM:SS
Request_OK
alarmvoltage = X

Request_OK
abortvoltage = X

Request_OK
TCompAdjust = enabled or disabled
Request_OK
actualtime = HH:MM:SS
startvoltage = X
endvoltage = X
results = cleared, passed, failed, stopped,
aborted, in progress
Alarm State = active or inactive
Request_OK

(Y
SchedY = MM/DD, HH:MM
(Y
X

X = MM/DD, HH:MM

X = enabled or disabled

X = a valid input between 0 - 30

Request_OK
oppMode = enabled or disabled
Request_OK
alarmDelay = X
Request_OK
Battery Discharge Test (BDT): Manual Mode,
Oper State, Duration, Alarm Voltage, Abort
Voltage, Tcomp Adjust, Actual Time, Start
Voltage, End Voltage, Results, Alarm State,
Sched 1-12

Table 12 Battery Discharge Test (BDT) Commands

The following BDT tokens are available by entering: get bdt help

operState Displays the current operating state of the battery

discharge test feature

manualMode Enables or disables the manual battery discharge

mode feature

duration Sets the length of time (HH:MM:SS) that the battery

discharge test will run

alarmvoltage The voltage at which an alarm will be generated if the

battery voltage falls below this setpoint during the battery discharge
test. The voltage must be 2V greater than LVD Open.

abortvoltage The voltage at which the battery discharge test will

abort at when the system voltage drops below this setpoint. The
voltage must be 1V greater than LVD Open.

TCompAdjust Enabling this value will take thermal compensation

effects into account during the test. Disabling this value will disable
thermal compensation effects during the test. Both thermal
compensation and TComp BDT have to be enabled for thermal
compensation effects to take place during BDT.

Page 16 of 22

Version 1.0

DO6000000231

April, 2007

actualtime Displays the actual time the BDT test ran

startvoltage Displays the voltage reading from the beginning of the

discharge test

endvoltage Displays the voltage reading from the end of the

discharge test

results Displays the results of the BDT

alarm Displays the alarm states during the BDT

SchedY (Y = 1 - 4) Allows the user to set up to 12 different schedules

for automatically activating the battery on discharge test based on date
(MM/DD) and time (HH:MM)

oppMode Displays the BDT opportunistic mode. The oppMode

feature allows BDT information to be collected in the event of AC
power loss and the system switches to battery power.

alarmDelay The amount of delay in seconds the test must be below

the alarm voltage before an alarm is produced

all Displays all BDT information

3.13 Battery Recharge Current Limit Commands

Battery recharge current limit (BRCL) commands will allow the user to view and
change BRCL settings such as enabling or disabling the adminState feature or
setting the iLimitsp.
Example: To set the BRCL iLimit to 600A use the following command
Unassigned>set brcl iLimit 600
Battery Recharge Current Limit (BRCL) Commands
Description
Verb
Object
Token
Data
get
brcl
operState
get
brcl
adminState
set
brcl
adminState
X
X = enabled or disabled
get
brcl
iLimitsp
set
brcl
iLimitsp
X
X = a valid iLimitsp value

Response
operState = inactive or active
adminState = enabled or disabled
Request_OK
iLimitsp = X
Request_OK

Table 13 Battery Recharge Current Limit (BRCL) Commands

The following BRCL tokens are available by entering: get brcl help

operState - Displays the current operating state of the BRCL

adminState - Displays the state of the BRCL feature

iLimitsp Displays the BRCL current limit setpoint

3.14 Alarm Set Y Commands

Alarm Set Y (Y = 1 to 4) commands will allow the user to view and change alarm
settings such as assigning alarms to relays.
Example: To set an alarm to relay A use the following command
Page 17 of 22

Version 1.0

DO6000000231

April, 2007

Unassigned>set AlarmSetY relayA 00000001

Alarm Set 1 to 4 Commands
Verb
Object
Token

get
set

AlarmSet1
AlarmSet1

get
set
get
set

major
major

get
get
set
get
set
get
set
get
set
get
set
get
set
get
set
get
set
get

AlarmSet1
minor
AlarmSet1
minor
AlarmSet1
audible
AlarmSet1
audible
AlarmSetY (Y
= 1 - 4)
device
AlarmSetY
relayA
AlarmSetY
relayA
AlarmSetY
relayB
AlarmSetY
relayB
AlarmSetY
relayC
AlarmSetY
relayC
AlarmSetY
relayD
AlarmSetY
relayD
AlarmSetY
relayE
AlarmSetY
relayE
AlarmSetY
relayF
AlarmSetY
relayF
AlarmSetY
relayG
AlarmSetY
relayG
AlarmSetY
relayH
AlarmSetY
relayH
AlarmSetY
example

get
get

AlarmSetY
AlarmSetY

Data

Description

Response

X = valid alarm hex value

major Alarm Mask: High Voltage Warning

Alarm, High Voltage Shutdown Alarm,
Battery on Discharge Alarm, LVD Open
Alarm, Multiple Rectifier Fail Alarm, Multiple
Ringer Alarm, Ringer Communication Alarm
Request_OK

X = valid alarm hex value

X = valid alarm hex value

X = valid alarm hex value

X = valid alarm hex value

X = valid alarm hex value

X = valid alarm hex value

X = valid alarm hex value

X = valid alarm hex value

X = valid alarm hex value

X = valid alarm hex value

minor Alarm Mask: LVD Warning Alarm,

Distribution Alarm, Auxiliary Alarm, System
Redundant Capacity Alarm, Rectifier Current
Share Alarm, Single Rectifier Fail Alarm,
Module Communication Alarm, System Over
Temperature Alarm, Thermal Runaway
Alarm, Batter
Request_OK
audible Alarm Mask: 0x00000000
Request_OK
AlarmMaskSetY : Controller Builtin TRIO :: 8
Relays
relayA AlarmMask : 0xHex Value
Request_OK
relayB AlarmMask : 0xHex Value
Request_OK
relayC AlarmMask : 0xHex Value
Request_OK
relayD AlarmMask : 0xHex Value
Request_OK
relayE AlarmMask : 0xHex Value
Request_OK
relayF AlarmMask : 0xHex Value
Request_OK
relayG AlarmMask : 0xHex Value
Request_OK
relayH AlarmMask : 0xHex Value
Request_OK
example AlarmMask : 0xHex Value
AlarmMaskSet1 : Controller Builtin TRIO :: 8
Relays, R, Relay Name, Mask, RelayState
Selected TRIO : Encl#, Module#

info
name

Table 14 Alarm Set 1 to 4 Commands

The following AlarmSetY tokens are available by entering: get AlarmSetY help

major Displays the major alarm mask: High Voltage Warning Alarm,
High Voltage Shutdown Alarm, Battery on Discharge Alarm, LVD Open
Alarm, Multiple Rectifier Fail Alarm, Multiple Ringer Alarm, Ringer
Communication Alarm

minor Displays the minor alarm mask: LVD Warning Alarm,

Distribution Alarm, Auxiliary Alarm, System Redundant Capacity
Alarm, Rectifier Current Share Alarm, Single Rectifier Fail Alarm,
Module Communication Alarm, System Over Temperature Alarm,
Thermal Runaway Alarm, Battery Discharge Test Alarm, Ringer A
Alarm, Ringer B Alarm, TProbe Alarm, Distribution Comm. Alarm

audible Displays audible alarm mask

device Displays Alarm Mask Set Y (Y = 1 - 4)

relayA to H Displays alarms in relays A to H

Page 18 of 22

Version 1.0

DO6000000231

April, 2007

example Displays the hex value of all alarms

info Displays AlarmSetY information (Y = 1 - 4)

name Displays AlarmSetY (Y = 1 - 4) selected TRIO enclosure and

module

Setting alarms requires entering a corresponding hex value for the alarm. Get
hex values for alarms by entering: get AlarmSetY example, or refer to Table 15.
For example, to assign an AC Fail Alarm to Relay A use the following command:
Unassigned>set AlarmSetY RelayA 00000004
Multiple alarms can be assigned to a relay by using +hex value. For example, to
add an AC Fail Alarm and an LVD Warning Alarm to Relay A use the following
command:
Unassigned>set AlarmSetY RelayA 00000004 +00000040
Alarms can be removed from a relay by using hex value.
Alarm Hex Values
Hex Value
Alarm Name
00000001
Major Alarm
00000002
Minor Alarm
00000004
AC Fail Alarm
00000008
High Voltage Warning Alarm
00000010
High Voltage Shutdown Alarm
00000020
Battery on Discharge Alarm
00000040
LVD Warning Alarm
LVD Open Alarm
00000080
00000100
Distribution Alarm
00000200
Auxiliary Alarm
00000400
Module Communication Alarm
00000800
Rectifier Current Share Alarm
00001000
Single Rectifier Fail Alarm
00002000
Multiple Rectifier Fail Alarm
00004000
Module Communication Alarm
00008000
System Over Temperature Alarm

Hex Value
00010000
00020000
00040000
00080000
00100000
00200000
00400000
00800000
01000000
02000000
04000000
08000000
10000000
20000000
40000000
80000000

Alarm Name
Thermal Runaway Alarm
Battery Discharge Test Alarm
Ringer A Alarm
Ringer B Alarm
Single Ringer Alarm
Multiple Ringer Alarm
TProbe Alarm
Ringer Communication Alarm
Distribution Comm. Alarm
Single Converter Fail Alarm
Multiple Converter Fail Alarm
Unmapped I2C Address
Config Error
Display Firmware Mismatch
Converter Input Fail Alarm
LMP Battery Alarm

Table 15 Alarm Hex Values

3.15 dName Commands

Distribution name commands will allow the user to such as.
Example: To set the dName State to enabled use the following command
Unassigned>set dName State enabled

Page 19 of 22

Version 1.0

DO6000000231

April, 2007

dName Commands
Verb
Object
get
dName
set
dName

set

dName

Token
State
State
NameY
= 1 - 4)
NameY
= 1 - 4)

get
set

dName
dName

all
all

get

dName

Description

Data
X

X = enabled or disabled

Response
dName = enabled or disabled
Request_OK

(Y
NameY = X
(Y
X

X = a valid dName identifier

X = a valid dName identifier

Request_OK
Name1 = X, Name2 = X, Name3 = X, Name4
=X
Request_OK

Table 16 dName Commands

The following dName tokens are available by entering: get dName help

State Displays the current state of the dName feature

NameY (Y = 1 to 4) Allows the user to assign a unique name to the

dName NameY relays

all Displays all the dName NameY relays

3.16 IP Configuration
IP configuration commands will allow the user to view and IP address settings
such as assigning Tcp Ports, SNMP traps or gateway addresses.
Example: To set the gateway address use the following command
Unassigned>set ipconfig gateway xxx.xxx.xxx.xxx (a valid gateway
address)
IPConfig Commands
Verb
Object
get
ipconfig
set
ipconfig
get
ipconfig
set
ipconfig
get
ipconfig
set
ipconfig

Token
address
address
mask
mask
gateway
gateway

get

all

ipconfig

set
get
set
get
set

ipconfig
ipconfig
ipconfig
ipconfig
ipconfig

get

ipconfig

set

ipconfig

all
commit
commit
WebPort
WebPort
TrapDestY
(Y = 1 - 4)
TrapDestY
(Y = 1 - 4)

Description

Data
X

X = a valid IP address

X = a valid IP mask address

X = a valid IP gateway address

xxx.xxx.xxx.xxx,
xxx.xxx.xxx.xxx,
xxx.xxx.xxx.xxx

Sets controller IP address, Mask, and

Gateway

X = static or dynamic

X = a valid TcpPort value

X = a valid TrapDestY value

Response
Ip Type = dynamic, Ip Address = X
Request_OK
Ip Type = dynamic, Ip Mask = X
Request_OK
Ip Type = dynamic, Ip Gateway = X
Request_OK
Ip Type = dynamic, Ip Address = X, Ip Mask
= X, Ip Gateway = X

Request_OK
Ip Type = static or dynamic
Request_OK
TcpPort = xxxxx
Request_OK, controller reboot
Trap Dest [0] = x.x.x.x, Trap Dest [1] =
x.x.x.x, Trap Dest [2] = x.x.x.x, Trap Dest [3]
= x.x.x.x
Request_OK

Table 17 IP Configuration Commands

The following IP Configuration tokens are available by entering: get ipconfig help

address Displays the IP address of the controller

mask Displays the network mask address of the controller

gateway Displays the gateway address of the controller

all Displays the IP address, mask address, and gateway address

Page 20 of 22

Version 1.0

DO6000000231

April, 2007

commit Displays the state, either static or dynamic, of the IP

address

WebPort Displays the Tcp port number being used for webpage
access.

TrapDestY (Y = 1 to 4) Displays the IP address where the SNMP

traps will be sent. Up to 4 addresses can be added.

3.17 Web Commands

Web commands will allow the user to view web information, web ports and kill
previous Admin logins. The kill feature requires logging in to Telnet as a User
then entering an Admin password to override the previous Admin login.
Example: To get the web port use the following command
Unassigned>get web port
Web Commands
Verb
Object
get
web
get
web
set
web
set
web
* see get ipconfig webport

Token

Description

Data

info
port
port
kill

X
X

Response
Controller IP, Port, idx, client IP Addrs, cPort,
state, WEB page, lgn lvl
Web Port = X
Request_OK, controller reboot
Request_OK

X = a valid web port value*

X = a valid Admin password

Table 18 Web Commands

The following Web tokens are available by entering: get web help

info Displays web information such as controller IP address, port,

client IP address and information for technical support debugging
commands

port Displays the current system web portal

kill Allows the user to log out a previous Admin login. The user must
log in to Telnet as a User with the User password and then use an
Admin password to execute the kill feature.

3.18 Log
Log commands will allow the user to clear system logs such as event, bdt,
pm24Hour, and pmdata. See more about log commands in Section 3.1.
Example: To clear the event log use the following command
Unassigned>set log event clear
System Load and Event Log Commands
Verb
Object
Token
Data
set
log
event
set
log
bdt
set
log
pm24Hour
set
log
pmdata

Description
clear
clear
clear
clear

Response
Request_OK
Request_OK
Request_OK
Request_OK

Table 19 Log Commands

Page 21 of 22

Version 1.0

DO6000000231

April, 2007

The following Log tokens are available by entering: get log help

event Clears the event log

bdt Clears the Battery Discharge Test (BDT) log

pm24Hour Clears the pm24Hour log

pmdata Clears the pmdata log

Page 22 of 22

Version 1.0

DO6000000231

April, 2007