telefonicaiot/fiware-orion

Orion Context Broker

概述和主要用途

Orion Context Broker是FIWARE平台的核心组件，实现了发布/订阅上下文 broker GE（Generic Enabler），提供NGSIv2 REST API接口。它用于管理上下文信息的全生命周期，包括查询、更新、订阅和注册上下文数据。上下文信息由“实体”（如汽车、房间）及其“属性”（如速度、温度）组成，适用于需要实时上下文管理的场景，如物联网、智能城市、工业监控等。

核心功能和特性

• 查询上下文信息：基于存储的上下文数据解析查询请求，获取实体及其属性信息。
• 更新上下文信息：支持实体属性值的更新，如温度、位置等实时数据。
• 上下文变化通知：当上下文信息发生变化（如温度阈值触发）时，向订阅者发送通知。
• 注册上下文提供者：允许外部应用注册为特定实体或属性的上下文信息提供者。

使用场景和适用范围

• 物联网设备管理：监控和管理传感器数据（如温度、湿度传感器）。
• 智能城市：管理交通流量、公共设施状态等上下文信息。
• 工业监控：实时跟踪生产设备状态、环境参数等。
• 上下文感知应用：需动态获取、更新和响应实体状态变化的各类系统。

使用方法和配置说明

前提条件

Orion Context Broker依赖MongoDB作为后端数据库，部署前需确保MongoDB服务可用。

Docker部署示例

1. 启动MongoDB容器

console
docker run -d --name mongodb -p 27017:27017 mongo:4.4 --nojournal

2. 启动Orion容器（链接MongoDB）

console
docker run -d --name orion -p 1026:1026 --link mongodb:mongodb telefonicaiot/fiware-orion -dbhost mongodb

3. Docker Compose配置

创建docker-compose.yml文件：

yaml
version: '3'
services:
  mongodb:
    image: mongo:4.4
    command: --nojournal
    ports:
      - "27017:27017"
  orion:
    image: telefonicaiot/fiware-orion
    ports:
      - "1026:1026"
    depends_on:
      - mongodb
    command: -dbhost mongodb

启动服务：

console
docker-compose up -d

基本操作示例

创建实体

创建名为“Room2”的房间实体，包含温度和压力属性：

console
curl localhost: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

查询实体

查询“Room2”实体信息：

console
curl localhost:1026/v2/entities/Room2 -s -S --header 'Accept: application/json' | python -m json.tool

更新实体属性

更新“Room2”的温度属性值：

console
# 完整属性更新
curl localhost:1026/v2/entities/Room2/attrs/temperature -s -S \
  --header 'Content-Type: application/json' \
  -X PUT -d @- <<EOF
{
  "value": 26.3,
  "type": "Number"
}
EOF

# 仅更新属性值（简洁方式）
curl localhost:1026/v2/entities/Room2/attrs/temperature/value -s -S \
  --header 'Content-Type: text/plain' \
  -X PUT -d 26.3

API文档

API入门指南

• FIWARE NGSIv2 Orion API入门指南（英文）：https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals/user/walkthrough_apiv2.md
• FIWARE NGSIv2 Orion API入门指南（日文）：https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals.jp/user/walkthrough_apiv2.md

API参考文档

• FIWARE NGSIv2 Orion API参考（英文）：https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals/orion-api.md
• FIWARE NGSIv2 Orion API参考（日文）：https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals.jp/orion-api.md
• 官方手册（英文）：fiware-orion.readthedocs.io
• 官方手册（日文）：fiware-orion.letsfiware.jp

测试

端到端测试

使用functional_test目标运行端到端测试：

console
make functional_test INSTALL_DIR=~

单元测试

使用unit_test目标运行单元测试：

console
make unit_test

高级主题

• 高级编程：https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals/user/README.md | https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals.jp/user/README.md
• 安装与管理：https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals/admin/README.md | https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals.jp/admin/README.md
• 容器化部署：
  • Docker：https://github.com/telefonicaid/fiware-orion/blob/master/docker/README.md | https://github.com/telefonicaid/fiware-orion/blob/master/docker/README.jp.md
  • Docker Swarm与高可用：https://github.com/telefonicaid/fiware-orion/blob/master/docker/docker_swarm.md | https://github.com/telefonicaid/fiware-orion/blob/master/docker/docker_swarm.jp.md
• 开发手册：https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals/devel/README.md | https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals.jp/devel/README.md
• 贡献指南：https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals/devel/contribution_guidelines.md | https://github.com/telefonicaid/fiware-orion/blob/master/doc/manuals.jp/devel/contribution_guidelines.md

支持

• 技术问题：在Stack Overflow使用fiware-orion标签提问。
• 一般问题：在FIWARE Q&A使用fiware-orion标签提问。

许可证

Orion Context Broker采用GNU Affero通用公共许可证（AGPL）v3授权。

关于AGPLv3许可证的说明

修改源代码以修复bug或添加功能所产生的衍生作品需遵循AGPLv3许可证。仅使用或链接未修改的现有软件不视为衍生作品，无需以相同许可证发布或开源。