The TR-100E is a digital temperature relay for monitoring up to four temperature zones. It provides relay protection, event and temperature logging, a web interface, Modbus TCP, and secure remote access through WireGuard VPN.
This operating manual is intended to familiarize the user with the device, operating principle, operating rules, and setup of the TR-100E temperature relay.
During operation and maintenance, the requirements of the following regulatory documents must be observed:
“Rules for Technical Operation of Consumer Electrical Installations”;
“Safety Rules for Operation of Consumer Electrical Installations”, “Occupational Safety in the Operation of Electrical Installations”.
Connection and maintenance of the product must be performed by qualified specialists who have studied this Operating Manual.
If the operating rules are observed, the product is safe to use.
The TR-100E digital temperature relay (hereinafter referred to as the TR-100E) is intended for measuring and monitoring the temperature of an object using four sensors connected in a two-wire or three-wire configuration.
The TR-100E displays the measured temperature values on the display, monitors sensor lines for open circuit and short circuit, generates control signals for “Trip”, “Alarm”, “Fault”, and “Fan”, maintains an event log (up to 2048 records) and temperature logging with a specified interval (up to 16384 records), and also provides a Web interface.
If necessary, the TR-100E can be connected to a higher-level system (SCADA) via the Modbus TCP protocol or Web API.
The TR-100E has a universal power supply: 24-250 V AC/DC.
Main features:
4 monitoring zones (3 windings, 1 core);
4 output relays 8 A, 250 VAC (Trip relay, Alarm relay, Fan relay, and Fault relay);
Monochrome LCD 128x64 dots;
LED status indication;
front-panel control buttons;
Real-time clock (RTC) with 7-day autonomous power backup;
Event log with 2048 records;
Temperature logger with 16384 records;
Ethernet port 10/100 Mbps;
NTP time synchronization;
built-in web server for remote access to data and settings;
Support for a wide range of temperature sensors: Pt100/Pt1000, Ni100/Ni1000, Cu100, Ptc1000/EKS111, KTY83, KTY84, PTC minika.
The TR-100E supports the following types of temperature sensors: Pt100/Pt1000, Ni100/Ni1000, Cu100, Ptc1000/EKS111, KTY83, KTY84, and PTC minika.
Pt100 / Pt1000 - platinum resistance temperature detectors with nominal resistance of 100 Ω and 1000 Ω at 0 °C respectively. The characteristic is described by the coefficient W₁₀₀=1.3850 (according to IEC 60751) or W₁₀₀=1.3910. Measurement range: from minus 40 to +240 °C. They are connected to channels 1-4 in a two-wire or three-wire configuration.
Ni100 / Ni1000 - nickel resistance temperature detectors with nominal resistance of 100 Ω and 1000 Ω at 0 °C (W₁₀₀=1.6178). Measurement range: from minus 40 to +180 °C. They are connected to channels 1-4 in a two-wire or three-wire configuration.
Cu100 - copper resistance temperature detectors with nominal resistance of 100 Ω at 0 °C (W₁₀₀=1.4274). Measurement range: from minus 40 to +200 °C. They are connected to channels 1-4 in a two-wire or three-wire configuration.
Ptc1000 / EKS111 - platinum resistance temperature detector with nominal resistance of 1000 Ω at 0 °C and an increased temperature coefficient (W₁₀₀=2.0805). Measurement range: from minus 40 to +100 °C. They are connected to channels 1-4 in a two-wire or three-wire configuration.
KTY83 - silicon resistance temperature detector with nominal resistance R₂₅=1000 Ω at 25 °C, models 110/120/150. Measurement range: from minus 40 to +175 °C. They are connected to channels 1-4 in a two-wire or three-wire configuration.
KTY84 - silicon resistance temperature detector with nominal resistance R₁₀₀=1000 Ω at 100 °C, models 130/150. Measurement range: from minus 40 to +200 °C. They are connected to channels 1-4 in a two-wire or three-wire configuration.
PTC minika - semiconductor posistors that sharply increase their electrical resistance when the nominal response temperature (NAT) is reached. Sensors are produced with various NAT values in the range from 60 to 180 °C in increments of 10 °C.
The TR-100E continuously measures temperature in 4 zones using the connected sensors (channels 1-4). Channels 1-3 are intended to monitor transformer winding temperature, and channel 4 is intended to monitor transformer core or ambient temperature.
Event logging and temperature logging are performed in the background without affecting the main operation of the TR-100E. The saved data is available for viewing on the display and can be exported to a file through the Web interface.
After power-up, the integrity check and firmware startup are performed, after which the TR-100E switches to the main screen, the primary information display mode during normal operation (Figure 3).
Figure 3 - TR-100E main screen
The main screen displays:
the current time and date or the TR-100E IP address on the Ethernet network (alternating);
temperature logger status indicator (on / off);
relay status: T (TRIP), A (ALARM), F (FAN) (on / off, display priority T > A > F);
fault indicator (FAULT);
indicator of new events in the event log;
current temperature values of channels CH1, CH2, CH3, CH4;
trend of channel temperature change (rising / falling / unchanged);
If a channel sensor is faulty (open circuit or short circuit), an error symbol is displayed instead of the temperature value: “OPEN” (open circuit) or “SHORT” (short circuit).
If the channel is configured for a PTC minika sensor and the temperature has not yet reached the NAT, the symbol ”< NAT” is displayed.
If a channel is disabled (parameter Channel N → Enable = 0, where N is the channel number; Table 3), its field on the screen remains blank.
In addition to the main screen, a temperature graph screen is available for each enabled channel. The graph shows the channel temperature change over the last 10 minutes with a 5 s refresh period. The screen displays the channel number, temperature scale, and the latest measured value. The graph scale is selected automatically. This operating history is formed after the TR-100E is powered on and does not replace the temperature logger data.
To view the graphs, briefly press the «Up» (UP) button to go to the next screen or the «Down» (DOWN) button to go to the previous screen. The screens switch cyclically; graphs of disabled channels are skipped.
The states of all LED indicators are given in Table 2.
Table 2 - LED indicator states
Indicator
State
Meaning
CH1 - CH4
Off
Channel is normal
Blinking
Channel sensor fault (open circuit or short circuit)
FAULT
Off
Normal
Blinking
Sensor fault or internal TR-100E error detected
ALARM
Off
The temperature of all channels is below the turn-off threshold set by parameters Alarm → Setpoint CH1-CH4 and Alarm → Hysteresis CH1-CH4
Flashing
The temperature of one of the channels has exceeded the corresponding Alarm → Setpoint CH1-CH4 parameter; Alarm → Delay countdown is in progress
Lit
«Alarm» relay is on
TRIP
Off
The temperature of all channels is below the turn-off threshold set by parameters Trip → Setpoint CH1-CH4 and Trip → Hysteresis CH1-CH4
Flashing
The temperature of one of the channels has exceeded the corresponding Trip → Setpoint CH1-CH4 parameter; Trip → Delay countdown is in progress
Lit
«Overheat» relay is on
FAN
Off
«Ventilation» relay is off
Flashing
The temperature of one of the selected channels has exceeded the corresponding Fan → Setpoint CH1-CH4 parameter; Fan → Delay countdown is in progress
During operation, the TR-100E automatically maintains an event log in the background; no action by the user is required for this.
The log records significant events and diagnostic messages related to TR-100E operation. The main types of records are listed below; this list is not exhaustive:
operation and release of TRIP, ALARM, FAN, and FAULT relays; when TRIP, ALARM, and FAN operate, the channel number and temperature are recorded;
open circuit or short circuit of the measurement line, as well as restoration of its normal state;
TR-100E startup, scheduled restart, and detection by the watchdog timer of a previous restart;
password verification results when accessing settings: successful login, incorrect password entry, and access lockout;
saving settings and errors during their loading or saving;
temperature logger data initialization and write errors;
successful NTP time synchronization and errors of Web, Modbus TCP, NTP, and WireGuard VPN network services;
measurement errors, as well as information about critical firmware failures.
Each record contains the date and time of the event, its description, and additional information that makes it possible to determine the cause of protection operation or a fault.
The log is designed for 2048 records. When the limit is reached, new events continue to be recorded, overwriting the oldest ones. Data is stored in non-volatile memory and is not lost when the power is removed.
Operating the log from the front panel: while on the main screen, press and hold the «Menu» (MENU) button for at least 5 s. If necessary, enter the password according to Sec. 2.2.5. Using the «Up» / «Down» (UP/DOWN) buttons, select Event log and press the «Enter» (SET) button. Then perform the required action:
viewing the log: select View list and press the «Enter» (SET) button. Using the «Up» / «Down» (UP/DOWN) buttons, select a record; to view detailed information, press the «Enter» (SET) button. To return, press the «Menu» (MENU) button;
clearing the log: select Clear and press the «Enter» (SET) button. In the confirmation window, use the «Up» (UP) button to select Yes and press the «Enter» (SET) button.
Viewing and export through the Web interface: open the TR-100E Web interface and go to the Log tab. To save the log to the events.log file, click the Export LOG button.
The logger periodically stores the temperature values of all four channels, which makes it possible to analyze the thermal operating mode of the monitored object for the period whose data is stored in the logger memory.
By default, the logger is enabled with a logging interval of 600 seconds. The interval can be changed in the range from 5 to 3600 seconds using the Temperature logger → Recording period parameter, and the logger can be disabled using the Temperature logger → Enable parameter (Table 3).
Each record contains the measurement date and time, the temperatures of all four channels, as well as the current channel status flags for each channel (TRIP, ALARM, FAN operation, sensor fault).
The logger is designed for 16384 records. When the limit is reached, new data continues to be recorded, overwriting the oldest records. The shorter the logging interval, the faster the buffer fills and the smaller the depth of stored history. Data is stored in non-volatile memory and is not lost when the power is removed.
Operating the logger from the front panel: while on the main screen, press and hold the «Menu» (MENU) button for at least 5 s. If necessary, enter the password according to Sec. 2.2.5. Using the «Up» / «Down» (UP/DOWN) buttons, select Temperature logger and press the «Enter» (SET) button. Then perform the required action:
viewing records: select View list and press the «Enter» (SET) button. Using the «Up» / «Down» (UP/DOWN) buttons, select a record; to view detailed information, press the «Enter» (SET) button. To return, press the «Menu» (MENU) button;
clearing records: select Clear and press the «Enter» (SET) button. In the confirmation window, use the «Up» (UP) button to select Yes and press the «Enter» (SET) button.
Viewing and export through the Web interface: open the TR-100E Web interface and go to the Temperature logger tab. To save the records to the recorder.csv file, click the Export CSV button.
To enter parameter modification mode while on the main screen, press and hold the «Menu» (MENU) button for at least 5 s. If access is password-protected, enter the password according to the instructions below. If entered correctly, the message Password accepted is displayed, after which the parameter menu opens. If entered incorrectly, the number of remaining attempts is displayed. After five unsuccessful attempts, access is locked for 5 minutes.
The factory password is indicated on the sticker with the QR code. In the Access menu, passwords can be changed and their verification can be enabled or disabled independently. Disabling verification does not delete the stored password.
The local access password must contain 4…23 characters, and the Web and Modbus passwords 8…23 characters. Current passwords are not displayed: when Change password is selected, input starts from an empty field; canceling keeps the previous value.
Diagnostic mode is intended for service work by qualified specialists and is not used during normal operation of the TR-100E.
When diagnostic mode is enabled, factory values are loaded into a temporary working copy of settings, but are not saved to flash memory automatically. Until the next restart, the local menu and Web interface are available without entering a password, and the Web interface is granted the powerUser access level.
To enable diagnostic mode:
Remove power from the TR-100E.
Press and hold the «Up» and «Down» (UP/DOWN) buttons simultaneously.
Apply power and continue holding the buttons until the DIAGNOSTIC MODE heading and the User run device in diagnostic mode message appear, then release them.
When the mode is enabled, the User run device in diagnostic mode message is recorded in the event log. While the mode is active, a warning about the enabled diagnostic mode is periodically displayed.
To start the TR-100E in normal mode, restart the device without holding the «Up» and «Down» buttons, or remove and reapply power. If the settings were not saved, on such a startup the device will load the previously saved settings and restore normal password verification.
2.2.7.1 Checking LED Indication and Viewing Minimum and Maximum Channel Temperatures
To check LED indication, while on the main screen press the «Test» (TEST) button. The TR-100E will switch to a separate test screen, turn on all LED indicators, and display the minimum and maximum recorded temperatures for each channel.
To exit test mode, press the «Menu» (MENU) button. If no buttons are pressed for 60 s, the test screen closes automatically.
Enter the parameter menu according to Sec. 2.2.5 and select System → Relay test.
In the warning window, use the «Up» (UP) button to select Yes and press the «Enter» (SET) button. A screen will open with a list of relays TRIP, ALARM, FAN, and FAULT and their current test status: On or Off.
Using the «Up» / «Down» (UP/DOWN) buttons, select the required relay.
Press the «Enter» (SET) button. The selected relay will switch, and its status on the screen will change. Pressing the «Enter» (SET) button again will return the relay to its previous state.
Repeat the check for the remaining relays.
To complete testing, press the «Menu» (MENU) button. Test states of all relays will be disabled, after which the TR-100E will return to the parameter menu.
The TR-100E uses a real-time clock (RTC) to timestamp the event log and logger. The date and time can be set manually from the front panel or through the Web interface. Automatic NTP time synchronization is also available.
Setting the date and time from the front panel:
Enter the parameter menu according to Sec. 2.2.5 and select Date and time → Date.
Using the «Up» / «Down» (UP/DOWN) buttons, set the day. Using the «Enter» (SET) button, move successively to the month and year and set their values.
After setting the year, press the «Enter» (SET) button to write the date to the real-time clock.
Select Date and time → Time.
Using the «Up» / «Down» (UP/DOWN) buttons, set the hour. Using the «Enter» (SET) button, move successively to minutes and seconds and set their values.
After setting the seconds, press the «Enter» (SET) button to write the time to the real-time clock.
To cancel entry without writing, press the «Menu» (MENU) button.
Setting the date and time through the Web interface:
Log in to the Web interface with the powerUser access level and open Settings → Date and time.
In the Set time block, specify the local date and time.
Click the Set manually button. The specified value will be written to the real-time clock immediately; pressing the Save button is not required for this.
Time zone:
In the Settings → Date and time section, in the Time zone field, select the required offset relative to UTC, for example UTC+02:00 or UTC+03:00. The selected time zone is applied when displaying local time. To save the setting, click the Save button.
Daylight saving time (DST):
The following values are available in the DST mode field:
Off - seasonal time changeover is disabled;
Europe - a one-hour shift is applied on the last Sunday of March, and return to standard time occurs on the last Sunday of October;
USA - a one-hour shift is applied on the second Sunday of March, and return to standard time occurs on the first Sunday of November;
Manual - the user specifies DST shift, as well as the local date and time of its start and end.
After changing the DST mode and the parameters related to it, click the Save button.
The complete list of stored parameters is given in Table 3. In the Holding Register Address column, the — sign means that the parameter is not transmitted via Modbus TCP and is configured through the menu, Web interface, or Web API.
Table 3 - Programmable and used parameters
Holding Register Address
Parameter
Range / values
Factory setting
Modbus Access
Type
—
General
—
—
—
—
100
Language
0 English; 1 Polish; 2 Ukrainian; 3 Russian
0 (English)
W+R
uint16
—
Date and time
—
—
—
—
101
Time zone offset, min
-720…840
0
W+R
int16
102
DST mode
0 off; 1 EU; 2 USA; 3 manual
0 (off)
W+R
uint8
103
DST shift, min
0…180
60
W+R
int16
104–105
DST start, local time
Unix time
1774749600
W+R
uint32
106–107
DST end, local time
Unix time
1792897200
W+R
uint32
—
Display
—
—
—
—
108
Display contrast
0…64
24
W+R
uint16
109
Active backlight, %
0…100
50
W+R
uint16
110
Standby backlight, %
0…100
15
W+R
uint16
111
Standby backlight timeout, s
30…3600
300
W+R
uint16
112
Standby backlight enable
0…1
1
W+R
uint8
—
Access
—
—
—
—
—
Device password
—
—
—
—
—
Protection
0 off; 1 on
1
—
uint8
—
Change password
4…23 characters
Password from the label
—
string
—
Web user password
—
—
—
—
—
Protection
0 off; 1 on
1
—
uint8
—
Change password
8…23 characters
Password from the label
—
string
—
Web admin password
—
—
—
—
—
Protection
0 off; 1 on
1
—
uint8
—
Change password
8…23 characters
Password from the label
—
string
—
Modbus password
—
—
—
—
—
Protection
0 off; 1 on
1
—
uint8
—
Change password
8…23 characters
Password from the label
—
string
—
Temperature logger
—
—
—
—
113
Enable
0…1
1
W+R
uint8
114
Recording period, s
5…3600
600
W+R
uint16
—
TCP/IP
—
—
—
—
—
Ethernet enable
0…1
1
—
uint8
115
DHCP
0…1
1
W+R
uint8
116–117
DNS 1
IPv4
8.8.8.8
W+R
uint32
118–119
DNS 2
IPv4
4.4.4.4
W+R
uint32
120–121
Static IP address
IPv4
192.168.0.100
W+R
uint32
122–123
Network mask
IPv4
255.255.255.0
W+R
uint32
124–125
Gateway
IPv4
192.168.0.1
W+R
uint32
—
Time synchronization (NTP)
—
—
—
—
126
Enable
0…1
0
W+R
uint8
127–128
Synchronization period, s
300…86400
3600
W+R
uint32
129–144
Server 1
DNS name or IPv4, up to 31 characters
pool.ntp.org
W+R
str16
145–160
Server 2
DNS name or IPv4, up to 31 characters
time.google.com
W+R
str16
—
WireGuard VPN
—
—
—
—
—
Enable
0…1
0
—
uint8
—
Auto-configuration via Overvis
0…1
1
—
uint8
—
Auto-configuration URL
URL
Empty
—
string
—
Private key
32 bytes
Not set
—
bytes
—
IP address
IPv4 with prefix length
Not set
—
IPv4/CIDR
—
Peer public key
32 bytes
Not set
—
bytes
—
Peer name
DNS name or IPv4
Empty
—
string
—
Peer port
1…65535
51820
—
uint16
—
Allowed networks 1–2
IPv4 with prefix length
Not set
—
IPv4/CIDR × 2
—
Keepalive interval, s
1…300
25
—
uint16
—
Web access
—
—
—
—
161
Enable
0…1
1
W+R
uint8
162
Port
1…65535
80
W+R
uint16
163
Access via VPN
0…1
1
R
uint8
164
VPN access level
0 guest; 1 standard; 2 advanced
0
R
uint8
—
Modbus TCP
—
—
—
—
165
Enable
0…1
1
W+R
uint8
166
UID
0…247; 0 - any UID
48
W+R
uint8
167
Port
1…65535
502
W+R
uint16
168
Timeout, s
0 disabled; 1…3600
0
W+R
uint16
169
Protection mode
0 none; 1 write; 2 read and write
1
W+R
uint8
170
Access via VPN
0 disabled; 1 standard protection; 2 read only; 3 read and write
To access the TR-100E Web interface, a PC with an installed Web browser is required.
In the address bar of the Web browser, enter the current IP address of the TR-100E displayed on its screen and press Enter.
After opening the Web interface, the password entry form is displayed.
The TR-100E uses two independent Web access passwords:
regular user password - user level;
advanced user password - powerUser level.
The entered password determines the granted access level. A user at the user level has access to the Monitoring, Logger, and Log tabs. A user at the powerUser level additionally has access to the Settings and Service tabs, as well as the operations for clearing the log and the logger.
Password verification for Web user and powerUser is enabled independently in Settings -> Security. If powerUser verification is disabled, the Web interface grants this level without password entry. Otherwise, if user verification is disabled, the user level is granted without a password.
The tab is available only to a user at the powerUser level. Settings are presented as collapsible sections: Channels, Trip, Alarm, Fan, Fault, Network, WireGuard, Web server, Modbus TCP, NTP, Date and time, Logger, Display, Language, and Security. Several sections can be opened at the same time.
The settings of each section are loaded and saved separately. The Refresh button rereads the settings of the open section from the TR-100E, and the Save button writes the changes. If applying the saved settings requires a restart, the Web interface displays a corresponding warning; the restart is not performed automatically.
In the Security section, saved passwords are not displayed. To leave a password unchanged, do not fill in the corresponding field; to replace a password, enter a new value.
The TR-100E supports a VPN connection using the WireGuard protocol. The VPN creates a secure network channel between the TR-100E and a remote WireGuard peer and allows access to the device’s network services through the VPN interface.
The VPN connection parameters can be set manually or obtained automatically. The configuration mode is selected in the TR-100E Web interface.
For VPN operation, the TR-100E must have Internet access, correctly configured gateway and DNS servers, and the network must not block the connection to the remote WireGuard peer.
The VPN parameters are located in the Web interface under Settings -> VPN-WireGuard.
Manual configuration is used to connect to a WireGuard peer selected by the user. To apply it:
Enable the Enabled parameter.
Disable the Automatic connection to the Overvis server parameter.
Specify the values provided by the VPN administrator: private key, interface address in CIDR format, public key and peer address, port, allowed IP networks, and keepalive interval.
Click the Save button.
After the modified parameters are saved, the WireGuard service restarts automatically; restarting the TR-100E is not required.
Overvis is a cloud-based monitoring and visualization system that can use WireGuard VPN to access the TR-100E. When automatic mode is selected, the TR-100E is identified by its factory PIN code, receives WireGuard parameters from Overvis, and establishes a VPN connection. In this case, a static public IP address and forwarding of incoming ports on the router are not required.
When the Automatic connection to the Overvis server parameter is enabled, the manual configuration fields are not used. The Automatic configuration server URL field should be left empty unless a different address is provided by the manufacturer or technical support.
To connect through Overvis, it is necessary to:
Provide the TR-100E with Internet access.
Under Settings -> VPN-WireGuard, enable Enabled and Automatic connection to the Overvis server, then save the settings.
Create a network in the Overvis account and bind the TR-100E to it using the factory PIN code.
Wait for the VPN connection to be established and verify access to the required TR-100E data.
An established VPN connection by itself does not permit access to the TR-100E network services. The required services and access to them over VPN are configured separately:
for the Web interface, in Settings -> Web server, enable Web access via VPN and select Default access level via VPN: Guest, User, or PowerUser;
for Modbus TCP, in Settings -> Modbus TCP, select Modbus access via VPN: Disabled, Standard protection, Read only, or Read and write.
In Standard protection mode, VPN sessions follow the common Modbus protection mode and require password unlocking under the same conditions as local connections. Read only permits passwordless reads over VPN and rejects all write commands. Read and write permits passwordless reads and writes over VPN; local connections continue to follow the common Modbus protection mode.
Permit only the necessary services through the VPN and assign the minimum sufficient access level.
The TR-100E is connected to the local network via the Ethernet interface. The Modbus TCP protocol is used for data exchange between the TR-100E and a Modbus client over a TCP/IP network.
Via Modbus TCP, it is possible to:
read the measured values and current status of the TR-100E, for example for data transmission to a SCADA system;
read and modify the available TR-100E settings;
execute the service commands provided by the protocol.
For safety reasons, direct control of the output relays via Modbus TCP is not provided: the relays are controlled by the built-in protection algorithms in accordance with the measurement results, configured thresholds, hysteresis, and delays. This prevents bypassing the protection algorithms by a remote command.
The TR-100E uses two independent groups of Modbus registers: Input registers and Holding registers. Current states are read from the Input registers with function 0x04; settings, service values, and commands are located in the Holding registers and are handled by functions 0x03, 0x06, and 0x10.
The Timeout parameter defines the permitted time without data from a Modbus client. If no data is received within the configured time, the TR-100E closes the TCP connection. TCP Keepalive control packets do not reset this timeout. A value of 0 disables the timeout; in this case, an inactive connection is not closed by the TR-100E. The factory setting is 0 (timeout disabled).
By default, the Modbus protection mechanism restricts writing to protected Holding registers. To unlock them, the Modbus password must be written to registers 52-63 in ASCII characters (two characters per register, most significant byte first, string terminated with a zero byte). By default, the factory password indicated on the sticker with the QR code is used. Successful verification unlocks only the current TCP session; the state of the protection mechanism is available in register 51. After five incorrect attempts, requests from this IP address are blocked for 5 minutes.
When changing the Modbus password, a password length of 8…23 characters is allowed. Password verification is enabled and disabled by the Modbus password -> Protection parameter; disabling verification does not delete the saved password. The operating mode of the protection mechanism is set by register 169: 0 - no protection, 1 - write protected, 2 - read and write protected. Access to service registers 0-4, 51, 52-63, and 64-65 does not depend on the selected protection mode and is specified in Table 7.
VPN sessions are additionally governed by the Modbus access via VPN setting. The Read only and Read and write levels do not require password unlocking over VPN and do not change the protection of local Modbus connections.
Table 4 - List of supported functions (Modbus)
Function code
Function name
Description
0x03
Read Holding Registers
Read settings and service registers
0x04
Read Input Registers
Read current states and measurements
0x06
Write Single Holding Register
Write a value or command occupying one register
0x10
Write Multiple Holding Registers
Write a value occupying multiple registers or a sequence of values
Table 5 - Data types
Type
Length, bytes
Description
int16
2
Integer from -32768 to 32767
uint16
2
Integer from 0 to 65535
int32
4
Integer from -2147483648 to 2147483647
uint32
4
Integer from 0 to 4294967295
strN
2×N
String up to 2×N bytes: most significant byte of the register first, terminated by 0x00
Temperature ×10; -32768 (0x8000) - measurement invalid
int16
3-4
Operating time
Seconds since startup
uint32
5-6
Status flags
Bit mask of the general TR-100E status. The meaning of the bits is given below
uint32
7-8
Device function readiness
Bit mask of the TR-100E subsystem status. The meaning of the bits is given below
uint32
9-10
RTC time
Number of seconds since 00:00:00 01.01.1970 UTC
uint32
11
RTC synchronization source
0 none; 1 RTC backup; 2 NTP; 3 manual setting
uint16
12-13
Last NTP time synchronization
Number of seconds since 00:00:00 01.01.1970 UTC; 0 - no successful time synchronization has occurred
uint32
14-15
NTP synchronization counter
Number of successful synchronizations
uint32
16-17
NTP error counter
Number of unsuccessful synchronizations
uint32
18-19
Current IP address
Active IPv4
uint32
20-21
Current mask
Active IPv4 mask
uint32
22-23
Current gateway
Active IPv4 gateway
uint32
24-27
CH1-CH4 status
Bit mask of the state of each channel. The purpose of the registers and bits is given below
uint16 × 4
28-31
CH1-CH4 line status
0 unknown; 1 short circuit; 2 below range; 3 normal; 4 above range; 5 open circuit
uint16 × 4
32-35
Current temperature CH1-CH4
Temperature ×10; -32768 (0x8000) - measurement invalid
int16 × 4
36-39
Minimum temperature CH1-CH4
Temperature ×10; -32768 (0x8000) - measurement invalid
int16 × 4
40-43
Maximum temperature CH1-CH4
Temperature ×10; -32768 (0x8000) - measurement invalid
int16 × 4
44-47
Temperature change direction CH1-CH4
0 decreasing; 1 unchanged; 2 increasing
uint16 × 4
Interpretation of Registers 5-6 “Status flags”
A set bit (1) means that the specified condition is active. A cleared bit (0) means that the condition is inactive.
Bit
Condition
Meaning when the bit is set (1)
0
FAULT
The FAULT relay is on due to a sensor fault or an internal TR-100E error. The bit is set after the Fault -> Delay delay has elapsed
1
TRIP
The TRIP relay is on due to exceeding the trip threshold. The bit is set after the Trip -> Delay delay has elapsed
2
ALARM
The ALARM relay is on due to exceeding the alarm threshold. The bit is set after the Alarm -> Delay delay has elapsed
3
FAN
The FAN relay is on due to exceeding the fan threshold. The bit is set after the Fan -> Delay delay has elapsed
4
Restart required
Restart of the TR-100E is required to apply some of the saved settings
5
Diagnostic mode
The mode is activated by the “Up” + “Down” combination at startup; password protection is disabled and protected diagnostic commands are permitted
Interpretation of Registers 7-8 “Device function readiness”
Each bit indicates the readiness of the corresponding subsystem: 1 - the subsystem is ready for operation; 0 - the subsystem is not ready or not initialized.
Bit
Subsystem
Meaning when the bit is set (1)
0
Settings
The settings data is valid and available
1
Measurement service data
The service data of the measurement path is valid
2
Real-time clock
The RTC is configured and operating
3
Buttons
The button module is ready
4
LED indicators
The LED indication module is ready
5
Display
The LCD is ready
6
External memory
The external memory is ready
7
Identification data
The device identification data storage is ready
8
Event log
The event log is ready
9
Temperature logger
The temperature logger is ready
10
Live temperature history
The temperature history is ready
11
Temperature measurement
The measurement module is ready
12
Random number generator
The hardware random number generator is ready
13
Ethernet
The Ethernet interface is ready
14
TCP/IP network stack
The network stack is ready
15
Web interface
The Web server is ready
16
NTP
The time synchronization client is ready
17
WireGuard
The WireGuard VPN service is ready
18
Modbus TCP
The Modbus TCP server is ready
Interpretation of Registers 24-27 “CH1-CH4 status”
Each channel corresponds to a separate register: 24 - CH1, 25 - CH2, 26 - CH3, 27 - CH4.
Bit
Channel state
Meaning when the bit is set (1)
0
Channel enabled
The channel is enabled and participates in measurement processing
1
TRIP condition
The channel temperature has reached the Trip threshold or has not yet dropped below the threshold taking hysteresis into account
2
ALARM condition
The channel temperature has reached the Alarm threshold or has not yet dropped below the threshold taking hysteresis into account
3
FAN condition
The channel is selected for ventilation control, and its temperature has reached the Fan threshold or has not yet dropped below the threshold taking hysteresis into account
Table 7 - Holding registers: service values and commands
Address
Name
Description
Access
Type
0
Device model code
TR-100E: 48
R
uint16
1
Firmware version
For example, 0x0100 for version 1.0
R
uint16
2-4
MAC address
6 bytes
R
str3
50
Command
62149 restart; 18252 save working copy; 54135 reread settings; 33421 reset minimum and maximum temperatures; 20052 synchronize time via NTP
W+R
uint16
51
Protection mechanism state
0 - protection active; 1 - protected operations permitted for the current TCP session
R
uint16
52-63
Modbus password
Enter the current password; only the required number of registers may be written
W
str12
64-65
Set UTC time
Number of seconds since 00:00:00 01.01.1970 UTC; value 0 is prohibited; both registers must be written in one request
To configure a router or firewall, the network connections listed in Table 8 should be taken into account.
Table 8 - TR-100E network ports
Function
Protocol and port
Direction relative to the TR-100E
Conditions of use
Web interface and Web API
TCP 80
Incoming
Default port; changed by the Web access -> Port parameter
Modbus TCP
TCP 502
Incoming
Default port; changed by the Modbus TCP -> Port parameter
DHCP
UDP 68 ↔ UDP 67
Outgoing and response
The TR-100E uses local port 68, the DHCP server uses port 67; used when DHCP is enabled
DNS
UDP 53
Outgoing and response
Requests to the configured DNS servers; required when DNS names of NTP, WireGuard, or autoconfiguration servers are used
NTP
UDP 123
Outgoing and response
Time synchronization with the configured NTP servers when NTP is enabled
WireGuard VPN
UDP 51820
Incoming and outgoing
Local TR-100E port; for the remote peer, 51820 is also used by default, but it can be changed by the VPN-WireGuard -> Peer port parameter
Automatic WireGuard configuration via Overvis
TCP 80
Outgoing and response
Default port; a different port may be specified in the automatic configuration server URL
Recovery mode Web interface
TCP 80
Incoming
Available only in the bootloader recovery mode at address 192.168.1.48
Incoming connections to the Web interface and Modbus TCP should be allowed only from trusted networks. If only outgoing connections to the NTP, DNS, and autoconfiguration server are used, port forwarding on the router is not required; the firewall must permit the response traffic of established connections.
Check that the wires are securely connected to the TR-100E terminals; if any loose contacts are found, tighten the terminal screws. If damaged wires are found, replace them with new ones;
Visually inspect the enclosure integrity; if cracks or chips are found, take the product out of service and send it for repair;
If necessary, wipe the product enclosure with a cloth. Do not use abrasive materials or solvents for cleaning.
The display does not light up after power is applied
No voltage is present at the power supply terminals; TR-100E fault
Check that the supply voltage is present at the terminals and complies with the requirements of Table 1. If the voltage complies with the requirements but the display does not turn on, send the TR-100E for repair
The CH1-CH4 indicator flashes, the channel shows “OPEN”
Sensor line break or sensor fault
Check the integrity of the cable and that the sensor is securely connected to the TR-100E terminals
The CH1-CH4 indicator flashes, the channel shows “SHORT”
Short circuit in the sensor line
Check the sensor cable for a short circuit; replace the sensor or cable
Check the channel status on the display. If the channels are operating correctly, check the event log to determine the cause. Restart the unit: switch the power off and on again, or use the web interface (System -> Restart). If FAULT continues to flash after restart without any apparent reason, send the TR-100E for repair
The relay does not actuate when the threshold is exceeded
Delay timing is in progress; the channel is disabled; the threshold is set incorrectly
Check the Delay, channel Enable, and Threshold settings (Table 3)
The relay does not de-energize after the temperature decreases
Hysteresis is set too high; incorrect threshold
Check the Hysteresis and Threshold settings for the relevant relay (Table 3)
The time resets after a prolonged power outage
The RTC backup capacitor is discharged (more than 7 days without power)
Set the time manually (Section 2.2.9) or enable NTP synchronization
No access to the web interface via the IP address
Incorrect IP address; web server is disabled; no network connection
Check the IP address on the TR-100E display; make sure the web server Enable parameter = 1 (Table 3); check the Ethernet cable and the LINK indicator
The Modbus TCP client does not receive a response
Incorrect IP, port, or UID; Modbus is disabled; the number of connections has been exceeded
Check the Enable, Port, and UID settings (Table 3); make sure that the number of simultaneous clients does not exceed 5
No time synchronization via NTP
NTP is disabled; incorrect server address; no network access
Check the NTP Enable, Server Address, network settings, and TR-100E Internet access (Table 3)
Data logger data is not being recorded
The data logger is disabled
Enable the Data Logger parameter and check the Temperature Recording Period parameter value (Table 3)
The warranty period for the product is 10 years from the date of sale.
During the warranty period, the manufacturer performs repair of the product free of charge in the event of product failure.
TR-100E in the manufacturer’s packaging may be transported and stored at temperatures from minus 30 to +60 °C and relative humidity not exceeding 98% at 35 °C (without moisture condensation).
This appendix describes TR-100E firmware recovery using bootloader tools. Use this procedure if the standard Web interface does not open, an update ended with an error, or TR-100E reports an invalid application.
The bootloader provides two recovery methods:
Restore firmware — reinstall a previously uploaded firmware image;
Recovery mode — load a new .ota firmware file from a computer over Ethernet and install it.
For recovery, you need:
a TR-100E firmware file in .ota format — for Recovery mode;
a computer with a Web browser and Ethernet interface — for Recovery mode;
an Ethernet cable to connect the computer to TR-100E directly or through a network switch.
This method does not require a computer. Use it if the update file was completely loaded into TR-100E before the failure.
Enter the bootloader menu according to section A.1.
Use the UP/DOWN buttons to select Restore firmware and press SET.
Wait for the verification and installation of the firmware to complete. The progress is displayed as a percentage from 0 to 100%.
After the message Done, start app appears, TR-100E will automatically start the restored firmware.
If Image not found, Image invalid, or Operation failed appears, load a new .ota file according to section A.3. After an error message, the bootloader will attempt to run the installed firmware. To re-enter the menu, power on TR-100E again while holding the MENU button.
A.3 Loading a New Firmware Image via Recovery Mode
On the TR-100E Recovery page, click the file selection field and select the TR-100E firmware file with the .ota extension.
Click Send and wait for the file to be transferred to TR-100E.
Wait for the value percent=100%. After receiving the file, the bootloader verifies the firmware image format, device compatibility, and data checksum.
Confirm that the status field shows imageValid=true, lastError=0, and the Firmware button is now available.
If the upload is interrupted before clicking Firmware, the installed firmware will not be changed. Without rebooting TR-100E, select the file and click Send again: the incomplete upload will be replaced with the new one.
Click Firmware. A message Rebooting… will appear on the page, after which TR-100E will restart and begin installation.
Do not disconnect power or press buttons. The display shows the firmware verification and installation stages.
Wait for the Done message and the automatic startup of TR-100E.
After the main screen appears, check the firmware version and verify the functionality of the measurement channels and relays.
Restore the original IPv4 settings for the computer’s Ethernet interface.
Before installation, the bootloader verifies the compatibility, integrity, and authenticity of the file. A corrupted file, a file modified after release, or a file intended for a different device cannot be installed.
The previously uploaded firmware image was not found. Perform the upload according to section A.3
Image invalid
Invalid firmware image format or parameters. Obtain a valid .ota file for TR-100E
Operation failed
Failed to verify or install the firmware. Re-upload a known valid file; if the problem persists, contact the service organization
Previous update: Interrupted
The previous installation was interrupted. The bootloader automatically resumes it from the saved firmware image
Previous update: Failed
The previous installation ended with an error. Enter Recovery mode and upload a valid firmware image
Boot warning: Key not set
TR-100E does not have the data required to verify the firmware file. Contact the service organization
Run application: Application invalid
Manual run was selected, but the installed firmware is corrupted or missing. Perform recovery according to section A.2 or A.3
Boot error: Application invalid
The installed firmware is corrupted or missing. Perform recovery according to section A.2 or A.3
Clock error: HSE start failed
Failed to start the system clock generator. TR-100E will restart automatically; if the problem persists, contact the service organization
Ethernet error: MAC read failed
Failed to read the TR-100E network address. Restart the device; if the problem persists, contact the service organization
Ethernet error: ETH config failed
Failed to configure the Ethernet interface. Check the connection and restart Recovery mode; if the problem persists, contact the service organization
Ethernet error: LwIP init failed
Failed to start the network service. Restart Recovery mode; if the problem persists, contact the service organization
If the recovery page does not open:
confirm that the Recovery mode screen and the address 192.168.1.48 are displayed on the display;
check the Ethernet connection indicators on TR-100E and the computer’s network adapter;
verify that the computer’s address belongs to the 192.168.1.0/24 network but does not match 192.168.1.48;
temporarily disable VPN and other network interfaces on the computer;
open exactly http://192.168.1.48, without https;
verify that the firewall does not block TCP port 80 on the local network.
If recovery does not complete after re-uploading a valid file, record the text of the message on the display, the lastError status on the Recovery page, and the device MAC address, then contact the service organization.
This appendix describes two WireGuard VPN configuration modes:
static — connection parameters are specified manually to connect to a selected WireGuard peer;
automatic — TR-100E obtains connection parameters from Overvis after it is connected to an account using a PIN code.
In both modes, TR-100E initiates communication with the remote peer independently. Configuration requires access to the TR-100E Web interface with the powerUser access level. TR-100E must have an IP connection to the remote peer; when a hostname is used, the DNS servers must be configured correctly.
For static configuration, the VPN administrator must provide the WireGuard parameters for TR-100E and configure the corresponding peer on the remote endpoint.
Open the TR-100E Web interface and log in with the powerUser access level.
Go to the Settings tab and expand the VPN-WireGuard section.
Enable Enabled.
Disable Automatic Connection to Overvis Server. The static configuration fields will become available for entry.
Enter the parameters provided by the VPN administrator:
Field
Description
Private Key
TR-100E private key in Base64 format
Interface Address
TR-100E address within the VPN in IPv4/CIDR format, for example 10.8.0.2/24
Peer Public Key
Public key of the remote endpoint in Base64 format
Peer Host
DNS name or IPv4 address of the remote endpoint
Peer Port
UDP port of the remote endpoint, from 1 to 65535; the default value is 51820
Allowed IP 1, Allowed IP 2
Up to two networks whose traffic is routed through the peer, in IPv4/CIDR format
Keepalive (s)
Persistent keepalive interval from 1 to 300 s; the default value is 25 s
The private key, interface address, peer public key, and peer host are required. Use a prefix from /1 to /32 for the interface address. Both Allowed IP fields may be left empty. If no allowed network is specified, TR-100E uses the network defined by the interface address. If one Allowed IP field is completed, the route specified in that field is used. In the current firmware version, routes with the /0 prefix are not applied; use prefixes from /1 to /32 for Allowed IP.
Click Save in the VPN-WireGuard section. The WireGuard service will restart automatically; TR-100E does not need to be restarted.
If access to the Web interface or Modbus TCP is required through the static VPN connection, also configure the settings described in steps 5–11 of section B.2.2.
Go to the Service tab, select Network → VPN in the Diagnostics block, and enable Auto-refresh.
For a correctly completed static configuration, the following values are displayed:
Service — Enabled;
Mode — Static;
Configuration — Ready;
Connection — Configured, Connected, or Active.
Successful communication with the remote endpoint is confirmed by the Connected or Active state, a time in the Handshake field, and increasing RX/TX packet counters. The Invalid Configuration state means that at least one required parameter is missing: private key, interface address, peer public key, or peer host.
Figure B.2 – Static WireGuard connection status
If the static connection cannot be established:
if the Invalid Configuration state is displayed, check that the private key, interface address, peer public key, and peer host are completed;
compare all parameters against the remote peer configuration;
when using a DNS name, check the DNS settings in Settings → Network;
check that the peer host and UDP port are accessible from the TR-100E network;
check that the Allowed IP routes do not overlap with the local network in an unintended way;
make sure that the remote peer is configured to use the TR-100E key and VPN address.
Open the TR-100E Web interface and log in with the powerUser access level.
Go to the Service tab.
In the Device Information block, make sure that the Device Key and Registered indicators are green and that a value is displayed in the PIN Code field. Record the PIN code (it is also printed on the device label): the code is required to connect TR-100E to the Overvis account.
Go to the Settings tab and expand the VPN-WireGuard section.
Enable Enabled and Automatic Connection to Overvis Server.
Leave the Automatic Configuration Server URL field empty: the address programmed by the manufacturer will then be used. Complete this field only when instructed by technical support.
Click Save in the VPN-WireGuard section.
Figure B.4 – Configuring automatic connection to Overvis
Expand the Web Server section.
Enable Web Access via VPN and set Default Access Level via VPN to PowerUser.
Click Save in the Web Server section.
Figure B.5 – Configuring access to the Web interface via VPN
Expand the Modbus TCP section.
Enable Enabled and select Read and Write for Modbus Access via VPN. This access level is required so that Overvis HMI can both read and change TR-100E parameters.
Select Write for Protection Mode. Allowing writes via VPN does not disable local Modbus protection: local clients will still require password unlocking.
Click Save in the Modbus TCP section.
The Read and Write level grants password-free access to any Modbus TCP session accepted through the VPN interface. Use it only with a trusted WireGuard configuration. If remote parameter changes are not required, select Read Only.
Figure B.6 – Configuring access to Modbus TCP via VPN
After saving the settings, go to the Service tab, select Network → VPN in the Diagnostics block, and enable Auto-refresh. Wait for automatic configuration to finish. The following states indicate readiness for connection through Overvis:
Service — Enabled;
Mode — Auto;
Configuration — Ready;
Connection — Connected or Active;
the Handshake field displays the time of the last communication instead of a dash.
After these states appear, proceed to connect TR-100E to the Overvis HMI account.
Figure B.7 – WireGuard ready for connection through Overvis
B.2.4 Connecting TR-100E to an Overvis HMI Account
Before continuing, make sure that TR-100E is connected to the Internet and that automatic WireGuard configuration has been completed as described in section B.2.3. Have the 8-character PIN code printed on the enclosure label ready.
On the sign-in page, enter your email address in the Email field and click Send code. Enter the one-time code from the email in the field that appears. If this email address is being used for the first time, Overvis HMI will create an account after it is confirmed. No separate password is required. The code is valid for 10 minutes and can be used once. A new code can be requested after one minute; the previously issued code will then become invalid.
When signing in for the first time, enter your name and organization name. Overvis HMI will create the first workspace from the organization name. If the workspace already exists, open it.
Go to Manual Setup → Connections and click Create Connection.
In the Type field, select PIN. Port 502 is used for this connection type, so the Port field is not displayed.
In the Name field, replace New Connection with a meaningful name, such as the TR-100E installation location. Enter the code from the label in the PIN Code field and click Create.
Figure B.8 – Creating a TR-100E connection using a PIN code
Confirm device ownership: press Yes on TR-100E or enter the code shown on the device display in Overvis HMI.
Wait for the Connection created message.
In the Connections list, select the row that was created. On the Connection tab, make sure that the Connected state is displayed and that the Active Address field is populated. The list row must display the PIN label, manufacturer, and model code.
Figure B.9 – TR-100E connected to the workspace
After creation, the Type and linked device cannot be changed. If the PIN was entered incorrectly, delete the connection and create it again. This connection does not display temperatures by itself: the TR-100E parameters are added separately.
After creating the connection, add the controller parameters from the Novatek-Electro TR-100E template. The connection address and port do not need to be entered again.
In the setup menu, go to Parameters.
Click Add and select From template….
In the Add from template window, select the Novatek-Electro TR-100E template from the Overvis group.
Check the Root branch name field. Change the suggested name if necessary; the field must not be left empty.
Check the Unit ID field. The template uses the factory Modbus address of TR-100E — 48. If the controller address has been changed, enter its current value.
In the Endpoint field, select the TR-100E connection created earlier.
Click Add. The changes do not need to be saved separately.
Figure B.10 – Adding TR-100E parameters from a template
After the template is applied, a new root branch containing the TR-100E parameters will appear in the Parameters tree. To check communication with the controller, select the new branch and click Read. The values received must appear to the right of the parameters. For continuous polling, enable Live.
Figure B.11 – Verifying that TR-100E parameters can be read
If an error is displayed instead of values, check that the Device ID field matches the controller’s Modbus address and that the created connection has the Connected state.
guest has access only to GET /api/auth/status/, GET /api/auth/salt/, GET /api/version/, and POST /api/auth/login/.
user has access to standard endpoints and also to service/time/sync.
powerUser has full access to all endpoints.
All POST /api/debug/* requests except /api/debug/display/start/ and /api/debug/display/stop/ additionally require diagnostic mode, activated at startup by pressing Up + Down. In normal mode, these requests return 403 Forbidden. This restriction does not apply to GET /api/debug/* requests.
Log in — POST /api/auth/login/, by sending SHA256(username + password + salt).
All subsequent requests include the Authorization: Bearer <token> header.
Log out — POST /api/auth/logout/.
Web authorization uses two independent passwords: one for the user level and one for the powerUser level. Retrieving and modifying access settings is described in settings-get.md and settings-set.md.
If the Bearer session is valid, the endpoint returns that session’s access level.
If no Bearer session is present, the endpoint returns the anonymous access level calculated by the device: guest, user, or powerUser.
Anonymous access may be granted by diagnostic mode, trusted VPN access, or disabled validation of the corresponding web password. If powerUser validation is disabled, powerUser is returned; otherwise, if user validation is disabled, user is returned.
Novatek-Electro TR-100E Documentation
GET /api/auth/salt/
Retrieve the salt used to calculate the password hash on the client.
Important: The salt is single-use and is invalidated after each login attempt. Request a new salt before trying to log in again.
passwordHash is checked against the powerUser password first, then against the user password. The accessLevel in the response corresponds to the password that matched.
If Web password verification is disabled by the webPwrPassEnable or webUserPassEnable setting, the device may grant the corresponding anonymous access level without a login request; determine that level using GET /api/auth/status/. A disabled powerUser takes precedence over a disabled user.
GET /api/settings/get/?meta&general&dateTime&display&access&recorder&network&ntp&web&modbus&vpnWireguard&channels&protection
Retrieve one or more top-level persistent-settings groups.
Auth: Bearer.
The access passwords are write-only and are not included in responses at any access level. The vpnWireguard.privateKey private key is returned only to powerUser; for user, the field is null.
Require a password to unlock protected Modbus TCP operations
The devPassword, webUserPass, webPwrPass, and modbusPassword fields are intentionally omitted from the response. The API exposes neither saved passwords nor whether a custom value has been set. Clients must use only the ...PasswordEnable flags as the protection state. At the user level, these flags are returned as null; their values are available to powerUser.
Overvis auto-configuration mode (parameters are retrieved from the cloud using the device identity)
autoConfigUrl
string
Auto-configuration server URL
privateKey
string
Static WireGuard private key in base64
address
string
Local interface address in CIDR notation, for example 10.0.0.2/24
peerPublicKey
string
Static WireGuard peer public key in base64
peerHostname
string
Peer hostname
peerPort
number
Peer port
allowedIps
string[]
Exactly 2 peer CIDR routes
keepaliveSec
number
Persistent keepalive interval in seconds
When autoConfigEnable = false, all static vpnWireguard fields are used, including keys and the endpoint.
When autoConfigEnable = true, the static vpnWireguard fields are ignored at runtime; WireGuard/Overvis obtains parameters through the service identity API for automatic configuration.
access.devPasswordEnable, access.webUserPassEnable, access.webPwrPassEnable, access.modbusPasswordEnable: true | false; false disables validation of the corresponding password without deleting the saved value.
access.devPassword: string with a length of 4..23 characters.
access.webUserPass, access.webPwrPass, access.modbusPassword: string with a length of 8..23 characters.
Allowed password characters: digits 0–9, Latin letters A–Z, a–z and the characters ., -, _, :, /, @.
A null password, an empty string, a value that is too short or too long, or an invalid character → 400 ERROR_INVALID_VALUE.
To leave a password unchanged, omit the field. The protection state is changed independently using the corresponding ...PasswordEnable flag.
recorder.enabled: true | false.
recorder.periodSec: 5..3600 seconds.
ntp.syncPeriodSec: 300..86400 seconds.
ntp.server1, ntp.server2: up to 31 characters each.
web.port: 1..65535.
web.vpnTrusted: true | false.
web.vpnAccessLevel: 0..2 (password, user, powerUser); 0 uses standard password authorization.
modbus.unitId: 0..247; 0 — accept requests with any Unit ID.
vpnWireguard.autoConfigUrl: Auto-configuration server URL.
vpnWireguard.privateKey: WireGuard base64 string for the static private key. An empty string "" clears the key.
vpnWireguard.address: IPv4 CIDR string, for example 10.8.0.2/24. An empty string "" clears the address.
vpnWireguard.peerPublicKey: WireGuard base64 string for the static peer public key. An empty string "" clears the key.
vpnWireguard.peerHostname: peer hostname.
vpnWireguard.peerPort: 1..65535.
vpnWireguard.allowedIps: array of 2 IPv4 CIDR strings. An empty string "" clears the element.
vpnWireguard.keepaliveSec: 1..300 seconds.
channels.filterLevel: 1..10.
channels.items[].userOffset: -10.0..10.0 °C.
channels.items[].ptcMinikaNominal: 60.0..180.0 °C.
channels.items[].linked: 0..1; when a TRIP/ALARM/FAN threshold or hysteresis is written for a linked channel, the value is automatically copied to all linked channels.
When vpnWireguard.autoConfigEnable = false, the static WireGuard parameters from vpnWireguard are saved and used.
When vpnWireguard.autoConfigEnable = true, static WireGuard parameters may remain saved in settings but are ignored at runtime; configuration is obtained from the service identity API in Overvis mode.
Number of unacknowledged events in the current power session
oldestSequence
number
yes
Sequence number of the oldest available event in the ring buffer. For UI pages showing the oldest events, this is the primary indication that the old edge of the window has actually moved because events were evicted.
lastSequence
number
yes
Sequence number of the newest event. The UI uses this field to detect new events: if the value has increased relative to the previously stored value, N = lastSequence_new - lastSequence_old new events have been added to the log. Fetching these N events is appropriate only if the current UI page contains the previously stored lastSequence (that is, the user is on the latest page where new entries appear); no updates are needed on other pages.
The first request uses page=1; subsequent requests use the cursor from the previous response.
The cursor prevents the server from rescanning records that have already been read,
which is especially important when filtering by severityMask.
{timestamp} {severity padded to 7} {dataType in brackets padded to 10}{detail}
The data-type field, including the square brackets and trailing spaces, occupies 10 characters: three spaces are added after [FAULT], and one after [GENERIC] and [NETWORK].
Factory calibration is managed as a single device-wide session. The session owns the measurement path, expires after 30 seconds of inactivity, and holds a RAM draft until commit. Successful status, range, capture, and commit operations extend the lease.
There are six independent slots: x24_p1 (50 Ω), x24_p2 (100 Ω), x24_p3 (200 Ω), x2_p1 (500 Ω), x2_p2 (1000 Ω), and x2_p3 (2000 Ω).
Each saved snapshot contains the applied absolute tolerance and the raw ADC values for four channels. The live resistance and verification values for the current slot are calculated only from its reference and captured ADC value: R = referenceOhm * ADC / capturedAdc. previewOhm, deltaOhm, and deltaPercent are calculated dynamically when the response is generated. Other slots do not participate in the calculation.
The Manufacturer Tool calculates the tolerance. At commit, the firmware receives the two final values, stores them as historical data, and does not determine whether the measurement complies with the specification.
Immediately after capture, the corresponding captures element already contains all snapshot fields. Until ten fresh verification windows have been processed, the verifyAdc, previewOhm, deltaOhm, and deltaPercent fields have zero values. Before commit, the tolerance field is null. Result readiness must be determined from the state: a completed snapshot is available after the transition from verify_capture to active.
The source data of a completed snapshot does not change until the same slot is captured again. Capturing another point does not invalidate completed snapshots.
The complete response contains all six snapshot keys and four channels within each snapshot. There is no top-level tolerance map. There are no scale or offset fields.
Observable active states are switching, active, and verify_capture. The internal model also includes committing and stopping, but commit and finish are processed synchronously, so status does not return these transitional states.
The Manufacturer Tool applies the tolerance for the current procedure from its configuration. For uncommitted captures elements, the tolerance field is null; after commit, each slot contains the historical tolerance supplied by the Tool.
live[].resistanceOhm has the type number|null: for an empty or incomplete draft, a resistance that cannot be calculated is serialized as null.
Starts the single calibration session from the saved point set. If the Flash record is missing or invalid, the session starts with an empty draft. The request body is not used.
Selects the gain and point. When the gain changes, the session transitions to switching until a fresh measurement window is published, confirming that the hardware path has been applied.
Saves the point set and all six completed, structurally valid snapshots. Reference resistances and ADC values must increase from p1 to p3; the ADC difference between each adjacent pair must be at least 5%. Before calling the endpoint, the Manufacturer Tool verifies that measurements are within tolerance.
toleranceOhm.x24 is written to the three slots in the x24 range, and toleranceOhm.x2 is written to the three slots in the x2 range. Both values must be finite positive numbers.
Repeating commit for the same saved revision within a session is idempotent. Missing, incomplete, or structurally invalid snapshots return 400 ERROR_INVALID_ARGUMENT. Exceeding the specified tolerance is not itself a firmware error.
A single record in internal Flash Sector 1 contains the service magic, format version, and CRC, while the nested Calibration_t contains the shared committedAt value and six calibration slots. Each slot stores capturedAt, referenceOhm, the historical toleranceOhm supplied at commit, and, for each channel, capturedAdc and verifyAdc. Derived measurement results are not stored in Flash. The current format version is 0x0600; records with other versions are not loaded and require recalibration. The report endpoint calculates the derived fields and serializes them on request; no separate report entity is stored.
During normal measurement, resistance is calculated using piecewise-linear interpolation. When ADC <= ADC(p2), coefficients derived from p1+p2 are used; for a higher ADC value, coefficients derived from p2+p3 are used. Beyond the outermost points, the nearest pair is used for extrapolation.
A storage error leaves the RAM session active for another commit attempt or an explicit finish. The previous Flash revision is not guaranteed to survive a power failure or programming error during erase/write. True old-or-new atomicity requires a second erase bank or a change to the Flash layout.
Empty or syntactically invalid JSON body → 400 ERROR_API_PARSING.
Missing fields or fields of an incorrect type → 400 ERROR_INVALID_ARGUMENT.
Invalid/expired sessionId or an operation in an invalid state → 400 ERROR_INVALID_VALUE.
Measurement path not ready during status or capture → 503 ERROR_NOT_READY.
Save failure during commit → 500 ERROR_IO.
Novatek-Electro TR-100E Documentation
Overvis Ownership Challenge
The challenge confirms physical access to the TR-100E when connecting the device to Overvis using a PIN code. The code is displayed on the device for no more than 5 minutes. The user can enter this code in Overvis or confirm the connection by selecting Yes on the TR-100E.
The code is runtime state: it is not saved to Flash/EEPROM and is not returned by the status API.
code is required and must contain 1 to 12 ASCII digits. The code is passed as a string to preserve leading zeros. A new request replaces any previous challenge and restarts the 300-second timer.
An empty body or invalid JSON returns 400 ERROR_API_PARSING. A missing field, an incorrect type, an empty string, or a code that is too long or contains non-digit characters returns 400 ERROR_INVALID_ARGUMENT. A validation error does not change the current challenge.
Retrieve a consistent snapshot of the challenge state.
Access: WireGuard only, Bearer/implicit (user). A request from the LAN returns 403 ERROR_NO_ACCESS.
Response 200:
{
"status": "accepted",
"remainingSec": 247
}
status
Meaning
idle
The challenge is absent or has been cleared
pending
The code is displayed, but no physical response has been received yet
accepted
The user selected Yes on the TR-100E
rejected
The user selected No on the TR-100E
remainingSec decreases from 300 to 1 for pending, accepted, and rejected; it is 0 for idle. The user’s response neither restarts nor stops the timer. After the original 300 seconds, the device automatically resets the challenge to idle.
After Yes is selected, the TR-100E displays a waiting screen until Overvis reads accepted and sends code: null. Clearing the challenge completes the UI flow and returns to the main screen.
If the user confirms ownership by entering the code in Overvis, the cloud service compares it with its original value and, after successful verification, sends code: null to remove the prompt from the display.
Novatek-Electro TR-100E Documentation
POST /api/service/firmware/apply/
Apply a previously uploaded and verified OTA image.
Before this endpoint is called, the OTA image must be uploaded and confirmed via POST /api/service/firmware/upload/finish/. The device will begin applying the update after reboot.
Novatek-Electro TR-100E Documentation
Firmware Upload Session
Uploading an .ota file is implemented as a sequential upload session in the OTA slot.
If the device private key or password has not been initialized yet, the API returns 503 ERROR_NOT_READY.
Initially populating an empty identity field is allowed without a service dongle.
Changing or clearing an already populated field requires the dongle and returns
an access error if it is absent. Submitting the existing value is not considered
an overwrite.
The actual SNTP synchronization is performed asynchronously. If NTP is disabled, lwIP/SNTP is not ready yet, or the synchronization request is rejected, the endpoint returns 503 ERROR_NOT_READY.
Novatek-Electro TR-100E Documentation
GET /api/debug/adc/, POST /api/debug/adc/start/, POST /api/debug/adc/stop/
Raw ADC data and intermediate measurement results for each channel. Intended for calibration and diagnostics.
Auth: Bearer (powerUser).
start and stop additionally require diagnostic mode to be active. No service key is required.
Calling this endpoint again restarts accumulation and filtering. The response contains the diagnostic object; ready=false until fresh, stable data becomes available.
Ends the test and restores the channel configuration from Settings. The request body is ignored. The mode also ends after 30 seconds without a GET /api/debug/adc/ request, or when diagnostic mode is exited.
Novatek-Electro TR-100E Documentation
POST /api/debug/display/start/ and POST /api/debug/display/stop/
Display test that temporarily overrides the normal image, contrast, and backlight.
The override is automatically disabled after 305 seconds, even if the client does not call stop.
Novatek-Electro TR-100E Documentation
GET /api/debug/external-storage/dump/
Streams a read-only dump of every byte in the installed external storage.
The firmware reads bounded chunks and does not allocate the complete dump in RAM.
Auth: Bearer (powerUser).
Mode: diagnostic mode must be active.
Content-Type:application/octet-stream.
Content-Disposition: attachment; filename=tr100e_external_storage.bin.
The response uses connection close to terminate the stream. A successful diagnostic
must receive exactly the sizeBytes reported by GET /api/debug/external-storage/. A storage read
error closes the stream early, producing a shorter dump. The endpoint never writes or
erases external storage.
Novatek-Electro TR-100E Documentation
GET /api/debug/external-storage/
External storage information: installed chip, capacity, and complete region map.
Size of the largest free block (fragmentation indicator)
rtos.smallestFreeBlockBytes
number
Size of the smallest free block
rtos.freeBlockCount
number
Number of free blocks
rtos.allocCount
number
Number of successful pvPortMalloc calls since startup
rtos.freeCount
number
Number of successful vPortFree calls since startup
lwip.totalBytes
number
Total lwIP heap size
lwip.freeBytes
number
Current free space in the lwIP heap
lwip.minEverFreeBytes
number
All-time minimum free space in the lwIP heap
When freeBytes > 0, the FreeRTOS heap fragmentation metric is 1 - largestFreeBlockBytes / freeBytes. If largestFreeBlockBytes is significantly smaller than freeBytes, a large allocation may fail despite sufficient total free memory. When freeBytes == 0, the Web UI reports 0% without evaluating the formula.
Novatek-Electro TR-100E Documentation
GET /api/debug/keyget/
Current state of the physical front-panel buttons.
Auth: Bearer (powerUser).
States are read directly from the hardware inputs. Virtual events submitted through POST /api/debug/keypress/ do not affect the response.
The core logic automatically restores normal mode after a timeout, even if the client does not call stop.
Novatek-Electro TR-100E Documentation
GET /api/debug/lwip-stats/
Snapshot of the lwIP stack’s internal counters: per-protocol statistics and memp pool state.
The data source is the global lwip_stats structure (lwip/stats.h). The available fields are determined by the *_STATS flags in lwipopts.h. If a flag is disabled, the corresponding key is omitted from the response.
Each group represents one protocol. A name is included only if the corresponding *_STATS = 1 in lwipopts.h.
Field
Type
Description
recv
number
Packets received
xmit
number
Packets transmitted
drop
number
Packets dropped
chkerr
number
Checksum errors
lenerr
number
Length errors
memerr
number
Memory allocation failures
rterr
number
Routing errors
proterr
number
Protocol errors
opterr
number
Option errors
err
number
Other errors
cachehit
number
etharp only: ARP cache hits
Possible proto keys: link, etharp, ip, icmp, udp, and tcp. (These correspond to the LINK_STATS, ETHARP_STATS, IP_STATS, ICMP_STATS, UDP_STATS, and TCP_STATS flags.)
Source of the current runtime settings: builtIn, bank1, or bank2
bootBank
number | null
Bank selected during a normal boot: 1, 2, or null if both banks are invalid
banks
array
State of the two physical settings banks
banks[].bank
number
Bank number: 1 or 2
banks[].valid
boolean
Result of full validation of the header, firmware version, length, and data CRC
banks[].sequence
number
Record sequence number; present only for a valid bank
banks[].isDefault
boolean
Whether the payload matches the effective factory settings; present only for a valid bank
banks[].savedAt
string | null
Save time in ISO 8601 UTC; present only for a valid bank
banks[].dataLength
number
Payload length; present only for a valid bank
banks[].dataCrc32
string
Payload CRC32 as eight hex characters; present only for a valid bank
banks[].headerCrc32
string
Header CRC32 as eight hex characters; present only for a valid bank
runtimeSource and bootBank may differ. For example, in diagnostic mode the runtime uses builtIn, while a normal boot selects the latest valid flash bank.
If both banks are valid, bootBank identifies the bank with the newer sequence, accounting for uint32_t wraparound. If the sequence values are equal, bank 1 is selected.
Header fields are not returned for an invalid bank because their values are not considered reliable.
The saved settings are considered factory settings if bootBank is not null and the specified bank has valid: true and isDefault: true. The other, older bank may contain custom settings and does not affect the result.
Novatek-Electro TR-100E Documentation
GET /api/debug/system/
General system diagnostics: RTC clocking, reset reason, and subsystem status.
temperature logger status indicator (on / off);
fault indicator (FAULT);
indicator of new events in the event log;
trend of channel temperature change (rising / falling / unchanged);
