User Manual

UNIDOSwebline
Interfaces

D776.131.01/02 2009-09 Sa
 UNIDOSwebline Interfaces
Contents

Contents

Contents 2

1 Safety Information 3

2 Interface Configuration 4
2.1 RS232 Interface 4
2.2 Ethernet Interface and UDP 5

3 Interface Commands 6
3.1 Principles of Computer Communication 6
3.2 Command Structure 6
3.3 A Sample Session 7
3.4 Command Categories 7

4 Commands by Functions 8
4.1 Notes on Command Overview 8
4.2 General Commands 9
4.3 Status Request and Diagnosis 11
4.4 Measurement and Control Commands 13
4.5 Data Base Commands for Detectors 18
4.6 Data Base Commands for User Settings 23
4.7 Statistics Commands 27

5 Alphabetical Command List 31

6 Error Messages 32

2 D776.131.01/02
 UNIDOSwebline Interfaces
Safety Information

1 Safety Information

CAUTION
Improper handling.
Bodily Injury! Equipment damage!
This document is a supplement to the
UNIDOSwebline user manual and is valid only in
conjunction with that manual.
The safety statements appearing in the indicated
user manuals are applicable and must be ob-
served.

WARNING
Electricity is a source of risk, particularly when
the product is not in perfect operating condition
or when it is operated inappropriately.
Shock Hazard!
In addition to these safety statements, please
note that devices connected to the interface de-
scribed in this manual must fulfill the require-
ments of the standard IEC 60950-1.

PTW-FREIBURG
Physikalisch Technische Werkstätten
Dr. Pychlau GmbH
Lörracher Str. 7
79115 FREIBURG
GERMANY
Phone: +49 761 49055-0
Fax: +49 761 49055-70
[email protected]
www.ptw.de

D776.131.01/02 3
 UNIDOSwebline Interfaces
Interface Configuration

2 Interface Configuration

2.1 RS232 Interface For connections from UNIDOSwebline to the PC with

a standard 9 pin connector, use PTW cable
The serial interface of the UNIDOSwebline is a RS232 L178012 (2 m), L178026 (5 m) or T22373/K67-30
interface with the following configuration: (30 m).
For connections to a standard 25 pin connector use
Baud rates: 1200, 2400, 4800, 9600, a gender changer additionally or the PTW cable
14400, 19200, 38400, 57600 T22373/K49.
or 115200 (adjustable)
It is possible to work either with or without hardware
Code: 8 data bit
handshake.
Stop bit: 1 stop bit
For information only:
Parity: none
If the RS232 interface is at the quiescent state, the
Connector “SERIAL”: SUBD-connector, 9-pole, voltage measured at TxD is ≤ -5 V with reference to
female GND.
The RS232 interface is electrically isolated from the
measuring device.

The RS232 interface is of DTE type (data terminal

equipment), e.g., UNIDOSwebline sends on TxD and
drives RTS.

Pin assignment and connection to a 9-pole or 25-pole connector with ‘standard IBM layout’:

UNIDOSwebline IBM IBM

9-pole 9-pole 25-pole
Pin-No. Signal Type Pin-No. Pin-No. Signal Type
1 no connection ↔ 1 1 shield
2 TxD output → 2 3 RxD input
3 RxD input ← 3 2 TxD output
4 DTR * ← 4 5 DTR output
5 GND ↔ 5 4 GND
6 DSR * → 6 6 DSR input
7 CTS input ← 7 20 RTS output
8 RTS output → 8 7 CTS input
9 no connection

TxD = transmit data

RxD = receive data
GND = signal ground
CTS/RTS = handshake

*: Pins 4 and 6 are internally connected. By this, a DTR signal of the PC may be returned as DSR signal to the
PC.

4 D776.131.01/02
 UNIDOSwebline Interfaces
Interface Configuration

2.2 Ethernet Interface and UDP By means of UDP a virtual COM interface is de-
fined. Using an existing terminal program or any
Protocols of the TCP/IP family are used for the other software for RS232, you can then communi-
communication between UNIDOSwebline and a PC cate with UNIDOSwebline via this interface.
via the Ethernet interface, UDP protocols for send-
ing commands via the Ethernet interface. For fur- • Install a UDP driver on your PC. For information
ther information about configuring the Ethernet in- on the UDP driver recommended by PTW-
terface please refer to the UNIDOSwebline user man- Freiburg, refer to the PTW-Freiburg homepage.
ual.
• Start the UDP driver.
WARNING
• Define a virtual COM interface via the UDP
The UNIDOSwebline may adversely affect the data driver.
transmission of other clients in the network.
Network Problem! NOTE
Via the Ethernet interface, UNIDOSwebline may be The UDP port number for UNIDOSwebline is 8123.
connected to data networks, only if these net-
works do not determine the safety of the patient,
• Start a terminal program or any other software
the operator or other persons present, i.e., only
for RS232 and select this virtual interface for
to class A networks as defined in Annex H of
communication with UNIDOSwebline.
IEC 60601-1: 2005.

