These docs are for v5.0.0. Click to read the latest docs for v7.6.0.

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.

Installing ESF with Debian Package

To install ESF on a Raspberry Pi, first make sure the device has the latest Raspbian image. Once the image is installed, boot the device and start a shell session.

ESF requires Oracle Java VM or Open JDK to be installed on the target device. Verify that Java 8 or above is installed with the following command:

java -version

If not, install it with the following command:

sudo apt-get install java

With Java installed, visit the ESF download page and locate the correct Debian package for the target system. Download the package and copy to the the Raspberry Pi.

Once the package is on the target device, ESF can be installed with the following command:

🚧

The first two 'apt-get' steps will update and upgrade the system. Skipping these steps may lead to unexpected installation problems.

🚧

The installation process will attempt to remove previously installed versions of ESF. It is important not to run ESF during installation.

sudo apt-get update
sudo apt-get upgrade
sudo dpkg -i kura_*.deb
sudo apt-get install -f
sudo reboot

Once the Raspberry Pi has finished rebooting, verify that ESF is running as expected.

Installing ESF with Shell Script

For non-Debian based systems, ESF is installed with a shell script. Visit the ESF download page to find the correct installation file for the target system.

Once the installation file has been copied to the target system, ESF can be installed with the following command:

🚧

The installation process will attempt to remove previously installed versions of ESF. It is important not to run ESF during installation.

sudo ./esf_*_installer.sh
sudo reboot

Once the target device has finished rebooting, verify that ESF is running as expected.