NGSI-JS Library.

Introduction

The NGSI library for JavaScript environment is a software tool with the aim of transforming JSON entities to NGSI data models, which can be manipulated or operated by the FIWARE Orion Context Broker. This library can be implemented in applications through Node.js execution environment, such as RESTFul web services or backend.

The NGSI JavaScript Library is composed of two npm modules:

NGSI-parser module

NGSI-parser module analyzes the syntax of non-structured JSON objects to transform them into FIWARE-NGSI v2 context entities.

ngsi-parser repository

OCB-sender module

OCB-sender manipulates FIWARE-NGSI v2 context entities with the aim of send them to the FIWARE Orion Context Broker and, in this way make operations with them.

ocb-sender repository

Installation pre-requirements and requirements

• For the pre-requirements of installation, refer to the Pre-requirements section.
• For the installation of ngsi-parser npm module, refer to the documentation of this module in the How to Install section.
• For the installation of ocb-sender npm module, refer to the documentation of this module in the How to Install section.

Modules usage

ngsi-parser module

• Refer to the ngsi-parser section for the more information about functionalities of this module and how to implement them.

ocb-sender module

• Refer to the ocb-sender section for the more information about functionalities of this module and how to implement them.

Examples

• In the Examples of both modules usage section refer information about how to use functionalities of both module together.

Important reminder about clone this GIT repository

In order to clone this repository its necessary execute git clone --recursive command, to download the code and resources of submodules ngsi-parser and ocb-sender.

git clone --recursive https://github.com/cenidetiot/ngsi-js-library.git

Documentation Links:

• Read the docs
• Github pages