Only system administrators, who are capable of Æ The same commands can now be sent to
understanding, assessing and controlling the risk UNIDOSwebline via Ethernet as via the RS232
arising from the connection of UNIDOSwebline to interface.
the data network, are authorized to establish the
connection.
It must also be ensured that any future risk re-
sulting from changes to the data network (e.g.
connection of devices affecting the system safety
or changes to the network configuration, etc.) will
be understood, assessed and controlled.

D776.131.01/02 5
 UNIDOSwebline Interfaces
Interface Commands

3 Interface Commands

3.1 Principles of Computer 3.2 Command Structure

Communication
Commands are composed of the command key-
Between UNIDOS webline
and the connected PC, data word and one or more optional parameters. Key-
are communicated in the form of ASCII strings, word and parameters are separated by semicolons.
called commands. All commands are ending with If there is no further parameter, a trailing semicolon
<CR> (carriage return, hexadecimal 0D) and <LF> is not allowed.
(line feed, hexadecimal 0A). These end marks are
omitted in all command descriptions. Example:
PTW;UNIDOS2;x.xx;y
For all communication, a strict ping pong principle ↑ ↑ ↑ ↑
must be observed: after sending a command to the │ parameter
UNIDOSwebline, the PC must wait for the answer keyword
from UNIDOSwebline before it may send a new
command.
UNIDOSwebline will not send commands on its own; it
only sends answers, e.g. measuring values. If the
PC sends via the interface a command to the
UNIDOSwebline, it will not answer until it has
executed the appropriate actions.
If the PC sends an invalid command, an operator
error or a UNIDOSwebline defect occurs,
UNIDOSwebline will answer with an error message
instead of sending the expected answer.

NOTE
Commands are answered with error messages
while the SETUP menu is displayed or while a
setting is changed via the quickinfo window!
Exception: PTW and SER command

NOTE
To avoid confusion due to user operation at the
UNIDOSwebline keyboard or by VNC, it is recom-
mended to lock the UNIDOSwebline keyboard or
VNC by the KEY;0 command during remote
control of UNIDOSwebline.

NOTE
In the following user manual the character ● is
used to depict a space character contained in a
command.

6 D776.131.01/02
 UNIDOSwebline Interfaces
Interface Commands

3.3 A Sample Session 3.4 Command Categories

Perform steps 1 to 4 in the given sequence to set The commands can be divided into the following
up UNIDOSwebline and read out measured data. groups:

Step 1: physical setup 3.4.1 General Commands

Connect the UNIDOSwebline „Serial“ connector to the PTW Read device identification and firmware
RS232 connector of your PC with a suitable cable. version
Switch on UNIDOSwebline and set it manually to the SER Read serial number of the device
desired measuring parameters. The measurement KEY Read/Set keyboard lock
screen must be displayed. BR Read/Set baud rate
HS Read/Set handshake setting
Step 2: open communication
DTD Read/Set date
Start the communication program on your PC. DTT Read/Set time
Make sure that it is set up correctly.

Send a PTW command. The response must be 3.4.2 Status Request and Diagnosis
UNIDOS2;x.xx where x.xx is the firmware ver-
sion. Repeat this for a maximum of 3 times. If there S Read measurement status
is still no correct response, check the setup of the SE Read error status
computer program and the used communication SPS Read status of power supply
port.
NEW Recalculate the measured value multiplica-
tors
Step 3: read error status

Send a SE command. The answer has to be

3.4.3 Measurement and Control Commands
SE;0;0. Otherwise a device error exists and you
have to terminate the communication.
NUL Start zeroing
Step 4: start measurement and read data NUS Read zeroing status
RGE Read / Change measuring range
If step 3 succeeded, send a STA command and URE Read/Set radiological or electrical measur-
watch the UNIDOSwebline starting a measurement. If ing mode
the measured value is displayed, read it by sending HV Read/Set high voltage
a MV command. IT Read/Set integration time
STA Start a dose or charge measurement
INT Start an integration measurement
HLD Set the measurement to Hold mode
RES End a dose or charge measurement and
reset the measured values
MV Read measured values
MVM Read upper limit of measuring range
MVR Read display solution

D776.131.01/02 7
 UNIDOSwebline Interfaces
Commands by Functions

3.4.4 Data Base Commands for Detectors 4 Commands by Functions

DBC Select a detector data record as active
detector
4.1 Notes on Command
DAV Read/Set the value of a parameter of the
active detector
Overview
DBL Load a detector data record from the data For each command, the table contains the following
base to the data record work space
information:
DBV Read/Set the value of a parameter of the
data record work space • command and parameter formats
DBS Save the data record work space in a de-
tector data record of the data base • return format

• permitted parameter range

3.4.5 Data Base Commands for User Settings
• default parameter values
DUV Read/Set the value of a parameter of the are shown in the tables below in bold italics (xx)
user settings
• comments

3.4.6 Statistics Commands • the keywords of all commands are in CAPITAL

