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

User Guide

This guide will illustrate the steps required for configuring an application that uses the new Cloud Connection APIs to publish messages to the Kapua platform.

Cloud Connection Instantiation and Configuration

To create a new Cloud Connection, open the Cloud Connections section of the Web UI:

Create a new Cloud Connection by clicking on the New Connection button and entering a new unique identifier in the Cloud Connection Service PID field. The identifier must be a valid kura.service.pid and, in case of a Kapua Cloud Connection, it must start with the org.eclipse.kura.cloud.CloudService- prefix. A valid identifier can be org.eclipse.kura.cloud.CloudService-KAPUA. As an alternative, it is possible to reconfigure the existing org.eclipse.kura.cloud.CloudService Cloud Connection.

Configure the MQTTDataTrasport service.

Click on the MQTTDataTrasport-KAPUA tab and fill the parameters required for establishing the MQTT connection:

  • Broker-url
  • Topic Context Account-Name
  • Username
  • Password

Finally, configure the DataService-KAPUA service.

In order to enable automatic connection, set the Connect Auto-on-startup parameter to true

Publisher Instantiation and Configuration

  1. Select to the connection to be used from the list.
  2. Click on the New Pub/Sub button.
  1. Select the type of component to be created, from the Available Publisher/Subscriber factories drop down list, in order to create a Publisher
    select the org.eclipse.kura.cloud.publisher.CloudPublisher entry.
  2. Enter an unique kura.service.pid identifier in the New Publisher/Subscriber PID field.
  3. Click Apply, you should see the publisher configuration
  1. Select and configure the newly created publisher instance, and then click Apply

Binding an Application to the Publisher

  1. Select the application instance configuration
  2. Find the configuration entry that represents a Publisher reference.
  3. Click on the Select available targets link and select the desired Publisher instance to bind to.
  1. Click on Apply

Updated about a year ago

User Guide

Suggested Edits are limited on API Reference Pages

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