Maintenance
This page describes common maintenance tasks, as well as procedures for recovering a device that is no longer accessible.
Only qualified personnel should carry out maintenance work on the device. Observe the safety notices.
Security recommendations
- Use the Admin user feature, to protect the device configuration and user data from unauthorized access. If you do, rotate the password regularly.
- Access the web interface and HTTP API endpoints via HTTPS, if possible, to secure the connection from your browser to the device. See Redirect HTTP requests to HTTPS to enforce this.
By default, the device uses a self-signed certificate for HTTPS connections. This is sufficient to encrypt the connection, but does not verify the identity of the device. You can also use a certificate signed by a trusted certificate authority (CA) or a custom self-signed certificate. See Server key and certificate for details.
- Use the HTTPS / TLS capabilities of features like MQTT to protect the data in transit.
- If using the API-Key feature, rotate it regularly on this device as well as on any other devices that use it (e.g., in the Box2Box configuration).
- If using certificates, keep them up to date. See Server key and certificate and CA certificates.
Configuration backup and restoration
The whole device configuration can be downloaded as a .txt file and uploaded again later to restore the device to a previously saved state.
Please refer to the General configuration page documentation for details.
Create a configuration backup before performing a firmware update, resetting the configuration, or replacing the device.
Resetting the configuration
Resetting the configuration restores the factory settings and cannot be undone.
Please refer to the General configuration page documentation for details.
If the web interface is not reachable, the configuration can also be reset with the physical reset button. See Recovering an unreachable device.
Resetting the configuration cannot be undone.
Resetting the configuration also makes peripheral history data permanently inaccessible.
Deleting peripheral history data
The device stores sensor history and past events in an internal database.
To delete sensor and event history while keeping the configuration, use the Clear database button described in the General configuration page documentation.
Deleting peripheral history data cannot be undone.
Before clearing the database, consider downloading the sensor history and past events as .csv data via the respective HTTP API method to keep a copy of the data.
Firmware updates
egnite regularly provides firmware updates. The currently active firmware version is displayed on the Firmware & Files configuration page.
Please refer to the Firmware configuration page docs for details on downloading and installing a firmware image.
Switching the firmware
The device stores the previously installed firmware as a fallback. If problems occur, e.g. after an update, you can switch back to it in two ways:
- On the Firmware & Files configuration page, use the rollback button. See Alternative firmware.
- With the on-device reset button, which also works when the web interface is not reachable. See Switch firmware.
Recovering an unreachable device
If the web interface cannot be reached, first check the status LED:
| Status LED | Meaning | Suggested action |
|---|---|---|
| Green, blinking every 10 s | Normal state | Check the network connection and the device's IP address. |
| Red, blinking every 1 s | Sensor or watchdog alarm | Check the connected sensors and the configured watchdogs. |
| Red, permanently | Potential firmware error | Switch the firmware using the reset button. |
If the firmware cannot be started or the configuration is corrupted, the reset button can be used to switch the firmware slot or to delete the configuration.
Refer to the the Hardware docs page for further details.
Deleting the configuration removes all settings and makes peripheral history data inaccessible. Create a configuration backup (does not include history data) beforehand, if possible.
Rebooting the system
The system can be rebooted either
- from the General configuration page, or
- by clicking on 'Reboot' on the bottom of the main menu in the sidebar.
- by pushing and releasing the physical reset button (max. 3 seconds). See Reset button.
Checking the device state
In addition to the status LED, the following information helps to assess the device state:
- The Memory section on the General configuration page shows the RAM and storage usage.
- The Syslog configuration page displays the last 8 Syslog messages, even without a configured Syslog server.
- The Dashboard shows current sensor readings, digital I/O and watchdog states.
For long-term monitoring of system events (not peripheral data), configure a Syslog server as described in the Syslog docs.
Checking connected sensors
If sensors are missing or readings are implausible, check the following:
- All cable connections are seated correctly.
- The total cable length is within the limits stated in the Hardware documentation.
- The sensor is configured in the web interface. See the Sensors documentation.
- The sensor chain does not exceed the maximum number of supported sensors.
Cleaning
Disconnect the device from the power supply before cleaning it.
You can carefully wipe the device down with a piece of soft, lint-free cotton cloth.
Should this not suffice, you can slightly damp the cloth with water before wiping the device down. In such a case, please ensure that the device has fully dried before reconnecting it to the power supply.
Please be aware that fumes from solvents can cause lasting damage to the device and/or any connected sensors. In case your device is heavily stained, we recommend sending it in for servicing.
Changing the buffer battery
The buffer battery supplies the internal real-time clock when the device is not powered. If the date and time are lost after each power cycle, the battery is likely depleted.
The location of the battery is shown in the device overview image on the hardware documentation page.
- Disconnect the device from the power supply.
- Unscrew the screws on the bottom of the device and remove the enclosure.
- Locate the buffer battery on the circuit board, remove and replace it with a replacement battery of the correct type.
The correct battery type is Renata CR1225 (coin cell, not rechargeable).
Do not use a battery of a different type, as this may damage the device or be unsafe.
Dispose of the old battery according to local regulations.
- Reassemble the enclosure and screw it back on.
- Reconnect the power supply.
- Set the date and time, or verify that NTP synchronization succeeded. See Date & Time settings.
Long-term storage and disposal
- Before storing the device for an extended period, disconnect it from the power supply and create a configuration backup.
- Store the device in a dry place, protected from dust and direct sunlight.
- Before disposing of the device, reset the configuration and delete peripheral history data to remove any sensitive data. See Resetting the configuration.
- Dispose of the device and the battery according to local regulations. Do not dispose of them with regular household waste.
Further support
If a problem cannot be resolved, contact egnite support and ideally provide the following information:
- Device type and firmware version (see Firmware & Files).
- Relevant Syslog messages (see Syslog).
- A description of the problem, including the status LED behavior and the conditions under which the problem occurs.
- A configuration backup can be useful in certain cases.