LETTERS and have to be sent in such a way
SPA Read/Set a statistics parameter
STO Add the displayed measured value to the • wild cards for the parameters are in lower case
statistics letters
SMC Read the status of the statistics measure-
ment / operate the statistics measurement • every parameter is separated by a semicolon
SDC Delete an entry/all entries from the statis-
tics list
• the decimal marker is the point
SDR;x Read an entry of the statistics list 4.1.1 CRC check sum
SDR Read the whole contents of the statistics
list The CRC check sum is calculated from all charac-
ters of the command, i.e. from the first character up
to and including the semicolon preceding the CRC
check sum. The polynomial used for calculation is:

CRC = x 16 + x 12 + x 5 + 1
The CRC check sum is transmitted in form of a
5-digit ASCII string.
(On request PTW-Freiburg will provide details of the
CRC calculation method.)

8 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

4.2 General Commands

Function Read device ID and firmware version
Command PTW
Answer PTW;UNIDOS2;x.xx;y
Parameters UNIDOS2 device ID
x.xx firmware version
y optional build number
Timeout ≤ 0,5 s

Function Read device serial number

Command SER
Answer SER;xxxxxx
Parameters xxxxxx device serial number
Timeout ≤ 0,5 s

Function Read keyboard lock

Command KEY
Function Set keyboard lock
Command KEY;x
Answer KEY;x
Parameters x 0 : keyboard locked
1 : keyboard unlocked
Timeout ≤ 0,5 s
Remarks This command also locks operation via VNC client.

Function Read baud rate

Command BR
Function Set baud rate
Command BR;x
Answer BR;x
Parameter x baud rate:
1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115000
Timeout ≤ 0,5 s
Remarks The answer will be sent with the old baud rate. Then the baud rate will be changed.

D776.131.01/02 9
 UNIDOSwebline Interfaces
Commands by Functions

Function Read handshake setting

Command HS
Function Set handshake setting
Command HS;x
Answer HS;x
Parameter x 0 : handshake switched off
1 : handshake switched on
Timeout ≤ 0,5 s
Remarks The answer will be sent with the old setting. Then the setting will be changed.

Function Read date

Command DTD
Function Set date
Command DTD;yyyy;mm;dd
Answer DTD;yyyy;mm;dd
Parameter yyyy year (1990 … 2069)
mm month (1 … 12)
dd day (1 … 31)
Possible E;03, E;08
error messages
Timeout ≤ 0,5 s

Function Read time

Command DTT
Function Set time
Command DTT;hh;mm;ss
Answer DTT;hh;mm;ss
Parameter hh hours (0 … 23)
mm minutes (0 … 59)
ss seconds (0 … 59)
Possible E;03, E;08
error messages
Timeout ≤ 0,5 s

10 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

4.3 Status Request and Diagnosis

Function Read measurement status
Command S
Answer S;xxx
Parameter xxx RES : Reset
STA : dose/charge measurement in progress
HLD : dose/charge or integration measurement in Hold status
INT : integration measurement in progress
NUL : zeroing in progress
ERR : error status
AUT : autostart mode
WAI : WAIT mode
INI : device will be initialized
Timeout ≤ 0,5 s

Function Read error status

Command SE
Answer SE;x;y
Parameter X error status of the measuring unit
0 : no error
1 : an error has occurred
y error status of the power supply
0 : no error
1 : an error has occurred
Timeout ≤ 0,5 s

Function Read status of power supply

Command SPS
Answer SPS;a;b;c;d;e;f
Parameter a 0 : no Standby
1 : Standby mode
b 0 : mains operation
1 : battery operation
c battery warning
0 : no warning
1 : LowBat, rechargeable batteries almost discharged
2 : Shutdown threshold reached
d status of the battery charging
0 : no rechargeable batteries
1 : fast charging
2 : trickle charge
3 : rechargeable batteries completely charged
e battery capacity (0 … 100) in [%]
f battery voltage in [mV]
Timeout ≤ 0,5 s

D776.131.01/02 11
 UNIDOSwebline Interfaces
Commands by Functions

Function Recalculate the measured value multiplicators

Command NEW
Answer NEW
Possible E;03
error messages
Timeout 1s
Post delay 5 s
Remarks This command initializes a recalculation of all parameters for measuring value determina-
tion (e.g. resolution).
It sets the Trip Output interface contacts to their power-on position.
It is mainly intended to cancel error states.

12 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

4.4 Measurement and Control Commands

Function Start zeroing
Command NUL
Answer NUL
Possible E;02, E;03, E;11
error messages
Timeout 2s
Remarks Equivalent to pressing the ZERO device control key
The answer is sent immediately. Read the end of zeroing and the result of zeroing by
means of a NUS command.

Function Read state of zeroing

Command NUS
Answer NUS;aa;bbbb;cc
Parameters aa 0: zeroing successful
1 to 15: zeroing not successful
bbbb 0: zeroing aborted
1 to 4095: zeroing is in progress or zeroing finished
cc remaining time for zeroing (0 … 74)
If a remaining time of 0 is transferred, zeroing is finished.
Timeout ≤ 0,5 s
Remarks If the zeroing was successful the answer has to be NUS;0;bbbb;0.

Function Read measuring range

Command RGE
Function Change measuring range
Command RGE;x
Answer RGE;x
Parameters x 0 : Low
1 : Medium
2 : High
Possible E;03
error messages
Timeout 3s

