Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/telefonicaid/fiware-orion
Context Broker and CEF building block for context data management, providing NGSI interfaces.
https://github.com/telefonicaid/fiware-orion
context-information-management data fiware fiware-ngsi fiware-orion orion-context-broker
Last synced: about 1 month ago
JSON representation
Context Broker and CEF building block for context data management, providing NGSI interfaces.
- Host: GitHub
- URL: https://github.com/telefonicaid/fiware-orion
- Owner: telefonicaid
- License: agpl-3.0
- Created: 2013-09-13T11:55:25.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T16:43:17.000Z (about 1 month ago)
- Last Synced: 2024-05-22T18:46:41.216Z (about 1 month ago)
- Topics: context-information-management, data, fiware, fiware-ngsi, fiware-orion, orion-context-broker
- Language: C++
- Homepage: https://fiware-orion.rtfd.io/
- Size: 47.2 MB
- Stars: 210
- Watchers: 48
- Forks: 261
- Open Issues: 361
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES_NEXT_RELEASE
- License: LICENSE
Lists
- awesome - Orion - A context broker which holds information about the current context. (FIWARE Catalogue / Core Context Management)
README
[](https://www.fiware.org/developers/catalogue/)
[](https://opensource.org/licenses/AGPL-3.0)
[](https://quay.io/repository/fiware/orion)
[](https://registry.hub.docker.com/r/telefonicaiot/fiware-orion)
[](http://stackoverflow.com/questions/tagged/fiware-orion)
[](doc/manuals/orion-api.md)
[](https://fiware-orion.rtfd.io)
[](https://bestpractices.coreinfrastructure.org/projects/4520)
The Orion Context Broker is an implementation of the Publish/Subscribe Context
Broker GE, providing an
[NGSI interface](https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals/orion-api.md). Using this interface, clients can do several operations:
- Query context information. The Orion Context Broker stores context
information updated from applications, so queries are resolved based
on that information. Context information consists on *entities* (e.g. a car)
and their *attributes* (e.g. the speed or location of the car).
- Update context information, e.g. send updates of temperature
- Get notified when changes on context information take place (e.g. the
temperature has changed)
- Register context provider applications, e.g. the provider for the temperature sensor within a
room
This project is part of [FIWARE](https://www.fiware.org/). For more information
check the FIWARE Catalogue entry for
[Core Context Management](https://github.com/Fiware/catalogue/tree/master/core).
| :books: [Documentation](https://fiware-orion.rtfd.io) | :mortar_board: [Academy](https://fiware-academy.readthedocs.io/en/latest/core/orion) | 
[quay.io](https://quay.io/repository/fiware/orion) | :whale: [Docker Hub](https://registry.hub.docker.com/r/telefonicaiot/fiware-orion) | :dart: [Roadmap](doc/roadmap.md) |
|---|---|---|---|--|
## Content
- [Background](#background)
- [Description](#gei-overall-description)
- [Introductory presentations](#introductory-presentations)
- [Install](#install)
- [Running](#running)
- [Usage](#usage)
- [API Walkthrough](#api-walkthrough)
- [API Reference Documentation](#api-reference-documentation)
- [Testing](#testing)
- [End-to-end tests](#end-to-end-tests)
- [Unit Tests](#unit-tests)
- [Advanced topics](#advanced-topics)
- [Support](#support)
- [License](#license)
## Background
You can find the User & Programmer's Manual and the Installation &
Administration Manual on [readthedocs.io](https://fiware-orion.readthedocs.io)
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](https://github.com/telefonicaid/fiware-orion/issues/new/choose) to
provide feedback.
[Top](#top)
### 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.
Context information consists on *entities* (e.g. a car) and their *attributes*
(e.g. the speed or location of the car).
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](doc/manuals/quick_start_guide.md).
[Top](#top)
### Introductory presentations
- Orion Context Broker
[(en)](https://www.slideshare.net/slideshows/orion-context-broker-introduction-20240115/265436732)
[(jp)](https://www.slideshare.net/slideshows/orion-context-broker-20240116/265462443)
- NGSIv2 Overview for Developers That Already Know NGSIv1
[(en)](https://www.slideshare.net/fermingalan/orion-context-broker-ngsiv2-overview-for-developers-that-already-know-ngsiv1-20220523)
[(jp)](https://www.slideshare.net/fisuda/orion-context-broker-ngsiv2-overview-for-developers-that-already-know-ngsiv1-20220526)
(no longer maintained since Orion 3.7.0)
[Top](#top)
## Install
Build and Install documentation for Orion Context Broker can be found at
[the corresponding section of the Admin Manual](doc/manuals/admin/install.md).
> :point_right: If you want to run a production-grade instance of orion, carefully read all information in the [admin-section](doc/manuals/admin).
[Top](#top)
## Running
How to run Orion Context Broker can be found at
[this document](docker/README.md).
[Top](#top)
## Usage
In order to create an entity (Room1) with two attributes (temperature and
pressure):
```console
curl :1026/v2/entities -s -S --header 'Content-Type: application/json' \
-X POST -d @- <:1026/v2/entities/Room2 -s -S --header 'Accept: application/json' | python -mjson.tool
```
In order to update one of the entity atributes (temperature):
```console
curl :1026/v2/entities/Room2/attrs/temperature -s -S \
--header 'Content-Type: application/json' \
-X PUT -d @- <: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](doc/manuals/quick_start_guide.md)
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](#top)
## API Walkthrough
- FIWARE NGSIv2 Orion API Walkthrough FIWARE NGSI v2 [(en)](doc/manuals/user/walkthrough_apiv2.md)
[(jp)](doc/manuals.jp/user/walkthrough_apiv2.md) (Markdown)
[Top](#top)
## API Reference Documentation
API Reference Documentation:
- FIWARE NGSIv2 Orion API
[(en)](doc/manuals/orion-api.md)
[(jp)](doc/manuals.jp/orion-api.md) (Markdown)
Orion Reference Documentation:
- Orion Manuals in RTD [(en)](https://fiware-orion.readthedocs.org)
[(jp)](https://fiware-orion.letsfiware.jp/)
[Top](#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](doc/manuals/admin/build_source.md) 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](doc/manuals/admin/build_source.md) in order to get
more information about how to prepare the environment to run the unit_test
target.
[Top](#top)
## Advanced topics
- Advanced Programming [(en)](doc/manuals/user/README.md)
[(jp)](doc/manuals.jp/user/README.md)
- Installation and administration [(en)](doc/manuals/admin/README.md)
[(jp)](doc/manuals.jp/admin/README.md)
- Container-based deployment
- Docker [(en)](docker/README.md) [(jp)](docker/README.jp.md)
- Docker Swarm and HA [(en)](docker/docker_swarm.md)
[(jp)](docker/docker_swarm.jp.md)
- Development Manual [(en)](doc/manuals/devel/README.md)
[(jp)](doc/manuals.jp/devel/README.md)
- Sample code contributions [(en)](doc/manuals/devel/code_contributions.md)
[(jp)](doc/manuals.jp/devel/code_contributions.md)
- Contribution guidelines [(en)](doc/manuals/devel/contribution_guidelines.md)
[(jp)](doc/manuals.jp/devel/contribution_guidelines.md), especially important if
you plan to contribute with code to Orion Context Broker
- Deprecated features [(en)](doc/manuals/deprecated.md)
[(jp)](doc/manuals.jp/deprecated.md)
[Top](#top)
## Support
Ask your thorough programming questions using
[stackoverflow](http://stackoverflow.com/questions/ask) and your general
questions on [FIWARE Q&A](https://ask.fiware.org). In both cases please use the
tag `fiware-orion`
[Top](#top)
---
## License
Orion Context Broker is licensed under [Affero General Public License (GPL)
version 3](./LICENSE).
© 2024 Telefonica Investigación y Desarrollo, S.A.U
Further information on the use of the AGPL open source license
### Are there any legal issues with AGPL 3.0? Is it safe for me to use?
There is absolutely no problem in using a product licensed under AGPL 3.0. Issues with GPL
(or AGPL) licenses are mostly related with the fact that different people assign different
interpretations on the meaning of the term “derivate work” used in these licenses. Due to this,
some people believe that there is a risk in just _using_ software under GPL or AGPL licenses
(even without _modifying_ it).
For the avoidance of doubt, the owners of this software licensed under an AGPL-3.0 license
wish to make a clarifying public statement as follows:
> Please note that software derived as a result of modifying the source code of this
> software in order to fix a bug or incorporate enhancements is considered a derivative
> work of the product. Software that merely uses or aggregates (i.e. links to) an otherwise
> unmodified version of existing software is not considered a derivative work, and therefore
> it does not need to be released as under the same license, or even released as open source.