We use proprietary and third party's cookies to improve your experience and our services, identifying your Internet Browsing preferences on our website; develop analytic activities and display advertising based on your preferences. If you keep browsing, you accept its use. You can get more information on our Cookie Policy
Cookies Policy
D.5.4.3 User and Programmers Guide front page - FIWARE Forge Wiki

D.5.4.3 User and Programmers Guide front page

From FIWARE Forge Wiki

Jump to: navigation, search

Private Public Partnership Project (PPP)
Large-scale Integrated Project (IP)


D.5.4.3: FI-WARE User and Programmers Guide

Project acronym: FI-WARE
Project full title: Future Internet Core Platform
Contract No.: 285248
Strategic Objective: FI.ICT-2011.1.7 Technology foundation: Future Internet Core Platform
Project Document Number: ICT-2011-FI-285248-WP5-D.5.4.3
Project Document Date: 2014-08-27
Deliverable Type and Security: Public
Author: FI-WARE Consortium
Contributors: FI-WARE Consortium

Executive Summary

This document contains the User and Programmers guide of the IoT technical chapter in FI-WARE. The purpose of this manual is twofold:

  • Provide the users with insights in the functionality of each GE and how to use it
  • Provide the developers with the right pointers to develop using the Open Specifications

About This Document

This document comes along with the Software implementation of components, each release of the document being referred to the corresponding Software release (as per D.x.3), to provide documentation of the features offered by the components and interfaces to users/adopters. Moreover, it explains the way they can be exploited in their developments.

Intended Audience

The document targets users as well as programmers of FI-WARE Generic Enablers.

Chapter Context

FI-WARE will build the relevant Generic Enablers for Internet of Things Service Enablement, in order for things to become citizens of the Internet–available, searchable, accessible, and usable – and for FI services to create value from real-world interaction enabled by the ubiquity of heterogeneous and resource-constrained devices.

From a physical standpoint, IoT enablers have been spread in two different domains:

  • FI-WARE IoT Gateway. A hardware device hosting a number of features of one or several Gateway Generic Enablers of the IoT Service Enablement. It is usually located at proximity of the devices (sensors/actuators) to be connected. In the FI-WARE IoT model, the IoT Gateway is an optional element aiming to optimize the network traffic sent to the Backend and IoT services efficiency and reliability. Zero, one or more IoT Gateways can be part of a FI-WARE IoT setting. Several m2m technologies introduce specific gateway devices too, where it is not feasible to install FI-WARE gateway features. Those gateways are considered plain devices grouping other devices and not FI-WARE IoT Gateways.
  • FI-WARE IoT Backend. A setting in the cloud hosting a number of features of one or several Generic Enablers of the IoT Service Enablement. It is typically part of a FI-WARE platform instance in a Datacenter. In the FI-WARE IoT model, a single IoT Backend is mandatory and it is connected to all IoT end devices either via IoT Gateway(s) and/or straight interfaces. Normally, during FI-WARE Releases R1 and R3 timeframes, the Backend will refer to the IoT Backend enablers installed in the FI-WARE Testbed or Open Innovation Lab (OIL), as described in the project Catalogue.

A key design statement is that, whenever present, IoT Gateways are not expected to be permanently connected to the Backend as per communications design or failures. Another relevant remark is that IoT Gateways are expected to be constrained devices in some scenarios. Therefore, light-weight implementations of the same GEs plus additional GEs interfaces helping to save unnecessary features/GEs are specially considered in the Gateway domain.

From the functionality point of view, FI-WARE IoT design aims to expose the "Things" abstraction to services developers, cope with different vertical m2m applications and provide a uniform access to heterogeneous m2m hardware and protocols. There is a number IoT features which are somehow duplicated in the Backend and the gateway domains in order to fulfill the goals and statements described above. For instance, a CEP engine at the Gateway level reduces the network overload and improves condition-based-events triggering time. Application developers will be able to access Things and devices observation and control interfaces in two ways:

  • Directly, by using Northbound IoT interfaces as described in this Wiki.
  • Throughout Data/Context GEs, by configuring Backend IoT GEs (IoT Broker) as NGSI notifications Context Providers of Data/Context Publish-Subscribe-Context-Broker GE.