D776.131.01/02 13
 UNIDOSwebline Interfaces
Commands by Functions

Function Read measuring mode (radiological or electrical)

Command URE
Function Set radiological or electrical measuring mode
Command URE;x
Answer URE;x
Parameters x 0 : electrical
1 : radiological
Possible E;03
error messages
Timeout 2s

Function Read high voltage

Command HV
Function Set high voltage
Command HV;xxxx
Answer HV;xxxx
Parameters xxxx high voltage in volts (-400 … +400); in the case of positive values the
+ sign needs not to be entered
Possible E;03, E;08
error messages
Timeout 15 s
Remarks The answer is sent immediately before the high voltage is adjusted to the desired value.

Function Read integration time for integration measurement

Command IT
Function Set integration time for integration measurement
Command IT;xxxx
Answer IT;xxxx
Parameters xxxx integration time in seconds (1 … 60 … 9999)
Possible E;03
error messages
Timeout 3s

Function Start a dose or charge measurement

Command STA
Answer STA
Possible E;02, E;03
error messages
Timeout 2s
Remarks Equivalent to pressing the MEAS device control key

14 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

Function Start an integration measurement

Command INT
Answer INT
Possible E;02, E;03
error messages
Timeout 2s
Remarks Equivalent to pressing the INTEG device control key

Function Set the measurement to Hold-mode

Command HLD
Answer HLD
Possible E;02, E;03
error messages
Timeout 2s
Remarks Equivalent to pressing the HOLD device control key

Function End a dose or charge measurement and reset the measured values
Command RES
Answer RES
Possible E;02, E;03
error messages
Timeout 2s
Remarks Equivalent to pressing the RESET device control key

D776.131.01/02 15
 UNIDOSwebline Interfaces
Commands by Functions

Function Read measured values

Command MV
Answer MV;a;bb;cc.c;±d.dddE±ee;f;g;±h.hhhE±ii;k;±llllE±mm;nnnnn
Parameters a measuring status:
0 : reset
1 : dose or charge measurement in progress
2 : dose or charge measurement in Hold mode
3 : integration measurement in progress
4 : integration measurement in Hold mode (integration time elapsed)
5 : zeroing in progress
6 : error status
7 : autostart mode
8 : WAIT mode
bb is a two-digit decimal number. This is what the individual bits signify, if set
(error flag):
Bit .0 = dose rate or current is in OVERLOAD
Bit .1 = dose or charge has been in OVERLOAD since start of
measurement or is still in OVERLOAD
Bit .2 = HV ERROR occurs at dose rate or current measurement
Bit .3 = during dose or charge measurement a HV ERROR has occurred
or is still existent
Bit .0 is the least significant bit.
cc.c measuring time in seconds with one to seven digits before the decimal
point and one digit after the decimal point
±d.dddE±ee measured value of dose or charge
±h.hhhE±ii measured value of dose rate or current
±llllE±mm mean value of dose rate or current since start of measurement
Measured values are shown in scientific notation. The mantissa field con-
sists always of six characters. The numbers of digits of the mantissa vary
depending on the measured value; spaces will be inserted to the left, if
necessary. If the mantissa is positive a space is transferred instead of the
+ sign. The exponent is always sent as two digit number with leading
zeros, if necessary. The algebraic sign of the exponent is always trans-
ferred.
f 0 : resolution ≥ 0,5 %, measured value of dose or charge is not marked
with message LOW SIGNAL
1 : resolution ≤ 0,5 %, measured value of dose or charge is marked with
message LOW SIGNAL
g 0 : measured value of dose or charge is not marked with message LOW
AUTO SIG
1 : measured value of dose or charge is marked with message LOW
AUTO SIG
k 0 : resolution ≥ 0,5 %, measured value of dose rate or current is not
marked with message LOW SIGNAL
1 : resolution ≤ 0,5 %, measured value of dose rate or current is marked
with message LOW SIGNAL
nnnnn CRC check sum (refer to section 4.1.1)
Timeout ≤ 0,5 s

16 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

Function Read upper limit of measuring range

Command MVM or MVM;a
Answer MVM;a;b.bbbE±cc
Parameters a 0 : Low
1 : Medium
2 : High
If the measuring range is not prompted in command, upper limit of the
adjusted measuring range in transferred in answer.
b.bbbE±cc upper limit of measuring range
The upper limit of measuring range is formatted in scientific notation.
Timeout ≤ 0,5 s

Function Read display resolution

Command MVR or MVR;a
Answer MVR;a;±b.bbbE±cc;±d.dddE±ee
Parameters a 0 : Low
1 : Medium
2 : High
If the measuring range is not prompted in command, the display resolu-
tion of the adjusted measuring range in transferred in answer.
display resolution of dose or charge, for further details see measuring
±b.bbbE±cc value at MV command.
display resolution of dose rate or current, for further details see measur-
±d.dddE±ee ing value at MV command.
Timeout ≤ 0,5 s

D776.131.01/02 17
 UNIDOSwebline Interfaces
Commands by Functions

4.5 Data Base Commands for Detectors

NOTE
All parameters of a detector are condensed in a
list. To access a parameter a number is used.
List of parameters see section 4.5.1.

