Information about all the variables, Instantaneous value of one or more variables, Instantaneous value of all variables – CIRCUTOR EDS-3G Series User Manual
Page 4: Test commands, Registration of a listener
EDS-3G
M98240601-03-13B
http://x.x.x.x/services/user/varInfo.xml?var=device.variable?
http://name_dhcp/services/user/varInfo.xml?var=device.variab
le?
4.3.3.2.- Information about all the variables
Request for detailed information about all the variables of the
device (if information is needed about more devices, link the
other requests below with id=device?):
dispositivo?
dispositivo?
…
-
id: variable name in device.variable format
-
title: brief description of the variable
-
hasValue: indicates if it is possible to request the
instantaneous value of the variable (True / False)
-
hasLogger: indicates if it is possible to request the log of
the variable (True / False)
-
sampleMode: type of variable and mode used to group
values
-
measureUnits: variable unit
-
unitsFactor: power of 10 indicating the multiplying factor in
the log file
-
decimals: decimals of the variable
4.3.4.- Instantaneous variable value
The user can request the instantaneous values of one or more
variables, and can even request the information about all
instantaneous values with a single request.
4.3.4.1.- Instantaneous value of one or more variables
Request for the instantaneous value one or more variables of
the device (if information is needed about more variables, link
the other requests below with var=device.variable?):
?
http://nombre_dhcp/services/user/
v
alues.xml?var=dispositivo.
variable?
4.3.4.2.- Instantaneous value of all variables
Request for instantaneous values of all the variables of the
device (if information is needed about more devices, link the
other requests below with id=device?):
http://x.x.x.x/services/user/values.xml?id=dispositivo?
http://nombre_dhcp/services/user/
v
alues.xml?id=dispositivo?
...
-
id: identifier of the variable
-
value: value of variable at the time of the request
4.3.5.- Historical data
Request for historical data log of an incremental variable.
Returns information on one or more variables between the
“begin” and “end” dates. Each variable for which information is
required must be included in the request as
?var=device.variable
When only the date is required, the format is DDMMYYYY;
When the date and time are required, the format is
DDMMYYYYHHMMSS. Both the date and the time must be
expressed in UTC (Universal Coordinated Time).
The grouping period can be defined by different criteria:
-
value in seconds (for example 900): value in seconds in
which the data is grouped
-
ALL the data is grouped into a single value
-
AUTO: grouping is automatic with predefined intervals
according to “begin” and “end”
-
FILE: data not grouped. returns the information as
registered in the database
-
if the period parameter does not appear in the request, it is
considered as value 0 and the data is not grouped
rds.xml?begin=010320110000
00?end=31032011000000?var=dispositivo.variable?period=9
00
cords.xml?begin=010320
11000000?end=31032011000000?var=dispositivo.variable?p
eriod=900
…
-
recordGroup: field identifying the XML as a response to
the variable record request
-
period: recording period; time between recordings
-
record: identifies each recording (dateTime: date and time
of the sample
-
field: standard recording value (for others consult PS
manual)
-
value: value of variable at the time of the request
4.3.6.- Historical events file
As this user manual describes, the PowerStudio / Scada
Editor makes it possible to configure events or alarms in the
EDS-3G device and record them in the internal memory.
With the following request, the user can request the historical
events file between the dates defined. Every event that is
requested with a historical events file is defined as
?id=name_event
When only the date is required, the format is DDMMYYYY;
When the date and time are required, the format is
DDMMYYYYHHMMSS. Both the date and the time must be
expressed in UTC (Universal Coordinated Time).
vents.xml?begin=0103201100000
0?end=31032011000000?id=nombre_suceso?
vents.xml?begin=0103201
1000000?end=31032011000000?id=nombre_suceso?
...
…
-
main: field identifying the XML as a request
-
recordGroup: field that groups all the recordings of an event
-
id: event identifier
-
record: identifies each record
-
date: event date and time
-
eventId: event identifier
-
annotation: event annotation
-
value: event value
ON: active event
OFF: inactive event
ACK: event acknowledged
4.3.7.- Device events
Returns the information about recorded events of one or more
devices between the dates “begin” y “end”. Each device for
which information is required must be included as ?id=device
cordsEve.xml?begin=010320110
00000?end=31032011000000?id=dispositivo?
cordsEve.xml?begin=010
32011000000?end=31032011000000?id=dispositivo?
Cuando se desee indicar solamente la fecha, el formato es
DDMMAAAA; cuando quiere especificarse la fecha y hora es
DDMMAAAAHHMMSS. Tanto la fecha como la hora, debe
estar expresado en UTC (Universal Coordinated Time).
…
...
…
-
main: field identifying the XML as a request
-
recordGroup: field that groups all the recordings of an event.
-
device: device the records make reference to
-
record: identifies each recording
-
dateTime: event date and time
-
field: identifies each field
-
id: Identifier
-
value: event value
4.3.8.- Active Events
EDS-3G has an XML active events service whose aim is to
enable an external agent or integration system to be
registered as a listener and record the events or alarms that
occur in the device.
The device keeps a distribution list of active users, to which it
sends events that take place locally via the creation of
incidents.
4.3.8.1.- Test commands
Before initiating implementation of the active events system,
there are a number of PUT type test requests between the
listener and the producer (remote engine) and vice versa, the
aim of which is to test and ensure connectivity between both
systems.
The listener can send the request with the following message
body to check connectivity with the remote search engine
(producer):
ip_listener
-
ip_listener defines the listener's IP, to which the producer
sends the response request
-
port: defines the listener's port, to which the producer
sends the response request
When the producer (remote search engine) receives the test
request from the listener, it returns the following request:
http://ip_listener:port/services/user/testProducer.xml
request to which the listener must reply with "received" (200).
4.3.8.2.- Registration of a listener
Any agent or listener who wants to register in a remote search
engine or producer, so as to receive the incidents recorded by
the search engine in real time, must make the following PUT
request to the producer with this format:
http://ip_producer:port/services/user/listener.xml
This request must contain the following body in the message,
in which the listener and the type of data to be received are
defined:
ip_listener
-
ip_listener the listener's IP is defined, to which the
producer sends the events that are generated
-
port: defines the listener's port, to which the producer
sends the events that are created
The all section defines the type of information that is to be
accessed (True / False).
-
True:) indicates to the producer that all the active events
list available must be sent
-
False:) indicates to the producer that only the events that
took place since the last request must be sent