Nota Bene: For the reader, we are using in the following chapters the same vocabulary as in the FI-Ware Product Vision chapter:

  • Thing. Physical object, living organism, person or concept interesting from the perspective of an application.
  • Device. Hardware entity, component or system that either measures properties of a thing/group of things or influences the properties of a thing/group of things or both measures/influences. Sensors and actuators are devices.
  • IoT Resource. Computational elements (software) that provide the technical means to perform sensing and/or actuation on the device. The resource is usually hosted on the device.

More information about the IoT Service Enablement Chapter and FI-WARE in general can be found within the following pages:


Structure of this Document

The document is generated out of a set of documents provided in the public FI-WARE wiki. For the current version of the documents, please visit the public wiki at http://wiki.fi-ware.eu/

The following resources were used to generate this document:

Backend IoT Broker - IoT Broker - User and Programmers Guide
Publish/Subscribe Broker - Orion Context Broker - User and Programmers Guide (This Data/Context Management chapter GE can be configured as Configuration Manager - Orion Context Broker)
Configuration Manager - IoT Discovery - User and Programmers Guide
Backend Device Manager - IDAS - User and Programmers Guide
Gateway Device Manager - OpenMTC - User and Programmers Guide
Gateway Protocol Adapter - ZPA - User and Programmers Guide
Gateway Protocol Adapter - EPCGE - User and Programmers Guide
Gateway Data Handling - Esper4FastData - User and Programmers Guide
Template Handler - Template Handler - User and Programmers Guide

Typographical Conventions

Starting with October 2012 the FI-WARE project improved the quality and streamlined the submission process for deliverables, generated out of our wikis. The project is currently working on the migration of as many deliverables as possible towards the new system.

This document is rendered with semi-automatic scripts out of a MediaWiki system operated by the FI-WARE consortium.

Links within this document

The links within this document point towards the wiki where the content was rendered from. You can browse these links in order to find the "current" status of the particular content.

Due to technical reasons part of the links contained in the deliverables generated from wiki pages cannot be rendered to fully working links. This happens for instance when a wiki page references a section within the same wiki page (but there are other cases). In such scenarios we preserve a link for readability purposes but this points to an explanatory page, not the original target page.

In such cases where you find links that do not actually point to the original location, we encourage you to visit the source pages to get all the source information in its original form. Most of the links are however correct and this impacts a small fraction of those in our deliverables.


Figures are mainly inserted within the wiki as the following one:


Only if the wiki-page uses this format, the related caption is applied on the printed document. As currently this format is not used consistently within the wiki, please understand that the rendered pages have different caption layouts and different caption formats in general. Due to technical reasons the caption can't be numbered automatically.

Sample software code

Sample API-calls may be inserted like the following one.



The current document has been elaborated using a number of collaborative tools, with the participation of Working Package Leaders and Architects as well as those partners in their teams they have decided to involve.

Keyword list

FI-WARE, PPP, Architecture Board, Steering Board, Roadmap, Reference Architecture, Generic Enabler, Open Specifications, I2ND, Cloud, IoT, Data/Context Management, Applications/Services Ecosystem, Delivery Framework , Security, Developers Community and Tools , ICT, es.Internet, Latin American Platforms, Cloud Edge, Cloud Proxy.

Changes History

Release Major changes description Date Editor
v1 First draft of deliverable submission generated 2014-07-22 TID
v2 First draft of deliverable submission generated 2014-08-27 TID

Table of Contents

FIWARE WIKI editorial remark:
In the final deliverable, somebody would include the TOC here
Personal tools
Create a book