You are on page 1of 22

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 Token Data Description Response
get system location Returns system identifier
X = a valid Location/System Identifier Name
set system location X with a 20 character limit Request_OK
get system state System State :: System Normal/Alarm
get system voltage voltage = X
get system current current = X
get system alarm System OK = any active alarm

Current parameters based on configuration:


get system preset preset = Preset X (X is the desired preset value)
set system preset X X = Preset A, Preset B, or Preset C Request_OK
get system DateTime DateTime = Day, MM/DD/YYYY, HH:MM:SS
set system DateTime X X = 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
get system AdjustClock a nu
set system AdjustClock X X = +326 to -164 Request_OK
Location, State, Voltage, Current, Type, Battery
get system info Current, Runtime, Alarms (if any)
get system batHour batHour = X
Retrieves system Vmax, Vmin, Imax, Imin, IBmax,
IBmin, Tmax, TEmax, TEmin, ACF for a 24 hour
get system pm24Hour period
Retrieves system V, ILoad, IBat, AmbT, ExtT,
get system pm15Minute ACF for every 15 minutes in a 24 hour period
Retrieves system V, ILoad, IBat, AmbT, ExtT,
get system pmdata 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.
• 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
3.2 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 Token Data Description Response
get setpoint FloatV FloatV = X
set setpoint FloatV X X = a valid float voltage value Request_OK
get setpoint HVSD HVSD = X
set setpoint HVSD X X = a valid HVSD value Request_OK
get setpoint CurLmtState CurLmtState = enabled or disabled
set setpoint CurLmtState X X = enabled or disabled Request_OK
get setpoint CurLimit CurLimit = X
get setpoint HVAlarm HVAlarm = X
set setpoint HVAlarm X X = a valid HVAlarm value Request_OK
get setpoint BDAlarm BDAlarm = X
set setpoint BDAlarm X X = a valid BDAlarm value Request_OK
get setpoint LVAlarm LVAlarm = X
set setpoint LVAlarm X X = a valid LVAlarm value Request_OK
get setpoint CommAlarm CommAlarm = enabled or disabled
set setpoint CommAlarm X X = enabled or disabled Request_OK
get setpoint CommAsACF CommAsACF = enabled or disabled
set setpoint CommAsACF X X = enabled or disabled Request_OK
get setpoint IShare IShare = enabled or disabled
set setpoint IShare X X = enabled or disabled Request_OK
get setpoint RedunAlarm RedunAlarm = enabled or disabled
set setpoint RedunAlarm X X = 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
• 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.
3.3 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 Token Data Description Response
get temp internal internal = X degree C/F
probeY probeY = enabled, disabled, EnclAlarm,
get temp (Y = 1 - 4) DistAlarm, X degree C/F, or removed
internal = X degree C, probe1-4 = enabled or
get temp all disabled
get temp unit unit = degree C or F
set temp unit X X = C or F Request_OK
any valid temperature value between
get temp intlowlimit 30°C/86°F and 93°C/199°F
any valid temperature value between
get temp inthighlimit 30°C/86°F and 98°C/208°F
any valid temperature value between
get temp extlowlimit 30°C/86°F and 93°C/199°F
any valid temperature value between
get temp exthighlimit 30°C/86°F and 98°C/208°F
ProbeYType ProbeYType = disabled, TProbe, Encl NO,
get temp (Y = 1 - 4) Encl NC, Dist No, or Dist NC
ProbeYType X = disabled, TProbe, Encl NO, Encl NC,
set temp (Y = 1 - 4) X Dist NO, 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
• 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
3.4 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 Data Description Response
shelf#, module#, current output, rectifier
get rect info capacity, SerialNumber, Model#, status
get rect FloatV FloatV = X
set rect FloatV X X = a valid Float Voltage value Request_OK
get rect HVSD HVSD = X
set rect HVSD X X = a valid HVSD setpoint Request_OK
get rect CurLmtState CurLmtState = enabled or disabled
set rect CurLmtState X X = enabled or disabled Request_OK
get rect CurLimit CurLimit = X
get rect status shelf#, module#, and status code
get rect select Selected Rect: Shelf#, Module#
set rect select X X = Shelf#, Module# Request_OK
get rect output Output (#,#) = enabled or disabled
set rect output X X = enabled or disabled Request_OK
get rect FBackState FBackState = enabled or disabled
set rect FBackState X X = enabled or disabled Request_OK
get rect FBackVolt FBackVolt = X
set rect FBackVolt X X = any valid Fallback value 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
• 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
3.5 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 Token Data Description Response
Encl#, Mod#, Cnt1, Cnt2, Batt-V, Plant-V,
Current, Serial Number, Model Number,
get LVD info Status
disconnectY (Y
get LVD = 1 - 4) disconnect1 to 4 = X
disconnectY (Y
set LVD = 1 - 4) X X = a valid LVD Open value Request_OK
discoDelayY (Y
get LVD = 1 - 4) discoDelay1 to 4 = HH:MM:SS
discoDelayY (Y
set LVD = 1 - 4) X X = a valid Disconnect Delay Request_OK
reconnectY (Y
get LVD = 1 - 4) reconnect1 to 4 = X
reconnectY (Y
set LVD = 1 - 4) X X = a valid reconnect value (V) Request_OK
recoDelayY (Y
get LVD = 1 - 4) recoDelay1 to 4 = HH:MM:SS
recoDelayY (Y
set LVD = 1 - 4) X X = a valid Reconnect Delay Request_OK
auxinputY (Y
get LVD = 1 - 4) auxinput1 to 4 = NormClose or NormOpen
auxinputY (Y
set LVD = 1 - 4) X X = NormClosed or NormOpen Request_OK
contYRelay (Y
get LVD = 1 - 4) Relay X
contYRelay (Y
set LVD = 1 - 4) X X = a valid contYRelay value Request_OK
LVD# Configuration: Disconnect,
get LVD all 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
• info – Displays information for all installed LVD’s
• 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 LVD’s
3.6 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 Data Description Response
Bay, Enc, Mod, Currnt1, Currnt2, Currnt3,
get distrib info 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 Token Data Description Response
get conv info # of converter modules present
get conv voltage voltage = X
get conv current current = X
get conv outVsp outVsp = X
set conv outVsp X X = a valid outVsp value Request_OK
get conv hvsdsp hvsdsp = X
set conv hvsdsp X X = a valid hvsdsp value Request_OK
get conv CurLmtState CurLmtState = enabled or disabled
set conv CurLmtState X X = enabled or disabled Request_OK
get conv CurLimit CurLimit = X
set conv CurLimit X X = a valid current limit value Request_OK

Table 7 – Conversion Commands


The following Converter tokens are available by entering: get conv help
• 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
3.8 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 Data Description Response
Shlf, Mod, Ac-V, Dc-V, Hz, SrNum,
get ringer info ModelNum, RTime, Status
get ringer voltac voltac = X
set ringer voltac X X = a valid ringer AC voltage Request_OK
get ringer voltdc voltdc = X
set ringer voltdc X X = a valid ringer DC voltage Request_OK
get ringer freq freq = X
set ringer freq X X = a valid ringer frequency Request_OK
get ringer active active = none, main, backup

Table 8 – Ringer Commands

The following Ringer tokens are available by entering: get ringer help
• 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
3.9 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 Data Description Response
Enc, Mod, Temp1 - Temp8, RelayState,
get TRIO info Status
PulseWidth = HH:MM:SS, Relay Name,
get TRIO relay Type, Polarity, State
Usage : set TRIO name, R = nameString or
clear, Where : R is relay letter (A-F) to
get TRIO rname change
set TRIO rname X = new name X = a valid output relay Request_OK
get TRIO select Selected TRIO : Encl X, Module X
set TRIO select X, Y X = a valid enclosure, Y = module number Request_OK
Enc, Mod, SerialNumber, ModelNum, FwVer,
get TRIO id 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 Data Description Response
get tcomp adminState adminState = enabled or disabled
set tcomp adminState X X = enabled or disabled Request_OK
operState = Inactive, Active Lo, Active Hi,
get tcomp operState RunawayT
get tcomp sense sense = internal or external
set tcomp sense X X = internal or external Request_OK
get tcomp hiStartTemp hiStartTemp = X degrees C
set tcomp hiStartTemp X X = a valid hiStartTemp value Request_OK
get tcomp hiSlope hiSlope = X
set tcomp hiSlope X X = a valid hiSlope value Request_OK
get tcomp hiStopVolt hiStopVolt = X
set tcomp hiStopVolt X X = a valid hiStopVolt value Request_OK
get tcomp lowStartTemp lowStartTemp = X degrees Celcius
set tcomp lowStartTemp X X = a valid lowStartTemp Request_OK
get tcomp lowSlope lowSlope = X
set tcomp lowSlope X X = a valid lowSlope value Request_OK
get tcomp lowStopVolt lowStopVolt = X
set tcomp lowStopVolt X X = a valid lowStopVolt value Request_OK
get tcomp runawayTemp runawayTemp = X degrees C
set tcomp runawayTemp X X = a valid runawayTemp value Request_OK
get tcomp runawayStopVolt runawayStopVolt = X
set tcomp runawayStopVolt X X = a valid runawayStopVolt value Request_OK
get tcomp BoostAdjust BoostAdjust = enabled or disabled
set tcomp BoostAdjust X X = 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 Token Data Description Response
get boost ManualMode ManualMode = enabled or disabled
set boost ManualMode X X = enabled or disabled Request_OK
get boost PeriodicMode PeriodicMode = enabled or disabled
set boost PeriodicMode X X = enabled or disabled Request_OK
get boost Period Period = # (days)
set boost Period X X = a valid input between 1 - 365 Request_OK
get boost TimeOfDay TimeOfDay = HH:MM:SS
X = a valid input between 00:00:00 -
set boost TimeOfDay X 23:59:59 Request_OK
get boost AutoCurMode AutoCurMode = enabled or disabled
set boost AutoCurMode X X = enabled or disabled Request_OK
get boost CurDelay CurDelay = 0 to 10
set boost CurDelay X X = a valid input between 0 - 10 Request_OK
get boost StartCur StartCur = X
set boost StartCur X X = a valid StartCur value Request_OK
get boost ACFMode ACFMode = enabled or disabled
set boost ACFMode X X = enabled or disabled Request_OK
get boost PwrOutDly PwrOutDly = HH:MM:SS
X = a valid input between 00:00:00 -
set boost PwrOutDly X 23:59:59 Request_OK
get boost DropVoltage DropVoltage = X
set boost DropVoltage X X = a valid DropVoltage value Request_OK
OperState = Stop, Manual, Start, Periodic,
get boost OperState AutoCur, ACFMode
get boost Duration Duration = HH:MM:SS
X = a valid input between 00:00:00 -
set boost Duration X 23:59:59 Request_OK
get boost Voltage Voltage = X
set boost Voltage X X = a valid Voltage value Request_OK
get boost StopCur StopCur = X
set boost StopCur X X = a valid StopCur value Request_OK
get boost actualtime actualtime = HH:MM:SS
results = stopped, successful, aborted, or
get boost results active
all = ManualMode, PeriodicMode, Period,
TimeOfDay, AutoCur mode, Current delay,
Start current, ACF Mode, PwrOutDly, Drop
Voltage, Operating State, Duration, Voltage,
get boost all 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 Data Description Response
operState = Stop, Manual, Start, Periodic,
get bdt operState AutoCur, ACFMode
get bdt manualMode manualMode = enabled or disabled
set bdt manualMode X X = enabled or disabled Request_OK
get bdt duration duration = HH:MM:SS
X = a valid input between 00:00:00 -
set bdt duration X 23:59:59 Request_OK
get bdt alarmvoltage alarmvoltage = X
Sets the BDT alarm voltage (must be 2 V
greater than LVD Open) X = a valid
set bdt alarmvoltage X alarmvoltage value Request_OK
get bdt abortvoltage abortvoltage = X
Sets the BDT abort voltage (must be 1V
greater than LVD Open) X = a valid
set bdt abortvoltage X abortvoltage value Request_OK
get bdt TCompAdjust TCompAdjust = enabled or disabled
set bdt TCompAdjust X X = enabled or disabled Request_OK
get bdt actualtime actualtime = HH:MM:SS
get bdt startvoltage startvoltage = X
get bdt endvoltage endvoltage = X
results = cleared, passed, failed, stopped,
get bdt results aborted, in progress
get bdt alarm Alarm State = active or inactive
set bdt alarm X X = active or inactive Request_OK
SchedY (Y
get bdt = 1 - 12) SchedY = MM/DD, HH:MM
SchedY (Y
set bdt = 1 - 12) X X = MM/DD, HH:MM Request_OK
get bdt oppMode oppMode = enabled or disabled
set bdt oppMode X X = enabled or disabled Request_OK
get bdt alarmDelay alarmDelay = X
set bdt alarmDelay X X = a valid input between 0 - 30 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,
get bdt all 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
Verb Object Token Data Description Response
get brcl operState operState = inactive or active
get brcl adminState adminState = enabled or disabled
set brcl adminState X X = enabled or disabled Request_OK
get brcl iLimitsp iLimitsp = X
set brcl iLimitsp X X = a valid iLimitsp value 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 Data Description Response

major Alarm Mask: High Voltage Warning


Alarm, High Voltage Shutdown Alarm,
Battery on Discharge Alarm, LVD Open
Alarm, Multiple Rectifier Fail Alarm, Multiple
get AlarmSet1 major Ringer Alarm, Ringer Communication Alarm
set AlarmSet1 major X X = valid alarm hex value Request_OK

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
get AlarmSet1 minor Alarm, Batter
set AlarmSet1 minor X X = valid alarm hex value Request_OK
get AlarmSet1 audible audible Alarm Mask: 0x00000000
set AlarmSet1 audible X X = valid alarm hex value Request_OK
AlarmSetY (Y AlarmMaskSetY : Controller Builtin TRIO :: 8
get = 1 - 4) device Relays
get AlarmSetY relayA relayA AlarmMask : 0xHex Value
set AlarmSetY relayA X X = valid alarm hex value Request_OK
get AlarmSetY relayB relayB AlarmMask : 0xHex Value
set AlarmSetY relayB X X = valid alarm hex value Request_OK
get AlarmSetY relayC relayC AlarmMask : 0xHex Value
set AlarmSetY relayC X X = valid alarm hex value Request_OK
get AlarmSetY relayD relayD AlarmMask : 0xHex Value
set AlarmSetY relayD X X = valid alarm hex value Request_OK
get AlarmSetY relayE relayE AlarmMask : 0xHex Value
set AlarmSetY relayE X X = valid alarm hex value Request_OK
get AlarmSetY relayF relayF AlarmMask : 0xHex Value
set AlarmSetY relayF X X = valid alarm hex value Request_OK
get AlarmSetY relayG relayG AlarmMask : 0xHex Value
set AlarmSetY relayG X X = valid alarm hex value Request_OK
get AlarmSetY relayH relayH AlarmMask : 0xHex Value
set AlarmSetY relayH X X = valid alarm hex value Request_OK
get AlarmSetY example example AlarmMask : 0xHex Value

AlarmMaskSet1 : Controller Builtin TRIO :: 8


get AlarmSetY info Relays, R, Relay Name, Mask, RelayState
get AlarmSetY name Selected TRIO : Encl#, Module#

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 Hex Value Alarm Name
00000001 Major Alarm 00010000 Thermal Runaway Alarm
00000002 Minor Alarm 00020000 Battery Discharge Test Alarm
00000004 AC Fail Alarm 00040000 Ringer A Alarm
00000008 High Voltage Warning Alarm 00080000 Ringer B Alarm
00000010 High Voltage Shutdown Alarm 00100000 Single Ringer Alarm
00000020 Battery on Discharge Alarm 00200000 Multiple Ringer Alarm
00000040 LVD Warning Alarm 00400000 TProbe Alarm
00000080 LVD Open Alarm 00800000 Ringer Communication Alarm
00000100 Distribution Alarm 01000000 Distribution Comm. Alarm
00000200 Auxiliary Alarm 02000000 Single Converter Fail Alarm
00000400 Module Communication Alarm 04000000 Multiple Converter Fail Alarm
00000800 Rectifier Current Share Alarm 08000000 Unmapped I2C Address
00001000 Single Rectifier Fail Alarm 10000000 Config Error
00002000 Multiple Rectifier Fail Alarm 20000000 Display Firmware Mismatch
00004000 Module Communication Alarm 40000000 Converter Input Fail Alarm
00008000 System Over Temperature Alarm 80000000 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 Token Data Description Response
get dName State dName = enabled or disabled
set dName State X X = enabled or disabled Request_OK
NameY (Y
get dName = 1 - 4) NameY = X
NameY (Y
set dName = 1 - 4) X X = a valid dName identifier Request_OK
Name1 = X, Name2 = X, Name3 = X, Name4
get dName all =X
set dName all X X = a valid dName identifier 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 Token Data Description Response
get ipconfig address Ip Type = dynamic, Ip Address = X
set ipconfig address X X = a valid IP address Request_OK
get ipconfig mask Ip Type = dynamic, Ip Mask = X
set ipconfig mask X X = a valid IP mask address Request_OK
get ipconfig gateway Ip Type = dynamic, Ip Gateway = X
set ipconfig gateway X X = a valid IP gateway address Request_OK
Ip Type = dynamic, Ip Address = X, Ip Mask
get ipconfig all = X, Ip Gateway = X
xxx.xxx.xxx.xxx,
xxx.xxx.xxx.xxx, Sets controller IP address, Mask, and
set ipconfig all xxx.xxx.xxx.xxx Gateway Request_OK
get ipconfig commit Ip Type = static or dynamic
set ipconfig commit X X = static or dynamic Request_OK
get ipconfig WebPort TcpPort = xxxxx
set ipconfig WebPort X X = a valid TcpPort value Request_OK, controller reboot
Trap Dest [0] = x.x.x.x, Trap Dest [1] =
TrapDestY x.x.x.x, Trap Dest [2] = x.x.x.x, Trap Dest [3]
get ipconfig (Y = 1 - 4) = x.x.x.x
TrapDestY
set ipconfig (Y = 1 - 4) X X = a valid TrapDestY value 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 Token Data Description Response
Controller IP, Port, idx, client IP Addrs, cPort,
get web info state, WEB page, lgn lvl
get web port Web Port = X
set web port X X = a valid web port value* Request_OK, controller reboot
set web kill X X = a valid Admin password Request_OK
* see get ipconfig webport

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 Description Response
set log event clear Request_OK
set log bdt clear Request_OK
set log pm24Hour clear Request_OK
set log pmdata clear 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

You might also like