This is a mirror repo. Please fork from https://github.com/telefonicaid/iotagent-ul
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
docs
ghpages
lib Updates dependencies, passes tests and removes grunt Nov 3, 2018
rpm
template
test
.dockerignore
.gitignore
.jshintrc
.travis.yml
CHANGES_NEXT_RELEASE
ContributionPolicy.txt
Dockerfile
LICENSE
README.md
client-config.js
config.js
index.js
mkdocs.yml
package.json
sonar-project.properties

README.md

IoT Agent for the Ultralight 2.0 protocol

FIWARE IoT Agents License: APGL Docker badge Support badge
Documentation badge Status

Index

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 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.

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

Installation

Information about how to install the UL IoTAgent can be found at the corresponding section of the Installation & Administration Guide.

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.

Development documentation

Information about developing for the UL IoTAgent can be found at the corresponding section of the User & Programmers Manual.

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

To run tests, type

npm test