WLP:BMS/CTS Protocol Commands
|
|
Contents
|
|
|
Interpretation
|
As a rule, the WLP will not generate a response to an unrecognized or syntactically wrong command;
superfluous arguments will be silently ignored rather than cause a syntax error.
Bad or invalid arguments may cause an error response.
Generally, the character immediately preceding terminator (CR) in a response will be a line feed LF (0x0A).
This line feed as well as the terminator have been omitted from the individual command descriptions for clarity.
|
Common Commands
|
|
The following commands are understood by both WLP-1 and WLP-2. Differences in the argument list
will be oulined in the command description.
SNO
RTC
BBS
LSS
AHL
IDN
MPT
ALS
VLS
RVC
EVS
IPS
CNT
AAK
Contents
|
SNO
|
Synopsis - read WLP serial number
Syntax:
SNO<cr> - read WLP serial number
WLP replies:
SNO Nxxxxx on standard platforms, where xxxxx is a 5-digit integer.
Other numbers/characters may occur on custom systems.
Maximum payload 16 characters. Contents
|
RTC
|
Synopsis - read or set WLP real time clock
Syntax:
RTC<cr> - read real time clock
RTC uuu dd-mm-yyyy hh:mm:ss<cr> - set real time clock
uuu is a weekday abbreviation sun, mon, tue, wed, thu, fri, sat
Readout format: RTC uuu dd-mm-yyyy hh:mm:ss (ST)
Postfixed parentheses contain ST eller NT for Daylight Savings and Standard Time respectively.
The following error messages are possible:
RTC: bad weekday - specified weekday does not correspond to specified calendar date
RTC: bad date/time - specified date/time invalid
RTC: bad format - insufficient argument count
WLP acknowledges real time clock setting by RTC: ok
Note! When several WLPs are networked, their real time clocks are synchronized to that of the network master
(gateway). Thus in WLP networks only the gateway's real time clock should be adjusted. The WLP automatically
switches to/from Daylight Savings Time unless this behaviour is deselected. Contents
|
BBS
|
Synopsis - read WLP bitbus width or section
Syntax:
BBS<cr> - read bitbus width
BBS n<cr> - hexdump bitbus section n
The WLP bitbus is an amassment of signals used for inter-process communication.
The bitbus width is the number of sections each holding 32 bits (signals) which comprises the entire bitbus.
When an argument is given to this function, it is used internally modulo the actual bus width for security reasons.
Readout format:
BBS n - bitbus width is given as an integer decimal number n.
BBS n: HHHHHHHH - bitbus section n represented as 8-digit hexadecimal.
Contents
|
LSS
|
Synopsis - read liquid sensor channel status
Syntax:
LSS<cr>
If all liquid sensor channels are error free, the reply is: LSS: Sensor(s) dry
If one or more channels has errors, the reply is: LSS: Sensor(s) [list] wet, where [list]
is a sequence of one or more channel numbers separated by spaces, e.g. 2 3 6.
Note that this status does not report defective sensors/cables, and that replies are on behalf of all channels
whether or not these are configures for use with liquid sensors. See also ALS.
Contents
|
AHL
|
Synopsis - print active host list
Syntax:
AHL<cr>
If WLP has no net routes, the reply is: AHL: Not gwy
If WLP is gateway, the reply is: AHL xxx.yyy.zzz.0: [list], where xxx.yyy.zzz.0 is the active network,
and where [list] is a sequence of active host numbers (last octet of host address).
Network master performs a continuous scan of the network for active hosts. An active host is a WLP which has
replied to the most recent query placed by the network master. A full subnet scan may take up to 5 min to complete.
Contents
|
IDN
|
Synopsis - read program ID/revision and system type
Syntax:
IDN<cr>
WLP-1 replies: IDN Krnl: 1nnnnn-yyyymmdd App: 1mmmmm-yyyymmdd DanTaet WLP-1 (List)
WLP-2 replies: IDN Krnl: 1nnnnn-yyyymmdd App: 1mmmmm-yyyymmdd DanTaet WLP-2 (Type)
where 1nnnnn and 1mmmmm are 6-digit program IDs and yyyymmdd is program revision date,
while (List) is a comma-separated list of monitor channels activated in WLP-1 and (Type) is one of Safety, ICW, Heating,
BCW denoting a WLP-2 system type. Contents
|
MPT
|
Synopsis - read WLP location/measuring point
Syntax:
MPT<cr> - read WLP location
MPT n<cr> - read WLP measuring point n
WLP location is a user-defined clear text description of the WLP installation point.
If user has entered a description, reply is MPT: description of max 55 characters;
otherwise reply is MPT: DanTaet WLP-1 or MPT: DanTaet WLP-2.
For WLP-1, user can further supply each monitor with a cleartext description of the monitor's measuring point.
This is read out by supplying the monitor number (1-4) as a function argument.
If user has entered a description, reply is MPT: description of max 55 characters;
otherwisw reply is MPT n: Monitor n, where n is the supplied argument.
Contents
|
ALS
|
Synopsis - read WLP alarm status
Syntax:
ALS<cr> - read status (WLP-2) / digest (WLP-1)
ALS n<cr> - read status for channel n (WLP-1)
WLP-1 digests alarm status thus:
1: msg 2: msg 3: msg 4: msg [PS][LS], where
msg is ok or alarm uuu dd-mm-yyyy hh:mm:ss, [PS] indicates power supply error,
while [LS] indicates liquid sensor error.
A status query for a particular monitor is replied by WLP-1:
n: ok for an error-free system,
n: type uuu dd-mm-yyyy hh:mm:ss for an alarm of type type,
n: Liquid Sensor Alarm for liquid sensor error.
WLP-2 replies OK for an error-free system, or type uuu dd-mm-yyyy hh:mm:ss for an alarm
of type type. Contents
|
VLS
|
Synopsis - read WLP valve status
Syntax:
VLS<cr> - read status (WLP-2) / digest (WLP-1)
VLS n<cr> - read status for channel n (WLP-1)
WLP-1 digests valve status thus:
VLS: 1: msg 2: msg 3: msg 4: msg, where
msg is Open or Closed.
A valve status query for a particular monitor is replied by WLP-1:
VLS n: Valve open, or
VLS n: Valve closed by [cause],
where [cause] identifies the circumstance which required the cut-off.
WLP-2 replies:
VLS: Valve open, or
VLS: Valve closed by [cause],
where [cause] identifies the circumstance which required the cut-off.
Contents
|
RVC
|
Synopsis - readout/perform remote valve closure
Syntax:
RVC<cr> (WLP-2)
RVC c<cr> (WLP-2)
RVC n<cr> (WLP-1)
RVC n c<cr> (WLP-1)
The argumentet c is Y (close valve) or N (do not close valve). If this argument
is absent, actual status of remote valve closure is returned.
Argument n is channel number (WLP-1).
WLP-1 replies:
RVC n: c, where n is channel number and c is Y (yes) or N (no).
WLP-2 replies:
RVC: c, where c is Y (yes) or N (no).
NB! WLP-1 ignores the RVC command if given without argument.
Warning: When a valve is closed by remote control, it may not be reopened locally from the WLP computer!
Contents
|
EVS
|
Synopsis - read actual events
Syntax:
EVS<cr>
This command reads actual events, i.e. influences that are currently impressed upon the system.
Events may be caused by external signals, manual influence, or by timer- and sequencer functions.
WLP replies:
EVS: <none> - no actual events
EVS: [list] - where [list] is a space-separated list of actual events, which may be:
rco1-4(gateway), reset, quiet, buzzer, frcdisch(WLP-1), suppress(WLP-2), suppr1-4(WLP-1)
rco1 - rco4 occur on a gateway where it indicates alarm callout on behalf of another network host.
reset and quiet indicate activation of the corresponding front panel keys.
buzzer indicates WLP acoustic alarm is active.
frcdisch indicates WLP-1 tightness test has opened the discharge valve for system testing.
suppress indicates WLP-2 has acknowledged a request for monitor suppression.
suppr1 - suppr4 indicate WLP-1 channel 1-4 has acknowledged a request for monitor suppression..
Contents
|
IPS
|
Synopsis - read actual input status
Syntax:
IPS<cr>
This command reads actual input status, i.e. external control signals currently present.
WLP replies:
IPS: <none> - no actual control input
IPS: [list] - where [list] is a space-separated list of actual signals, which can be:
ereset, evclos, esuppr, ekeysw(WLP-1), etherm(WLP-2), sel13, sel14
ereset indicates external reset signal present.
evclos indicates external valve close signal present.
esuppr indicates external suppression signal present.
ekeysw indicates external phase control signal present (WLP-1).
etherm indicates external thermostat signal present (WLP-2).
sel13 og sel14 indicate internal WLP jumper settings.
Note that the WLP's response to external signal is widely configurable via the menu system.
The presence of a given signal thus does not necessarily always imply a WLP response.
Contents
WLP-1 systems of revision 2007-07-07 and newer feature an abstraction layer between inputs and monitors, whereby
an input no longer performs a specific function. The signal names listed above thus need not reflect the function
performed by the signal in these systems. The actual function of a given input in such systems must be identified
from the Factory Settings in the menu system.
|
CNT
|
Synopsis - read WLP counter status
Syntax:
CNT n<cr> - read status for channel n
Counter status query for a given channel is replied by WLP:
CNT n Ttl: 0.000 m3 Stl: 0.000 m3 yyyy-mm-dd, where n is channel number,
Ttl is counter total, and Stl is counter subtotal with date of zeroing.
A standard WLP-2 employs channel 1 for forward counter and channel 2 for return counter.
In a WLP-1, the channel number is identical to the monitor number. Contents
|
AAK
|
Synopsis - alarm acknowledge
Syntax:
AAK<cr>
WLP replies: AAK: ok
Note this reply is given regardless of WLP alarm status prior to the query issue (!)
This command clears the alarm list, causing the WLP to resume monitoring until a new alarm
occurs. Contents
|
|
|
WLP-1 Specific Commands
|
|
IFF
AFF
MFF
DCH
CON
ITM
DCO
MPH
Contents
|
IFF
|
Synopsis - read instantaneous flow and -limit for channel
Syntax:
IFF n<cr>
WLP-1 replies: IFF n PkFlow: x.xxx m3/h Limit: x.xxx m3/h, where n is channel number,
first scalar is instantaneous flow and second scalar is alarm limit.
If this command is given without an argument, it will be ignored by WLP-1. Contents
|
AFF
|
Synopsis - read mean flow and -limit for channel
Syntax:
AFF n<cr>
WLP-1 replies: AFF n AvgFlw: x.xxx m3/h Limit: x.xxx m3/h, where n is channel number,
first scalar is mean flow and second scalar is alarm limit.
If this command is given without an argument, it will be ignored by WLP-1. Contents
|
MFF
|
Synopsis - read minimum flow and -limit for channel
Syntax:
MFF n<cr>
WLP-1 replies: MFF n MinFlw: x.xxx m3/h Limit: x.xxx m3/h, where n is channel number,
first scalar is minimum flow in present phase and second scalar is alarm limit.
If this command is given without an argument, it will be ignored by WLP-1. Contents
|
DCH
|
Synopsis - read discharge and -limit for channel
Syntax:
DCH n<cr>
WLP-1 replies: DCH n Dischg: x.xxx m3 Limit: x.xxx m3, where n is channel number,
first scalar is actual discharge and second scalar is alarm limit.
If this command is given without an argument, it will be ignored by WLP-1. Contents
|
CON
|
Synopsis - read constance and -limit for channel
Syntax:
CON n<cr>
WLP-1 replies: CON n Const: x s Limit: x s, where n is channel number,
first scalar is actual constance (sec) and second scalar is alarm limit.
If this command is given without an argument, it will be ignored by WLP-1. Contents
|
ITM
|
Synopsis - read actual and required idle periods for channel
Syntax:
ITM n<cr>
WLP-1 replies: ITM n Idle: x s Wanted: x s, where n is channel number,
first scalar is actual idle period (sec) and second scalar is required idle period.
If this command is given without an argument, it will be ignored by WLP-1. Contents
|
DCO
|
Synopsis - read daily consumption till now and rationing limit for channel
Syntax:
DCO n<cr>
WLP-1 replies: DCO n Used: x.xxx m3 Ration: x.xxx m3, where n is channel number,
first scalar is actual daily consumption and second scalar is rationing limit.
If this command is given without an argument, it will be ignored by WLP-1. Contents
|
MPH
|
Synopsis - read actual monitor phase for channel
Syntax:
MPH n<cr>
WLP-1 replies: MPH n: pha, where n is channel number and pha is one of
Low, High, Dbl, Trpl.
If this command is given without an argument, it will be ignored by WLP-1. Contents
|
WLP-2 Specific Commands
|
|
MFL
BMP
DIS
DDI
TRU
OIN
ECR
RFT
DDT
EMO
CMO
TTT
TMO
TME
ETT
ETS
ETR
ETI
ETC
ETV
ETK
Contents
|
MFL
|
Synopsis - read mean flow Forward and Return
Syntax:
MFL<cr>
A WLP-2 configured as Safety or ICW replies:
MFL Fwd: n.nn l/min Rtn: n.nn l/min
A WLP-2 configured as FVE (district heating) or BCW replies:
MFL Fwd: n.nnn m3/h Rtn: n.nnn m3/h Contents
|
BMP
|
Synopsis - read base measuring period
Syntax:
BMP<cr>
WLP-2 replies:
BMP nnn s Contents
|
DIS
|
Synopsis - read discard level
Syntax:
DIS<cr>
WLP-2 replies:
DIS n Contents
|
DDI
|
Synopsis - read discard mode
Syntax:
DDI<cr>
WLP-2 replies:
DDI Y (Double) eller DDI N (Single) Contents
|
TRU
|
Synopsis - read measuring period truncate level
Syntax:
TRU<cr>
WLP-2 replies:
TRU nn Contents
|
OIN
|
Synopsis - read observation interval
Syntax:
OIN<cr>
WLP-2 replies:
OIN n Contents
|
ECR
|
Synopsis - read error criterion
Syntax:
ECR<cr>
WLP-2 replies:
ECR n Contents
|
RFT
|
Synopsis - read refill time
Syntax:
RFT<cr>
WLP-2 replies:
RFT n s Contents
|
DDT
|
Synopsis - read dead time
Syntax:
DDT<cr>
WLP-2 replies:
DDT n s Contents
|
EMO
|
Synopsis - read error mode
Syntax:
EMO<cr>
WLP-2 replies:
EMO B (Scattered) eller EMO: A (Adjacent) Contents
|
CMO
|
Synopsis - read classic monitor state
Syntax
CMO<cr>
WLP-2 replies:
CMO sta: n (text) rmp: m s fwd: [h,i] rtn: [j,k] dif: l
where n is state number, (text) is one of
Refill, Disc1, Disc2, Monitor, Deadtime, Alarm, Quiet, m is maximum remaining measuring period,
h is unscaled forward meter impulses, i is internally scaled forward meter impulses,
j is unscaled return meter impulses, k is internally scaled return meter impulses and
l is the monitor flow difference counter. Contents
|
TTT
|
Synopsis - read trigger times for tightness test
Syntax:
TTT<cr>
WLP-2 replies:
TTT hh:mm hh:mm hh:mm hh:mm hh:mm hh:mm hh:mm hh:mm hh:mm hh:mm hh:mm hh:mm
where hh:mm specifies trigger time in hours and minutes, or --:-- if unused.
Tightness test runoff is subject to a series of conditions defined via the menu system and the system setup.
Actual time passing a trigger point thus does not necessarily result in a tightness test runoff.
Contents
|
TMO
|
Sysopsis - read tightness test state
Syntax:
TMO<cr>
WLP-2 replies:
TMO time: n s sqnc: m (txt1) calc: i (txt2) type: j (txt3)
where n is remaining test time, m is sequence status, txt1 is one of w_window,
w_flow, rv_close, w_rvlvc, acg_fwd, bv_close, rv_open, w_rvlvo, acq_rtn, tt_done, i is compute status,
txt2 is one of wait, prcfwd, prcrtn, expand, average, analyze, report, done, j is
the tigtness test type and txt3 is one of Normal, Short. Contents
|
TME
|
Synopsis - read tightness test measurement
Syntax:
TME<cr>
WLP-2 replies:
TME Fwd: n.n/m.m Rtn: i.i/j.j, where n.n is flow into the installation for cut-off
return valve and m.m is alarm limit for same while i.i is flow out of the installation for cut-off
forward valve and j.j is alarm limit for same. Contents
|
ETT *)
|
Synopsis - read energy total
Syntax:
ETT nm<cr>
Where n is a scale factor 0-4 og m is a unit selector 0-3.
Scale factor 0-4 multiples by 103, 100,
10-3, 10-6, 10-9 respectively,
while unit selector 0-3 denotes Wh, J, Cal or Btu.
WLP will present the energy total in the preferred unit, and - unless overflow results - using the preferred
prefix. If the desired readout causes overflow, the WLP will adjust the scale factor (and hence prefix) to avoid
the overflow condition.
WLP-2 replies:
Energy: n<prefix><unit>, where n may be up to 13 digits, prefix
can be (" ", "k", "M", "G", "T") and unit is Wh, J, Cal or Btu. Contents
|
ETS *)
|
Synopsis - read energy subtotal
Syntax:
ETS nm<cr>
where n is a scale factor 0-4 and m is a unit selector 0-3.
Scale factor 0-4 multiplies by 103, 100,
10-3, 10-6, 10-9 respectively,
while unit selector 0-3 denotes Wh, J, Cal or Btu.
WLP will present the energy subtotal in the preferred unit, and - unless overflow results - using the preferred
prefix. If the desired readout causes overflow, the WLP will adjust the scale factor (and hence prefix) to avoid
the overflow condition.
WLP-2 replies:
Energy: n<prefix><unit>, where n may be up to 13 digits, prefix
can be (" ", "k", "M", "G", "T") and unit is Wh, J, Cal or Btu. Contents
|
ETR *)
|
Synopsis - read and zero energy subtotal
Syntax:
ETR nm<cr>
where n is a scale factor 0-4 and m is a unit selector 0-3.
Scale factor 0-4 multiplies by 103, 100,
10-3, 10-6, 10-9 respectively,
while unit selector 0-3 denotes Wh, J, Cal or Btu.
WLP will present the energy subtotal in the preferred unit, and - unless overflow results - using the preferred
prefix. If the desired readout causes overflow, the WLP will adjust the scale factor (and hence prefix) to avoid
the overflow condition.
WLP-2 replies:
Energy: n<prefix><unit>, where n may be up to 13 digits, prefix
can be (" ", "k", "M", "G", "T") and unit is Wh, J, Cal or Btu.
The energy subtotal is then zeroed. Contents
|
ETI *)
|
Synopsis - read instantaneous energy transfer (power)
Syntax:
ETI nm<cr>
where n is a scale factor 0-4 and m is a unit selector 0-3.
Scale factor 0-4 multiplies by 103, 100,
10-3, 10-6, 10-9 respectively,
while unit selector 0-3 denotes W, Cal/m, Btu/h or Btu/m.
WLP will present the energy transfer in the preferred unit, and - unless overflow results - using the preferred
prefix. If the desired readout causes overflow, the WLP will adjust the scale factor (and hence prefix) to avoid
the overflow condition.
WLP-2 replies:
Power: n<prefix><unit>, where n can be up to 13 digits, prefix
can be (" ", "k", "M", "G", "T") and unit is W, Cal/m, Btu/h or Btu/m.
Contents
|
ETC *)
|
Synopsis - read energy measurement configuration
Syntax:
ETC<cr>
WLP-2 replies:
ETC: FwdT:n RtnT:m FwdP:i RtnP:j Volume meas:sss Mode:ttt,
where n, m, i, j are analog channel numbers (1-8) or Off,
sss is Fwd or Rtn, and ttt is On or Off.
For energy measurement, FwdT and RtnT must be assigned a channel number, and Mode must be
On. Pressure sensors can be employed when accuracy requirement and/or differential pressure is extreme.
Contents
|
ETV *)
|
Synopsis - read actual base data
Syntax:
ETV<cr>
WLP-2 replies:
ETV: nnnn.nn°C / mmmm.mm°C / iiii.iibar / jjjj.jjbar / kkkk.kkUUU,
where nnnn.nn is temperature T1, mmmm.mm is temperature T2,
iiii.ii is pressue P1, jjjj.jj is pressure P2, kkkk.kk is flow and
UUU is l/m for system types Safety and ICW, and m3/h
for system types FVE and BCW. Contents
|
ETK *)
|
Synopsis - read actual heat coefficient
Syntax:
ETK<cr>
WLP replies:
Coeff: nnn.nnnnnkWh/(m3K) (energy measurement active) or Coeff: Off (no energy measurement).
Contents
|
|
*) These commands will be replied to whether or not WLP-2 is configured for
energy measurement.
|
|