apinf / fiware-orion

FIWARE Orion Context Broker

Orion Context Broker

• Introduction
• GEi overall description
• Introductory presentations
• Build and Install
• Running
• API Overview
• API Walkthrough
• API Reference Documentation
• Testing
  • End-to-end tests
  • Unit Tests
• Advanced topics
• License
• Support

Introduction

This is the code repository for the Orion Context Broker, the reference implementation of the Publish/Subscribe Context Broker GE.

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

Any feedback on this documentation is highly welcome, including bugs, typos or things you think should be included but aren't. You can use github issues to provide feedback.

You can find the User & Programmer's Manual and the Installation & Administration Manual on readthedocs.io

For documentation previous to Orion 0.23.0 please check the manuals at FIWARE public wiki:

• Orion Context Broker - Installation and Administration Guide
• Orion Context Broker - User and Programmers Guide

Top

GEi overall description

Orion is a C++ implementation of the NGSIv2 REST API binding developed as a part of the FIWARE platform.

Orion Context Broker allows you to manage the entire lifecycle of context information including updates, queries, registrations and subscriptions. It is an NGSIv2 server implementation to manage context information and its availability. Using the Orion Context Broker, you are able to create context elements and manage them through updates and queries. In addition, you can subscribe to context information so when some condition occurs (e.g. the context elements have changed) you receive a notification. These usage scenarios and the Orion Context Broker features are described in this documentation.

If this is your first contact with the Orion Context Broker, it is highly recommended to have a look to the brief Quick Start guide.

Top

Introductory presentations

• Orion Context Broker (en) (jp)
• NGSIv2 Overview for Developers That Already Know NGSIv1 (en) (jp)

Top

Build and Install

Build and Install documentation for Orion Context Broker can be found at the corresponding section of the Admin Manual.

Top

Running

How to run Orion Context Broker can be found at the corresponding section of the Admin Manual.

Top

API Overview

In order to create an entity (Room1) with two attributes (temperature and pressure):

curl <orion_host>:1026/v2/entities -s -S --header 'Content-Type: application/json' \
    -X POST -d @- <<EOF
{
  "id": "Room2",
  "type": "Room",
  "temperature": {
    "value": 23,
    "type": "Number"
  },
  "pressure": {
    "value": 720,
    "type": "Number"
  }
}
EOF

In order to query the entity:

curl <orion_host>:1026/v2/entities/Room2 -s -S --header 'Accept: application/json' | python -mjson.tool

In order to update one of the entity atributes (temperature):

curl <orion_host>:1026/v2/entities/Room2/attrs/temperature -s -S \
    --header 'Content-Type: application/json' \
    -X PUT -d @- <<EOF
{
  "value": 26.3,
  "type": "Number"
}
EOF

or (more compact):

curl <orion_host>:1026/v2/entities/Room2/attrs/temperature/value -s -S \
    --header 'Content-Type: text/plain' \
    -X PUT -d 26.3

Please have a look at the Quick Start guide if you want to test these operations in an actual public instance of Orion Context Broker. In addition, have a look to the API Walkthrough and API Reference sections below in order to know more details about the API (subscriptions, registrations, etc.).

Top

API Walkthrough

• FIWARE NGSI v1 (Markdown)
• FIWARE NGSI v2 (Markdown) - release candidate
• FIWARE NGSI v2 (Apiary) - release candidate
  • See also NGSIv2 implementation notes

Top

API Reference Documentation

• FIWARE NGSI v1 (XSD and PDF)
• FIWARE NGSI v2 (Apiary) - release candidate
  • See also NGSIv2 implementation notes

Top

Testing

End-to-end tests

The functional_test makefile target is used for running end-to-end tests:

make functional_test INSTALL_DIR=~

Please have a look to the section on building the source code in order to get more information about how to prepare the environment to run the functional_test target.

Unit Tests

The unit_test makefile target is used for running the unit tests:

make unit_test

Please have a look to the section on building the source code in order to get more information about how to prepare the environment to run the unit_test target.

Top

Advanced topics

• Advanced Programming
• Installation and administration
• Container-based deployment
  • Docker
  • Docker Swarm and HA
• Development Manual
• Sample code contributions
• Contribution guidelines, especially important if you plan to contribute with code to Orion Context Broker
• Deprecated features

Top

License

Orion Context Broker is licensed under Affero General Public License (GPL) version 3.

Top

Support

Ask your thorough programming questions using stackoverflow and your general questions on FIWARE Q&A. In both cases please use the tag fiware-orion

Top