The following are a list of the telnet commands available for use.
Command |
Description |
AUTH |
Authenticates a user |
GETCHANNELVALUE |
Gets the instantaneous value for a channel |
GETCLOCK |
Get the date and time from the system clock |
GETCONFIG |
Returns a list of currently logged reports and channels |
GETOPERATORLOGS |
Outputs operator logs for a specified period |
LISTDRIVERS |
Lists all available instrument drivers |
LISTINSTRUMENTS |
Lists all configured instruments |
LISTMODBUS |
Lists modbus channels on a report |
LISTPARAMETERS |
Lists all available parameters for an instrument |
LOGOUT |
Logs out and disconnects the telnet session. Alises for this command include LOGOFF, SIGNOFF, SIGNOUT, DISCONNECT, EXIT, QUIT and BYE |
PASSTHROUGH |
Initiates a direct connection to the instrument |
RELOAD |
Reloads the running instrument/parameter/channel/report configuration |
RESTART |
Reboots the computer |
SETCHANNELVALUE |
Sets the value for a channel |
SETCLOCK |
Set the system clock to a new date and time |
SETINSTRUMENTSTATE |
Sets the state of an instrument |
STATUS |
Displays a status page |
SYNCINSTRUMENTCLOCK |
Synchronise an instrument's clock with the system clock |
UNLOADBINARY |
Unloads logged data in binary format |
UNLOADTEXT |
Unloads logged data in text format |
AUTH
Authenticates a user
Usage: AUTH Username [Password]
Username |
User name |
|
Password |
Password - will be prompted if not specified |
Examples:
AUTH admin
AUTH admin pa$$word
Response on success:
Authentication successful
Response on error:
Error: Authentication failed
GETCHANNELVALUE
Gets the instantaneous value for a channel
Usage: GETCHANNELVALUE [ChannelID] [RollingFunction] [n]
ChannelID |
Channel ID, or '*' for all channels. |
|
RollingFunction |
Rolling Function (default function if not specified) |
|
n |
Function Parameter (if required) |
Examples:
GETCHANNELVALUE 10 NthPercentile 10
GETCHANNELVALUE * Count
GETCHANNELVALUE *
Available Rolling Functions:
Latest |
LogAvg |
Sum |
NthMin [n] |
VectorSum |
Delta |
Earliest |
StdDev |
MaxAbs |
NthMax [n] |
SigmaTheta |
Range |
Min |
Median |
MinAbs |
NthPercentile [n] |
Mode |
RMS |
Max |
GeometricMean |
Count |
Exceedences [n] |
NthEarliest [n] |
Log10Avg |
Avg |
GeometricStdDev |
CapturePercent |
VectorAvg |
NthLatest [n] |
DbAvg |
Response Format:
[Channel ID] [Value] [Status]
Example Response:
1 14.174179 128
2 26.523788 128
3 -0.51223243 128
4 -763.77866 128
5 -172.02027 128
GETCLOCK
Get the date and time from the system clock
Usage: GETCLOCK [UtcOffset]
UtcOffset |
UTC offset to represent return value in (default is system time zone). 'Z' denotes UTC. |
Examples:
GETCLOCK
GETCLOCK +10:00
GETCLOCK Z
Response Format:
yyyy-MM-ddTHH:mm:ss.fff+hh:mm
This response is the standard ISO8601 format
Example Response:
2020-05-13T10:56:01.974+10:00
If no UTC offset is specified in the request, the system local timezone will be assumed.
GETCONFIG
Returns a list of currently logged reports and channels
Usage: GETCONFIG
Response Format:
Report [Name]: [Label],[Interval],[BinaryUID]
The report name use used as an identifier when unloading data with the UNLOADTEXT command.
The binary UID is used as an identifier when unloading data with the UNLOADBINARY command.
The interval is the standard ISO8601 duration format.
Example Response:
Report 1: [5 Min],PT5M,0001
Channel C1: [Ambient Temp],[°C],,Avg,2,0000
Channel C2: [Relative Humidity],[%],,Avg,1,0001
Channel C3: [Dew Point],[°C],,Avg,1,0002
Channel C4: [CO],[ppb],[CO],Avg,1,0003
Channel C5: [SO2],[ppm],[SO₂],Avg,5,0004
Report 2: [1 min],PT1M,0002
Channel C1: [Ambient Temp],[°C],,Avg,2,0000
Channel C2: [Relative Humidity],[%],,Avg,1,0001
Channel C3: [Dew Point],[°C],,Avg,1,0002
Channel C4: [CO],[ppb],[CO],Avg,1,0003
Channel C5: [SO2],[ppm],[SO₂],Avg,5,0004
Report S1: [Cal 1],PT0S,8001
Channel C1: [Ambient Temp],[°C],,Avg,2,0000
Channel P1: [Ambient Temp (Precision)],[°C],,,2,0001
Report S1P1: [Cal 1 / Zero],PT0S,C001
Channel C1: [Ambient Temp],[°C],,Avg,2,0000
Channel P1: [Ambient Temp (Precision)],[°C],,,2,0001
GETOPERATORLOGS
Outputs operator logs for a specified period
Usage: GETOPERATORLOGS Start [End]
Start |
Start time in ISO-8601 notation, or '*' for first operator log entry |
|
End |
End time in ISO-8601 notation. Outputs all operator log entries after start date if not specified. |
Response Format:
Timestamp,[Username],[Message]
Example Response:
Timestamp,Username,Message;0;26;0A11
2020-07-22T11:28:23+10:00,[Admin],[This is a single-line operator log.];0;71;1561
2020-07-22T11:28:42+10:00,[Admin],[This log has\na new line in it.];0;67;138F
2020-07-22T11:29:50+10:00,[Admin],[This log entry has a backslash (\\), a newline\nand [text wrapped in boxes]].];0;113;2407
LISTDRIVERS
Lists all available instrument drivers
Usage: LISTDRIVERS
Response Format:
[Make] [Model] ([Protocol])
Example Response:
Ecotech 9400TP
Ecotech ACS1000 (Advanced)
Ecotech Aurora 1000 (Multi-Drop)
Ecotech Aurora 1000 (Remote Menu)
Ecotech Aurora 3000 (Multi-Drop)
Ecotech Aurora 3000 (Remote Menu)
Ecotech Aurora 4000 (Multi-Drop)
Ecotech Aurora 4000 (Remote Menu)
(... truncated)
LISTINSTRUMENTS
Lists all configured instruments
Usage: LISTINSTRUMENTS
Example Response:
ID State Description
1 Measure Ecotech Serinus 10 USB
2 Online Ecotech 9400TP
3 Online System Monitor
LISTMODBUS
Lists modbus channels on a report
Usage: LISTMODBUS [SlaveAddress]
SlaveAddress |
Slave Address. All slaves are returned if not specified. |
Example:
LISTMODBUS
LISTMODBUS 2
Response Format:
Slave [Slave Address]: [Label],[Interval]
[Type] [Data Address]: [Register],[Count],[Data Type],[Channel],[Label],[Unit]
Example Response:
Slave 1: [Modbus Slave],PT0S
Coil 20: 00021,1,Bit,C11,[Fan Switch],
Coil 22: 00023,1,Bit,C13,[Heater Switch],
Coil 48: 00049,1,Bit,C26,[Fan Switch],
Holding Register 0: 40001,2,Float,C1,[Ambient Temp],[°C]
Holding Register 2: 40003,2,Float,C2,[Relative Humidity],[%]
Holding Register 4: 40005,2,Float,C3,[Dew Point],[°C]
Input Register 0: 30001,1,UInt16,C1.Status,[Ambient Temp],
Input Register 2: 30003,1,UInt16,C2.Status,[Relative Humidity],
Input Register 4: 30005,1,UInt16,C3.Status,[Dew Point],
LISTPARAMETERS
Lists all available parameters for an instrument
Usage: LISTPARAMETERS [InstrumentID]
InstrumentID |
Instrument ID. Available instruments are listed if not specified. |
Example: LISTPARAMETERS 5
Response Format:
[Parameter ID]: [Label] ([unit])
Example Response:
UPTIME: Uptime (sec)
CPUUSAGE: CPU Usage (%)
DISKTIME: Disk Time (%)
MEMUSAGE: Memory Usage (MB)
FREESPACE_C: Free space on OS (C:\) (MB)
LOGOUT
Logs out and disconnects the telnet session.
Usage: LOGOUT
Aliases for this command include LOGOFF, SIGNOFF, SIGNOUT, DISCONNECT, EXIT, QUIT and BYE. This command does not return a response.
PASSTHROUGH
Initiates a direct connection to the instrument.
Usage: PASSTHROUGH [InstrumentID]
InstrumentID |
Instrument ID. Available instruments are listed if not specified. |
Example: PASSTHROUGH 5
Note: The instrument will suspend polling while a passthrough connection is active. Logging will resume when the telnet session is terminated. It is not advised to use this command when telnet is hosted on a serial port.
RELOAD
Reloads the running instrument/parameter/channel/report configuration
Usage: RELOAD
Response:
Reloading configuration...
Configuration reloaded successfully
A reload will momentarily suspend logging, halt web dashboards, and disconnect all instruments. Normal operation will resume upon completion.
RESTART
Reboots the computer
Usage: RESTART
This function requires authentication via the AUTH command. It also requires that Congrego is running under a user account with sufficient permissions to restart the computer.
SETCHANNELVALUE
Sets the value for a channel
Usage: SETCHANNELVALUE ChannelID Value
ChannelID |
Channel ID |
|
Value |
New Value |
Example:
SETCHANNELVALUE 10 3.14159
Example Response:
Channel 12 is now set to 3
This function will only succeed on instrument parameters with a direction of "output" or "bidrectional".
SETCLOCK
Set the system clock to a new date and time
Usage: SETCLOCK DateTime
DateTime |
New value to set the system clock to in ISO-8601 notation |
Examples:
SETCLOCK 2012-11-10T09:08:07
SETCLOCK 2012-11-10T09:08:07+10:00
SETCLOCK 2012-11-10T09:08:07.123Z
Example Response:
2020-05-13T12:21:18.734+10:00
The response will always have the same UTC offset as the request, regardless of system locale configuration.
SETINSTRUMENTSTATE
Sets the state of an instrument
Usage: SETINSTRUMENTSTATE InstrumentID [State]
InstrumentID |
Instrument ID |
|
State |
ID or label of the instrument state. Available instrument states are listed if not specified. |
Examples:
SETINSTRUMENTSTATE 3
SETINSTRUMENTSTATE 3 1
SETINSTRUMENTSTATE 3 Span
Example Response:
Instrument state is now 'Zero'
STATUS
Displays a status page
Usage: STATUS
Example Response:
Version: Congrego v4.0.8 build 7436 - Professional
Site Name: Congrego Logger #1
Host Name: CONGREGO1
Platform: Microsoft Windows 10.0.18362
Architecture: x64
Build Date: 2020-05-11
Time Zone: (UTC+10:00) Canberra, Melbourne, Sydney
Uptime: 1.02:04:36
Network Interface: Ethernet 2
Address: fe80::a906:9e97:56a2:1c3b%7
Address: 172.18.244.98
SYNCINSTRUMENTCLOCK
Synchronise an instrument's clock with the system clock
Before executing this command, clock synchronisation must first be configured in the instrument settings.
Usage: SYNCINSTRUMENTCLOCK InstrumentID
InstrumentID |
Instrument ID |
Example:
SYNCINSTRUMENTCLOCK 1
Example Response:
Instrument clock will be synchronised
UNLOADTEXT
Unloads logged data in text format
Usage: UNLOADTEXT Report Start [End]
Report |
Report ID, or '*' for all reports. |
|
Start |
Start time in ISO-8601 notation, or '*' for first logged record |
|
End |
End time in ISO-8601 notation. Unloads all data after start date if not specified. |
Examples:
UNLOADTEXT 4 2012-11-10 2012-11-11
UNLOADTEXT * *
Response Format:
CHANNELS,[Channel IDs ...];[Tamper Flag];[Length];[Checksum]
LABELS,[Channel Labels ...];[Tamper Flag];[Length];[Checksum]
UNITS,[Channel Units ...];[Tamper Flag];[Length];[Checksum]
yyyy-MM-ddTHH:mm:ss+hh:mm,[Value ...,Status ...];[Tamper Flag];[Length];[Checksum]
...
END UNLOAD;[Tamper Flag];[Length];[Checksum]
A line footer is appended to each line of the response:
The tamper flag is set if the data appears to have been modified since it was logged. This includes altering values, altering statuses or adding/removing channels from the report.
The length is the total number of characters before the footer.
The checksum is the sum of all characters before the footer (16-bit hexadecimal)
Example Response:
CHANNELS,C1,C2,C35,C36;0;22;053C
LABELS,[Ambient Temp],[Relative Humidity],[WS Vector],[WD Vector];0;65;16CD
UNITS,[°C],[%],[m/s],[°];0;24;07FA
2020-05-13T15:00:00+10:00,5,-9.3014147,129,-67.231537,129,7.1324481,128,187.61438,128;0;85;10BF
2020-05-13T15:01:00+10:00,5,-9.2854226,128,-67.137539,128,7.784608,128,208.03952,128;0;84;109F
2020-05-13T15:02:00+10:00,5,-9.2549349,128,-67.037242,128,8.2639631,128,226.25633,128;0;85;10CB
2020-05-13T15:03:00+10:00,5,-9.2363378,128,-66.950487,128,8.7240724,128,244.11821,128;0;85;10CC
2020-05-13T15:04:00+10:00,5,-9.2121537,128,-66.854751,128,9.2980454,128,261.10292,128;0;85;10C6
2020-05-13T15:05:00+10:00,5,-9.1878342,128,-66.748845,128,9.6783048,128,277.32169,128;0;85;10EB
2020-05-13T15:06:00+10:00,5,-9.1637267,128,-66.651919,128,10.081772,128,292.49634,128;0;85;10D5
2020-05-13T15:07:00+10:00,5,-9.1378875,128,-66.553602,128,10.416696,128,306.43658,128;0;85;10D6
2020-05-13T15:08:00+10:00,5,-9.1145159,128,-66.457494,128,10.939692,128,318.89309,128;0;85;10E2
END UNLOAD;0;10;02BA
HELP [Command] e.g. HELP AUTH |
