IoT Agent for the Ultralight 2.0 protocol

An Internet of Things Agent for the Ultralight 2.0 protocol (with AMQP, HTTP and MQTT transports). This IoT Agent is designed to be a bridge between Ultralight and the NGSI interface of a context broker.

It is based on the IoT Agent Node.js Library. Further general information about the FIWARE IoT Agents framework, its architecture and the common interaction model can be found in the library's GitHub repository.

This project is part of FIWARE. For more information check the FIWARE Catalogue entry for the IoT Agents.

Contents

• Background
• Install
• Usage
• API
• Contributing
• Testing
• License

Background

This Internet of Things Agent is a bridge that can be used to communicate devices using the Ultralight 2.0 protocol and NGSI Context Brokers (like Orion). Ultralight 2.0 is a lightweight text based protocol aimed to constrained devices and communications where the bandwidth and device memory may be limited resources. This IoT Agent will provide different transport protocol bindings for the same protocol: HTTP, MQTT...

As is the case in any IoT Agent, this one follows the interaction model defined in the Node.js IoT Agent Library, that is used for the implementation of the APIs found on the IoT Agent's North Port. Information about the architecture of the IoT Agent can be found on that global repository. This documentation will only address those features and characteristics that are particular to the Ultralight 2.0 IoT Agent.

Additional information about operating the component can be found in the Operations: logs and alarms document.

Install

Information about how to install the IoT Agent for Ultralight can be found at the corresponding section of the Installation & Administration Guide.

A Dockerfile is also available for your use - further information can be found here

Usage

Information about how to use the IoT Agent can be found in the User & Programmers Manual.

The following features are listed as deprecated.

API

Apiary reference for the Configuration API can be found here. More information about IoT Agents and their APIs can be found in the IoT Agent Library documentation.

The latest IoT Agent for Ultralight documentation is also available on ReadtheDocs

Contributing

If you'd like to contribute, start by searching through the issues and pull requests to see whether someone else has raised a similar idea or question.

Before contributing, please check out contribution guidelines

Testing

Mocha Test Runner + Should.js Assertion Library.

The test environment is preconfigured to run BDD testing style.

Module mocking during testing can be done with proxyquire

In order to successfuly run the tests, on the local machine three services must be running:

• mosquitto MQTT v5 broker;
• mongo Database;
• rabbitmq AMQP broker/server;

They can be run using Docker:

docker pull eclipse-mosquitto
docker pull mongo
docker pull rabbitmq

docker run -d -p 1883:1883   -l mosquitto eclipse-mosquitto
docker run -d -p 27017:27017 -l mongodb mongo
docker run -d -p 5672:5672   -l rabbitmq rabbitmq

The required libraries, if missing, can be installed with:

npm install

To run tests, type

npm test

License

The IoT Agent for Ultralight is licensed under Affero General Public License (GPL) version 3.

© 2022 Telefonica Investigación y Desarrollo, S.A.U

Are there any legal issues with AGPL 3.0? Is it safe for me to use?

There is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL (or AGPL) licenses are mostly related with the fact that different people assign different interpretations on the meaning of the term “derivate work” used in these licenses. Due to this, some people believe that there is a risk in just using software under GPL or AGPL licenses (even without modifying it).

For the avoidance of doubt, the owners of this software licensed under an AGPL-3.0 license wish to make a clarifying public statement as follows:

Please note that software derived as a result of modifying the source code of this software in order to fix a bug or incorporate enhancements is considered a derivative work of the product. Software that merely uses or aggregates (i.e. links to) an otherwise unmodified version of existing software is not considered a derivative work, and therefore it does not need to be released as under the same license, or even released as open source.