Everyware Software Framework Developer's Hub

Everyware Software Framework (ESF) is an enterprise-ready IoT Edge Framework distributed and supported by Eurotech. Based on Eclipse Kura, the open source Java/OSGi middleware for IoT gateways, ESF adds provisioning, advanced security, remote access, diagnostics monitoring. It supports ready-to-use field protocols (including Modbus, OPC-UA, S7, FANUC, J1939, J1979, BACnet, IEC 60870-5-101, IEC 60870-5-104, DNP3, M-bus), MQTT connectivity, and a web-based visual data flow programming to acquire data from the field, process it at the edge, and publish it to IoT Cloud Platforms. ESF features full remote device management through its integration with Everyware Cloud, Eurotech’s IoT Integration Platform.

Get Started

Snapshot Management

The overall configuration of ESF is stored in an XML file called a snapshot. This file includes all of the parameters for every service running in ESF. The original configuration file is named snapshot_0.xml. This section describes how snapshots may be used.

Each time a configuration change is made to one of the ESF components, a new XML file is created using the naming convention snapshot_[time as a long integer].xml. The nine most recent snapshots are saved, as well as the original snapshot 0.

How to Access Snapshots

To display snapshots using the Gateway Administration Console, select Settings from the System area, and then click on the Snapshots tab. The following three operations are available: Download, Upload and Apply, and Rollback.

How to Use Snapshots


The Download option provides the ability to save a snapshot XML file onto your computer. This file may then be edited, uploaded back to the device, or transferred to another equivalent device.

Upload and Apply

The Upload and Apply option provides the ability to import an XML file from your computer and upload it onto the device. This function updates every service in ESF with the parameters defined in the XML file.


Carefully select the file to be uploaded. An incorrect file may crash ESF and make it unresponsive.


The Rollback option provides the ability to restore the system to a previous configuration.

Updated about a year ago

Snapshot Management

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.