Skip to content

FIWARE IoT Agent for LoRaWAN protocol (with CayenneLpp and CBOR data models)

License

Notifications You must be signed in to change notification settings

SaxionSmartCities/IoTagent-LoRaWAN

 
 

Repository files navigation

FIWARE IoT Agent for the LoRaWaN Protocol

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

The Internet of Things Agent for LoRaWAN protocol enables data and commands to be exchanged between IoT devices and the NGSI interface of a context broker using the LoRaWAN protocol.

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

Architecture

As explained in What is LoRaWAN™, the proposed Network Architecture for a LoRaWAN based system relies on a mesh network architecture composed of End nodes, Concentrators, Network Servers and Application Servers. This IoTA is fully compliant with this architecture, providing interoperability between FIWARE NGSI Context Brokers and LoRaWAN devices.

General

Supported stacks

Data models

  • CayenneLpp
  • CBOR
  • Proprietary format decoded by LoRaWAN application server.

Install

Requirements

Cloning the Github repository

  1. Clone the repository with the following command:
git clone https://github.com/Atos-Research-and-Innovation/IoTagent-LoRaWAN.git
  1. Once the repository is cloned, you have to download the dependencies for the project, and let it ready to the execution. From the root folder of the project execute:
npm install
  1. Launch the IoT Agent with the default configuration
node bin/iotagent-lora

You can use a custom configuration file:

node bin/iotagent-lora custom_config.js

The bootstrap process should finish with:

info: Loading devices from registry
info: LoRaWAN IoT Agent started
  1. Check that the IoTA is running correctly:
curl -v http://localhost:4061/iot/about

The result must be similar to:

{ "libVersion": "2.6.0-next", "port": 4061, "baseRoot": "/" }

Using Docker

A ready to use Docker image is provided

docker run -p 4061:4061 ioeari/iotagent-lora

Using Docker-compose

This project contains an example to deploy the IoTA and all the requirement using docker-compose.

docker-compose -f docker/docker-compose.yml up

Usage

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

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.

Quality Assurance

This project is part of FIWARE and has been rated as follows:

  • Version Tested:
  • Documentation:
  • Responsiveness:
  • FIWARE Testing:

License

FIWARE IoT Agent for LoRaWAN protocol is licensed under Affero General Public License (GPL) version 3.

© 2019 Atos Spain S.A

The following third-party library is used under license:

  1. iotagent-node-lib - AGPL © 2014-2019 Telefonica Investigación y Desarrollo

About

FIWARE IoT Agent for LoRaWAN protocol (with CayenneLpp and CBOR data models)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 98.7%
  • Dockerfile 1.3%