NOTE
Changing parameters can either be done in the
data record of the active detector or in a so-
called data record work space.
The active detector is selected with the DBC
command.
With the DBL command a data record is loaded
to the data record work space. Changes on the
data record work space have to be saved in the
data base with the DBS command.

NOTE
Detector data records can only be deleted di-
rectly at the device but not via an interface.

Function Select a detector data record as active detector

Command DBC;x;y
Answer DBC;x;y
Parameter x number of the detector data record
y 0: abort, if the new high voltage is higher than the actually set high
voltage
1: skip the warning, that the new high voltage is higher than the actually
set high voltage
Possible E;08, E;19, E;21, E;22, E;23, E;25
error messages
Timeout ≤ 0,5 s
Remarks The data record will be loaded and the new values will be set.
The UNIDOSwebline is in WAIT mode until the new high voltage is adjusted. During this time
the S command will be answered with S;WAI.

18 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

Function Read the value of a parameter of the active detector

Command DAV;p
Function Set the value of a parameter of the active detector
Command DAV;p;y
Answer DAV;p;y;zzzzz
Parameter p index of the parameter, refer to list in section 4.5.1
y value of the parameter
zzzzz CRC check sum (refer to section 4.1.1)
Timeout ≤ 0,5 s
Remarks The value of a text parameter can be removed by sending an empty parameter (i.e.
DAV;p;).

Function Load a detector data record from the data base to the data record work space
Command DBL;x
Answer DBL;x
Parameter x number of the detector data record
Possible E;08, E;19, E;21
error messages
Timeout ≤ 0,5 s

Function Read the value of a parameter of the data record work space
Command DBV;p
Function Set the value of a parameter of the data record work space
Command DBV;p;y
Answer DBV;p;y;zzzzz
Parameter p index of the parameter, refer to list in section 4.5.1
y value of the parameter
zzzzz CRC check sum (refer to section 4.1.1)
Possible E;07, E;08, E;19
error messages
Timeout ≤ 0,5 s
Remarks The value of a text parameter can be removed by sending an empty parameter (i.e.
DBV;p;).

Function Save the data record work space in a detector data record of the data base
Command DBS;x
Answer DBS;x
Parameter x number of the detector data record
Possible E;08, E;19, E;24
error messages
Timeout ≤ 0,5 s

D776.131.01/02 19
 UNIDOSwebline Interfaces
Commands by Functions

4.5.1 List of Parameters for the Detector Data records

Index Name of the Description of the Type of the Possible values

parameter parameter parameter
0 Record No number of data record integer value 0 … 51
read only
1 Identifier identifier of the detector, text 31 characters max.
e.g. "Farmer Chamber"
2 S/N serial number of the detec- text 11 characters max.
tor; e.g. "00012"
3 Type number type number of the detec- text 15 characters max.
tor; e.g. "T10021"
4 Detector type detector type selection 0 : vented ion chamber
1 : sealed ionization chamber
2 : liquid ion chamber
3 : semiconductor detector
4 : diamond detector
5 Quantity measuring quantity selection 0 : Absorbed dose to water DW
1 : Air kerma KA
2 : Exposure JS
3 : Photon equivalent dose Hx
4 : Ambient equivalent dose H*(10)
5 : Activity A
6 : Air kerma strength KA
7 : Dose length product DLP
8 : Dose area product DAP
6 Unit radiological unit selection 0 : Gy
1:R
2 : Sv
3 : Bq
4 : Ci
5 : Gy·m
6 : R·m
7 : Gy·m²
8 : R·m²
7 Time display time unit for dose rate indi- selection 0 : 1/s,
cation 1 : 1/min
2 : 1/h
8 Safe Calibration Safe Calibration selection 0 : not officially calibrated
read only 1 : officially calibrated
9 CalQuality radiation quality to which text 20 characters max.
the calibration factor refers
10 Calibration factor calibration factor decimal value 1.0 … < 1.000E13
11 CalTemperature calibration temperature selection 0 : 20°C
1 : 22°C
12 CalDate calibration date date yyyy-mm-dd hh:mm:ss
time setting optionally
13 Next calibration date for next calibration date yyyy-mm-dd hh:mm:ss
time setting optionally

20 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

Index Name of the Description of the Type of the Possible values

parameter parameter parameter
14 CalLaboratory calibration laboratory text 20 characters max.
15 Identifier identifier of the check de- text 20 characters max.
vice
16 Isotope Isotope selection 0 : no check device
1 : 14C
2 : 137Cs
3 : 90Sr
4 : user-defined
17 Half-life period half-life period decimal value 0.0 … 1.000E5
18 S/N of check source serial number of the source text 9 characters max.
19 S/N of adapter serial number of the text 9 characters max.
adapter
20 kp0 check reading kp,0 decimal value 0.0 … 1.000E15
21 CheckDate check date date yyyy-mm-dd hh:mm:ss
time setting optionally
22 Operation voltage operation voltage integer value -400 … 400
23 HV max maximum high voltage integer value 0 … 400
HVmax
24 HV min minimum high voltage integer value 0 … 400
HVmin
25 HV polarity polarity of the high voltage selection 0 : only positive
1 : only negative
2 : positive and negative
26 HV source high voltage source nor- selection 0 : internal high voltage source
mally used for the detector 1 : external high voltage source
27 Correction correction mode selection For vented chambers:
0 : off
1 : T&P
2 : kp/km
3 : correction factor
For all other detectors:
0 : off
1 : kp/km
2 : correction factor
28 CorrDate date of last correction date yyyy-mm-dd hh:mm:ss
time setting optionally
29 CorrFactor correction factor decimal value
read only
30 kTP correction factor kTP decimal value
read only
31 kp/km correction factor kp/km decimal value
read only
32 kp measured value kp decimal value
read only
33 km measured value km decimal value
read only

