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), 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

Getting Started

Verify ESF Installation

For most Eurotech gateways, ESF will be pre-installed and automatically started on system start up. ESF is also monitored by the Monit utility; if the ESF Java process is terminated for some reason, Monit will attempt to restart ESF.

There are a few necessary steps to ensure that ESF is running as expected. First, verify that the Java process is running with the following command:

ps aux | grep java

This command should find a process with multiple arguments passed to the JVM. For most ESF-powered gateways, this will be the only Java process running. If there are multiple Java processes, the ESF process can be identified by searching for arguments assigned with "/opt/eurotech".

While there may be multiple Java processes running, and even multiple OSGi containers running, there can be only one ESF process. If multiple ESF processes are detected, the unit should be restarted.

Once the ESF process has been identified, it is important to check the ESF log files for errors. The first log file, located at /var/log/kura-console.log, logs results from the output of the OSGi process. Errors in this log file often indicate critical startup or runtime errors in the framework.

The second log file, located at /var/log/kura.log, logs results from the sl4j bundle within ESF. Information in this log file is reported from logging statements within the ESF framework.

If the ESF process is running and the logs files are clear of errors, the ESF framework is working correctly on the target system.

ESF Installation

This section provides instructions for installing ESF manually. The following steps outline how to install ESF on a Raspberry Pi.