Datalogger ESC8816 communication protocol
Supported device types and versions
Communication line configuration
Communication station configuration
I/O tag configuration
Literature
Changes and modifications
Document revisions
| Kotva | ||||
|---|---|---|---|---|
|
...
Implementation was performed and verified according to the ESC Model 8816 – Data Logger Engineering Manual – TIN 96-1169, August 1996 for the datalogger software version 5.02.
Starting with D2000 version 10.0.37, the communication with DLX1 datalogger DLX1 is supported. For this device, communication on a TCP/IP-TCP line was also implemented.
Protocol The protocol is also compatible also with a datalogger EDL 15 datalogger produced by ECM Monitory for which addressing of channels above 99 is supported.
Communication includes:
...
| Measurement type | I/O tag type | Communication function | Documentation |
|---|---|---|---|
| Current values | AI | Poll Most Recent Instantaneous Reading | Appendix A – A54 |
| Current value flags | DI | Poll Most Recent Instantaneous Reading | Appendix A – A54 |
| 1m averages with flags | AI, DI | Retrieve Averages | Appendix A – A24 |
| 15m averages with flags | AI, DI | Retrieve Averages | Appendix A – A24 |
| 30m averages with flags | AI, DI | Retrieve Averages | Appendix A – A24 |
| 60m averages with flags | AI, DI | Retrieve Averages | Appendix A – A24 |
| Custom-period averages with flags | AI, DI | Retrieve Averages | Appendix A – A24 |
| Digital inputs | DI | Poll Current Digital Input Status | Appendix A – A19 |
| Calibrations | AI | Poll Calibration Results | Appendix A – A22 |
| Real-time – read | TOA | Poll Current Time | Appendix A – A56 |
| Real-time – write | TOA | Download Current Time | Appendix A – A40 |
| Mathematic constants – write | AO | Download Math Pack Constants | Appendix A – A45 |
| Relay outputs – write | DOUT | Switch Digital Output Control Relay On/Off | Appendix A – A64 |
...
- Communication line category: Serial, SerialOverUDP Device Redundant, RFC2217 Client, TCP/IP-TCP (for DLX1).
- Baud rate according to the ESC 8816 datalogger settings - System Configuration Screen – Baud Rate – Port 1, Baud Rate – Port 2, or Baud Rate – Port 3 according to the used datalogger port, 1 stop bit, 8 data bits, no parity.
Line protocol parameters
There can be defined the The following line protocol parameters can be defined:
Table 2
| Keyword | Full name | Meaning | Unit | Default value | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Passive Mode | Enables the passive mode (listening) of the line. Definition of the parameter PM It is enough to define the PM parameter for one station on the a line is enough. In the passive mode, there is monitored the communication between datalogger ESC 8816 datalogger and other device devices is monitored (datalogger's responses to the master are monitored). Listening allows to get getting the following types of values:
If the passive mode has been enabled (PM=True), to disable it you must either set the parameter PM=False or restart the process the D2000 KOM process (i.e. deleting the parameter PM=True is not sufficient). | - | - | ||||||
| Passive Mode Timeout | Timeout after expiration of which all stations changes change their states to the error state , if the line is in the passive mode (see the Passive Mode parameter PM). If no data are is received within the timeout, all the stations on the a line will changes change their states to the error state. | sec | 10 | ||||||
| Debug Calibration | Extended debug information for calibration data reading. | - | False | ||||||
| Acknowledge Calibration Data | Acknowledgement Acknowledgment of calibration data will be sent to the datalogger. If acknowledgement the acknowledgment is not sent, the datalogger will repeatedly send all available calibration data. | - | True |
...
- Communication protocol: ESC 8816.
- Station The station address is a decimal number within the range of 0..255. Station address must be identical with the datalogger setting "System Configuration Screen" – "Logger ID Code".
- Line The line mode number must correspond to a correctly configured mode.
...
Station configuration is different from implementation in the versions D2000 v3.XX. There are used The station time parameters (polling parameters) and polling priority are used, one datalogger must be divided into logical stations as follows:
- Current values - the delay - at at least 1 second, station priority - 0. Current measurements of channels and digital inputs are configured on the at this station. Logical This is a logical station with the lowest priority, the parameters delay parameter may not be less than 1 second.
- 1m averages – - the period - 1 1 minute, the offset 5..10 seconds, station priority - 1. There are configured 1m One-minute averages of channel measurement on the measurements are configured at this station. Logical This is a logical station with a higher priority, the parameter offset couldnshouldn't be less than 5 seconds - this is the time provided for the datalogger for processing values.
- 30m averages – period - 30 minutes, offset - 5- the period 30 minute, the offset 5..10 seconds, station priority - 2. There are configured 30m 2. Thirty-minute averages of channel measurements are configured on the this station. Logical This is a logical station with even higher priority, the parameter offset couldnshouldn't be less than 5 seconds - this is the time provided for the datalogger for processing values.
- Calibrations – stations station with a required period for reading calibration results.
- For other than 1m and 30m averages (15m, 60m, or custom period averages) averages, there must be configured , it is necessary to configure the polling parameters according to adjusted the custom average.
Note: Time of values acquired from the communication is the time of the beginning of a given period. Division The division into individual stations is necessary to ensure data reading reliability in the required time and not to overload the communication, e.g. constant by a frequent acquisition of current values to blocking the prejudice acquisition of interval averages.
Station protocol parameters
There can be defined the The following station protocol parameters can be defined:
Table 3
| Keyword | Full name | Meaning | Unit | Default value | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Retry Count | Poll repetition count The number of request repeats in case of a communication error. | - | 2 | ||||||
| Retry Timeout | Delay between poll repetition The delay between individual request repeats in case of a communication error. | ms | 1000 ms. | ||||||
| Wait First Timeout | Delay The delay after transmitting the poll request before reading the response. | ms | 500 ms. | ||||||
| Wait Timeout | Delay The delay between response readings till until its finalization. | ms | 400 ms. | ||||||
| Max Wait Retry | Repetition count The number of repeats of response readings till until its finalization. | - | 8 | ||||||
| Get Stored Interval | Period, during which there are read The size of the period, for which the archive data from the datalogger are read without interruption. The period is givenspecified in minutes. If the value of the period is e.g. 60 minutes, so there are readall archive data from e.g. June 3rd 199605:00 to 06:00 are read, then data from 06:00 to 07:00, etc. LoadingThe reading of archive data within thefrom this period couldnshouldn't take more than one minute, because there could be lost someotherwise some of the current data, acquired among archive readings, could be lost. | min | 10 | ||||||
| Protocol Variant | Variant A variant of the protocol. Existing variants are:
| - | 0 - ESC8816 |
String A string containing the protocol parameters is being defined as follows:
Keyword=value;Keyword=value; ...
...
Example:
RC=1;RT=500;MWR=10;
If there is used a keyword with an invalid value is used in the initialization string, there will be used the corresponding default value according to the table 2 will be used.
| Kotva | ||||
|---|---|---|---|---|
|
...
Support of communication with ESC 8816 comprises acquisition or setting of the following values:
- reading of current values with flags,
- reading of 1m, 15m, 30m or , and 60m averages with flags,
- reading of custom period value averages with flags,
- reading of current states of digital inputs,
- reading of calibration results,
- reading the real-time,
- setting the real-time,
- setting mathematic constants,
- setting relay outputs.
...
I/O tag is AI type, measurement type is ACTUAL. Channel The channel number is defined as a decimal number within the range of 0..99.
| Kotva | ||||
|---|---|---|---|---|
|
...
Current value flags are DI type (Digital Input). Measurement The measurement type is ACT Flag.
Note: At defining the The No missing data <blank> flag , you can use be configured using the character _ (underline) for transparencyclarity.
Configuration of 1m, 15m, 30m
...
, and 60m averages
Averages are value values of AI type (Analog Input). Measurement type is 1m AV for 1m averages, 15m AV for 15m averages, 30m AV for 30m averages, and 60m AV“ for for 60m averages. Channel A channel number is a decimal number within the range of 0..99 (see the note about channel addressing).
Flag configuration of 1m, 15m, 30m
...
, and 60m averages
Flags of averages are values of DI type (Digital Input). Measurement type is 1mAV Flag for 1m averages, 15mAV Flag for 15m averages, 30mAV Flag for 30m averages, and 60mAV Flag for 60m averages. Channel A channel number is a decimal number within the range of 0..99 (see the note about channel addressing).
Note: At defining the The No missing data <blank> flag , you can use be configured using the character _ (underline) for transparencyclarity.
Configuration of custom period averages with flags
...
When you define Custom AV, there is enabled to define any a custom time period can be defined. The period must be within the range of 1..999 in the form : and the type must be "sec", "min", "hour", or "day". The CustomAV Flag flag do not require to define a period, they are corresponding to the AI value (average) setting for required channel (the value must be defined !).
...
Digital inputs are values of the DI type (Digital Input). Measurement The measurement type is Digital Input. The Digital input number is a decimal number within the range of 0...999.
...
Calibration results are values of the AI type (Analog Input). Measurement The measurement type is CALIB Ph1 for acquiring the value of Average During Zero value or CALIB Ph2 for acquiring the value of Average During Span1. Channel number is a decimal number within the range of 0...99 (see the note about channel addressing).
...
Note:
The value of Average During Span2 is also returned during reading - the value has always been -999 (invalid value) in specific application. If the value of the parameter is to be required in needed by any other application, the protocol needs to be extended.
Real-time I/O tag configuration
For each station (physically one ESC8816 datalogger ESC8816), there can be configured one I/O tag containing the real-time of the corresponding station can be configured. The I/O tag is necessary for real-time synchronization computer -> datalogger.
...
Mathematic constants are values of the AO type (Analog Output). Measurement The measurement type is MATH. Constant number is a decimal number within the range of 0...99.
Warning: Mathematic constants can't be read, so their current value is the value last written or unknown (after D2000 system restart).
Note: D2000 supports extended mathematic constants addressing syntax, which allows to address addressing mathematic constants 0-359, with mathematic constants 0-99 backward compatible with standard addressing.
...
Relay outputs are values of the DOUT type (Digital Output). Measurement The measurement type is Relay Output. Output The output number is a decimal number within the range of 0...999.
Warning: State (value) of relay outputs can't be read, so their current value is the value last written or unknown (after D2000 system restart). Reading values is allowed can be enabled by binding relay outputs with digital inputs and then to control by controling the state of the relay outputs using the digital inputs.
...
I/O tag flags (from A to P) are adjusted set according to the occurrence of datalogger flags for current values, 1m averages, and 30m averages as follows:
...
| I/O tag flag | Meaning | Datalogger flag |
|---|---|---|
| A | Invalid measurement | "<" or „C“, „B“, „M“, „P“ a „D“ |
| B | Transient operation | "F" |
| C | Calibration | "C" |
| D | Malfunction | "B" |
| E | Maintenance | "M" |
| F | Power cut | "P" |
| G | Inactive measurement | "D" |
| I | Layoff | "F" |
Acquisition of
...
archived (stored) values
The ESC 8816 datalogger executes a performs local archiving of measured variablesvalues. The values can be requested automatically on when a dispatcher system breakdown is detected or directly by the dispatcher (D2000 HI, D2000 EventHandler) to complete the D2000 dispatcher system archive.
The method described above allows to acquire acquiring calibration values, which are 30 day days old, 30m averages for the last 31 days, and 1m averages for the last 60 minutes.
...
- November 1998 - Datalogger software version 5.16
Modification – for 30m averages, there could be occurred both the flag "F" (layoff) and ">" (validity of average with missing measurements) can occur, this half-hour is always considered as invalid.
Modification - new flag "p" flag - layoff. Occurrence of the flag The "F" flag is set in cases of occurrence of the flag "p" flag for reverse backward compatibility. - August 2000 - implementation of relay outputs writing
- February 2003 - implementation of 15m/60m/Custom period averages
...
| Kotva | ||||
|---|---|---|---|---|
|
...
- Ver. 1.2 – February 8th, 2000 – Update of the versions 4.07 and 4.10.
- Ver. 1.3 – August 22nd, 2000 – controlling relay outputs added.
- Ver. 1.4 - February 7th, 2003 - custom-period averages added.
- Ver. 1.5 - 13. mar. March 13th, 2008 - Update of protocol parameters .
- Ver. 1.6 - 26. aug. August 26th, 2015 - Update of protocol parameters (protocol variant for DLX1 implemented).
- Ver. 1.7 - 30. apr. April 30th, 2018 - Enhancement of channel addressing and mathematic constants from 0-99 to 0-359.
...