D776.131.01/02 21
 UNIDOSwebline Interfaces
Commands by Functions

Index Name of the Description of the Type of the Possible values

parameter parameter parameter
34 kQ correction factor for radia- decimal value 0.1 … 10.0
tion quality kQ
35 kPol correction factor for polarity decimal value 0.1 … 10.0
effect kPol
36 kS correction factor for ion decimal value 0.1 … 10.0
recombination kS
37 k user-defined correction decimal value 0.1 … 10.0
factor k
38 Bargraph scale final scale value of the bar decimal value 0.0 … 1.000E20
graph
39 Lower limit lower limit for detector test decimal value 0.0 … 9.999E12
result
40 Upper limit upper limit for detector test decimal value 0.0 … 9.999E12
result
41 Last test date and time of last detec- date yyyy-mm-dd hh:mm:ss
tor test
read only
42 Test result test result of last detector decimal value -9.999E-18 … 9.999E12
test
read only
43 Test range measuring range in which selection 0 : Low
the detector test is exe- 1 : Medium
cuted 2 : High
read only

22 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

4.6 Data Base Commands for User Settings

NOTE
All user settings parameters are condensed in a
list. To access a parameter a number is used.
List of parameters see section 4.6.1.

CAUTION
Unauthorized modifications of the settings.
Malfunction! Erroneous Measurements!
Only the parameters with the indices listed below
may be changed.
The parameters with the indices 7, 8, 30 - 32, 36,
43, 44, 50-53 and 55 are reserved for PTW.
Changing any of these parameters may cause
system malfunction and erroneous measure-
ments.

Function Read the value of a user settings parameter

Command DUV;p
Function Set the value of a user settings parameter
Command DUV;p;y
Answer DUV;p;y;zzzzz
Parameter p index of the parameter, refer to list in section 4.5.1
y value of the parameter
zzzzz CRC check sum (refer to section 4.1.1)
Timeout ≤ 0,5 s
Remarks The value of the parameter can be removed by sending an empty parameter (i.e. DUV;p;).

D776.131.01/02 23
 UNIDOSwebline Interfaces
Commands by Functions

4.6.1 List of Parameters of the User Settings

Index Name of the Description of the Type of the Possible values

parameter parameter parameter
0 User user selection 0 : normal user
read only 1 : expert
2 : administrator
1 Detector ID Record number of selected integer value 0 … 51
detector
read only
2 Language language selection 0 : English
1 : German
2 : French
3 : Spanish
4 : Portuguese
3 RS232 baudrate baud rate selection 0 : 1200
1 : 2400
2 : 4800
3 : 9600
4 : 14400
5 : 19200
6 : 38400
7 : 57600
8 : 115000
4 RS232 handshake handshake selection 0 : handshake switched off
1 : handshake switched on
5 Measuring quantity indication of measured selection 0 : dose/charge
value in measuring window 1 : dose rate/current
in the measuring quantities 2 : dose & dose rate/
charge & current
6 Bargraph indication of dose rate or selection 0 : disabled
current in the form of a bar 1 : enabled
graph
9 HV set high voltage integer value -400 … 400
10 Units indication of the measured selection 0 : electrical
values in radiological or 1 : radiological
electrical units
11 Range measuring range selection 0 : Low
1 : Medium
2 : High
12 Temp. temperature for air density decimal value 10.0 … 20.0 … 40.0
correction T&P in [°C]
13 Air pressure air pressure for air density decimal value 600.0 … 1013.2… 1200.0
correction T&P in [hPa]
14 TCP/IP TCP/IP interface selection 0 : disabled
1 : enabled
15 IP address IP address, i.e. device IP address format xxx.xxx.xxx.xxx
address in the intranet e.g.: 192.168.2.50
16 IP mask Subnet mask IP address format xxx.xxx.xxx.xxx
e.g.: 255.255.255.0

24 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

Index Name of the Description of the Type of the Possible values

