IoT Agent for the Ultralight 2.0 protocol

Index

• Description
• Build & Install
• [API Overview] (#apioverview)
• [API Reference Documentation] (#apireference)
• [Development documentation] (#development)
• [Testing] (#testing)

Description

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 IoTA 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 Northbound APIs. Information about the IoTAgent's architecture can be found on that global repository. This documentation will only address those features and characteristics that are particular to the Ultralight 2.0 IoTAgent.

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

This project is part of FIWARE. Check also the FIWARE Catalogue entry for the IoTAgents

Running

git clone https://github.com/itmo-swm/fiware-iotagent-ul
cd fiware-iotagent-ul
docker-compose up -d

API Overview

An Overview of the API can be found in the User & Programmers Manual.

API Reference Documentation

Apiary reference for the Configuration API can be found here. More information about IoTAgents and their APIs can be found in the IoTAgent Library here.