parameter parameter parameter
17 Gateway IP address for the standard IP address format xxx.xxx.xxx.xxx
gateway e.g.: 192.168.2.1
18 POP3 server IP address of POP3 server IP address format xxx.xxx.xxx.xxx
19 SMTP server IP address of SMTP server IP address format xxx.xxx.xxx.xxx
20 E-mail check check of the e-mail mailbox selection 0 : disabled
1 : enabled
21 E-mail address e-mail address of the de- text 99 characters max.
vice
22 E-mail user name e-mail user name for POP3 text 99 characters max.
mailbox
23 E-mail password e-mail password for POP3 text 15 characters max.
mailbox
24 E-mail check period e-mail check period in [min] integer value 0 … 10 … 120
25 UDP commands UDP commands selection 0 : disabled
1 : enabled
26 VNC server VNC server, i.e. remote selection 0 : disabled
access via VNC software 1 : enabled
27 Integration time integration time in [sec] integer value 1 … 60 … 9999
28 Corrections corrections selection 0 : disabled
1 : air density correction T&P
2 : air density correction kP/km
3 : correction factor
29 CorrDate date of last correction date yyyy-mm-dd hh:mm:ss
read only
33 KeyboardEnable keyboard lock selection 0 : keyboard locked
1 : keyboard unlocked
34 AutoStart disable Autostart or select selection 0 : disabled
Autostart mode 1 : Autostart without AutoReset
2 : Autostart with AutoReset
35 AutoStart sensitivity sensitivity of the Autostart selection 0 : high
mode 1 : medium
2 : low
37 Alarm monitoring alarm monitoring, i.e. send- selection 0 : disabled
ing of alarm e-mails 1 : enabled
38 Dose threshold dose measurement thresh- decimal value 0.0 … 1.000E2
old for alarm monitoring
39 Doserate threshold dose rate measurement decimal value 0.0 … 1.000E2
threshold for alarm moni-
toring
40 Alarm e-mail address e-mail address, to which IP address 99 characters max.
automatic alarm e-mails
are being sent

D776.131.01/02 25
 UNIDOSwebline Interfaces
Commands by Functions

Index Name of the Description of the Type of the Possible values

parameter parameter parameter
41 Brightness brightness for battery op- integer value 1 … 50 … 100
(battery operation) eration
42 Brightness brightness for mains opera- integer value 1 … 50 … 100
(mains operation) tion
45 Device name device name text 31 characters max.
46 TRIP interface trip output interface selection 0 : disabled
1 : enabled
47 TRIP dose dose measurement thresh- decimal value 1.000E-13 … 1.000E10
old to switch the trip output
interface
48 Last test date and time of last device date yyyy-mm-dd hh:mm:ss
test
read only
49 Test result Test result of last device decimal value -9.999E-18 … 9.999E12
test
read only
54 Last Zeroing date and time of las suc- date yyyy-mm-dd hh:mm:ss
cessful zeroing
read only
56 Test range measuring range in which selection 0 : Low
the device test is executed 1 : Medium
read only 2 : High
57 Statistics_Mode statistics mode integer value 0 : disabled
1 . manual
2 : signal-controlled
3 : time-controlled
58 Statistics_TCM_Time measuring time for time- integer value 1 … 9999
controlled statistics in [sec]
59 Statistics_TCM_Pause time for measuring pause integer value 1 … 9999
for time-controlled statistics
in [sec]
60 Statistics_ItemsMax number of statistics entries integer value 0 … 100

26 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

4.7 Statistics Commands

Function Read a statistics parameter
Command SPA;x
Function Set a statistics parameter
Command SPA;x;y
Answer SPA;x;y
Parameter x 0 : mode
1 : measuring time for time-controlled statistics
2 : time for measuring pause for time-controlled statistics
3 : number of statistics entries for signal- and time-controlled statistics
y x=0 mode
0 : disabled
1 . manual
2 : signal-controlled
3 : time-controlled
x=1 measuring time (1 … 9999) in [s]
x=2 time for measuring pause (1 … 9999) in [s]
x=3 number of statistics entries (0 … 100)
Possible E;03, E;08, E;19
error messages
Timeout with x = 0
3s
post delay 10 s (refer to remarks)
with x = 1 … 3
3s
no post delay
Remarks If the Autostart mode is activated by this command, long WAIT periods can occur.
Therefore you have to consider the post delay or check the measurement status with the
S command. During a WAIT period the S command will be answered with S;WAI.

Function Add the displayed measured value to the statistics

Command STO
Answer STO
Possible E;03, E;08
error messages
Timeout 2s
Remarks This command is only allowed in the “manual” mode (refer to SPA command). If the maxi-
mum number of entries in the statistics list is reached, the device will answer with the error
message E;03.

D776.131.01/02 27
 UNIDOSwebline Interfaces
Commands by Functions

Function Read the status of the statistics measurement

Command SMC
Function Operate the statistics measurement
Command SMC;x
Answer SMC;x
Parameter x 0: read: statistics measurement disabled
operate: terminate series of measurements
1: read: series of measurements in progress
operate: start series of measurements
Possible E;03, E;08
error messages
Timeout 2s
Remarks The SMC;x command is only possible in the”signal-controlled” and “time-controlled” modes
(refer to SPA command), if the maximum number of entries in the statistics list is not
reached.

Function Delete an entry/all entries from the statistics list

Command SDC;x
Answer SDC;x
Parameter x 0 : all entries
a : number of the entry (1 to number of entries)
Possible E;03, E;08
error messages
Timeout 2s

28 D776.131.01/02
 UNIDOSwebline Interfaces
Commands by Functions

Function Read an entry of the statistics list

Command SDR;a
Answer SDR;0;b;-c.cccE+dd;e;-fff.ff%
or
SDR;a;-g.gggE+hh;e;iiii;yyyy-mm-dd;hh:mm:ss;jjj;k;ll
Parameter a 0 : read the summing up data
a : number of the entry (1 to number of entries)
b number of entries
-c.cccE+dd mean value of measured values
e unit
-fff.ff% relative standard deviation
-g.gggE+hh measured value
iiii measuring time in [ms]
yyyy-mm-dd date
hh:mm:ss time
jjj high voltage
k measuring status
ll is a two-digit decimal number. This is what the individual bits signify, if set
(error flag):
Bit .0 = dose rate or current is in OVERLOAD
Bit .1 = dose or charge has been in OVERLOAD since start of
measurement or is still in OVERLOAD
Bit .2 = HV ERROR occurs at dose rate or current measurement
Bit .3 = during dose or charge measurement a HV ERROR has occurred
or is still existent
Bit .4 = measured value of dose rate or current is marked with message
LOW SIGNAL
Bit .5 = measured value of dose or charge is marked with message
LOW SIGNAL
Bit .6 = measured value of dose or charge is marked with message
LOW AUTO SIG
Bit .0 is the least significant bit.
Possible E;03, E;08
error messages
Timeout 2s
Remarks For further information on measured values, measuring status and error flag please refer to
MV command.
The unit can be empty, if the statistics contain entries with different units.
The relative standard deviation can be empty, if the statistics contains no entries or only
one entry.
If the statistics do not contrain entries the SDR;0 command will be answered with
SDR;0;--.--;;--,--%

D776.131.01/02 29
 UNIDOSwebline Interfaces
Commands by Functions

Function Read the whole contents of the statistics list

Command SDR
Answer SDR;x;y
Parameter x 0 : summing up data
a : number of the entry (1 to number of entries)
y Refer to SDR;x command
Timeout 2s
Remarks Several rows (each ending with CR LF) will be sent. The summing up data will always be
sent. For each entry a one row will be sent.

30 D776.131.01/02
 UNIDOSwebline Interfaces
Alphabetical Command List

5 Alphabetical Command List

Com- Description Page Com- Description Page

mand mand
BR Read/Set baud rate 9 NUL Start zeroing 13
DAV Read/Set the value of a parameter 19 NUS Read zeroing status 13
of the active detector PTW Read device identification and 9
DBC Select a detector data record as 18 firmware version
active detector RES End a dose or charge measure- 15
DBL Load a detector data record from 19 ment and reset the measured val-
the data base to the data record ues
work space RGE Read/Change measuring range 13
DBS Save the data record work space in 19 S Read measurement status 11
a detector data record of the data
base SDC Delete an entry/all entries from the 28
statistics list
DBV Read/Set the value of a parameter 19
of the data record work space SDR Read the whole contents of the 30
statistics list
DTD Read/Set date 10
SDR;x Read an entry of the statistics list 29
DTT Read/Set time 10
SE Read error status 11
DUV Read/Set the value of a user set- 23
tings parameter SER Read serial number of the device 9

HLD Set the measurement to Hold 15 SMC Read the status of the statistics 28
mode measurement / operate the statis-
tics measurement
HS Read/Set handshake setting 10
SPA Read/Set a statistics parameter 27
HV Read/Set high voltage 14
SPS Read status of power supply 11
INT Start an integration measurement 15
STA Start a dose or charge measure- 14
IT Read/Set integration time 14 ment
KEY Read/Set keyboard lock 9 STO Add the displayed measured value 27
MV Read measured values 16 to the statistics
MVM Read upper limit of measuring 17 URE Read/Set radiological or electrical 14
range measuring mode
MVR Read display solution 17
NEW Recalculate the measured value 12
multiplicators

D776.131.01/02 31
 UNIDOSwebline Interfaces
Error Messages

6 Error Messages

Error Cause Remarks

Tele-
gram

E;01 Syntax error, unknown command or invalid Observe the tables indicated in section 4
parameter
E;02 Command not allowed in this context e.g. starting a measurement while zeroing is in progress
E;03 Command not allowed at the moment e.g. UNIDOSwebline is in setup menu
E;07 CRC error CRC check sum is faulty
E;08 Parameter is out of the correct range or the Observe the tables indicated in section 4
format of the parameter is wrong
E;11 Operating state dangerous: command e.g. increasing high voltage as a side effect, stabilization
would lead to a dangerous operation state time not expired, etc.
E;16 Command to long Observe the tables indicated in section 4
E;17 Maximum number of parameters exceeded Observe the tables indicated in section 4
E;19 Wrong number of parameters Observe the tables indicated in section 4
E;20 Setting cannot be changed No user rights or read only setting
E;21 Detector not found A detector with the requested data record number does
not exist.
E;22 DBL command: new detector was not set. The new high voltage will be higher than the actually set
high voltage.
E;23 General data base error
E;24 Memory error: data record could not be
saved
E;25 Warning: Change of high voltage source
(DBC command)

32 D776.131.01/02