actility/iot-flow-drivers

Thingpark X 独立版 IoT Flow Drivers API 镜像文档

镜像概述

Thingpark X standalone IoT Flow Drivers API 镜像提供了物联网设备数据编解码的REST API服务。该镜像从公共仓库下载驱动并存储在本地内存中，通过暴露8095端口提供API访问，方便用户实现物联网设备数据的编码（下行链路）与解码（上行链路）功能。

核心功能与特性

• 驱动管理：自动从公共仓库下载驱动并存储于本地内存
• API接口：提供REST API用于设备数据的编码与解码操作
• Swagger UI：内置API文档与测试界面，便于接口调试与使用
• 端口暴露：通过8095端口提供服务访问
• 批量处理：支持批量解码多个设备数据

使用场景

适用于需要与物联网设备进行数据交互的场景，例如：

• 将传感器原始二进制数据解码为可读的业务数据（如温度、湿度等）
• 将业务数据编码为设备可识别的二进制载荷
• 物联网平台中设备数据的转换与处理

使用方法

1. 拉取镜像

通过以下命令拉取Docker镜像：

bash
docker pull actility/iot-flow-drivers

2. 运行容器

运行容器时需暴露8095端口以访问API服务：

bash
docker run -d -p 8095:8095 actility/iot-flow-drivers

3. 访问Swagger UI

容器运行后，可通过以下URL访问Swagger UI，查看完整API文档及使用示例：

http://localhost:8095/v1/swagger-ui

4. API使用示例

4.1 列出可用驱动

通过GET请求获取所有可用驱动列表：

bash
curl -X GET http://localhost:8095/v1/drivers

示例响应：

json
[
  {
    "id": "{driverId}",
    "producerId": "example",
    "moduleId": "myDriver",
    "version": "1"
  }
]

4.2 编码下行链路数据

将业务数据编码为设备可识别的二进制载荷：

bash
curl -X POST \
  http://localhost:8095/v1/encode \
  -H 'Content-Type: application/json' \
  -d '{
  "direction": "downlink",
  "meta": {
    "driverId": "${driverId}",
    "lorawan": {
      "fPort": 15
    }
  },
  "message": {
    "temperature": 23.5,
    "humidity": 65.0
  }
}'

示例响应：

json
{
  "direction": "downlink",
  "meta": {
    "driverId": "${driverId}"
  },
  "message": {
    "temperature": 23.5,
    "humidity": 65.0
  },
  "raw": {
    "binary": "{payload_in_hexadecimal}"
  }
}

其中{payload_in_hexadecimal}为驱动生成的十六进制原始载荷。

4.3 解码上行链路数据

将设备原始二进制载荷解码为业务数据：

bash
curl -X POST \
  http://localhost:8095/v1/decode \
  -H 'Content-Type: application/json' \
  -d '{
  "direction": "uplink",
  "meta": {
    "driverId": "${driverId}"
  },
  "raw": {
    "binary": "{payload_in_hexadecimal}"
  }
}'

示例响应：

json
{
  "direction": "uplink",
  "meta": {
    "driverId": "${driverId}"
  },
  "thing": {
    "points": {
      "temperature": {
        "records": [{
          "eventTime": "2019-01-01T10:00:00+01:00",
          "value": 23.5
        }],
        "unitId": "Cel",
        "type": "double"
      },
      "humidity": {
        "records": [{
          "eventTime": "2019-01-01T10:00:00+01:00",
          "value": 65.0
        }],
        "unitId": "%RH",
        "type": "double"
      }
    }
  },
  "raw": {
    "binary": "{payload_in_hexadecimal}"
  },
  "message": {
    "temperature": 23.5,
    "humidity": 65.0
  }
}

其中message字段为解码后的业务数据。

4.4 批量解码数据

支持同时解码多个设备的原始数据，可使用不同驱动：

bash
curl -X POST \
  http://localhost:8095/v1/decode \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "correlationId1",
      "input": {
        "direction": "uplink",
        "meta": {
          "driverId": "${driverId1}"
        },
        "raw": {
          "binary": "${payload_in_hexadecimal1}"
        }
      }
    },
    {
      "id": "correlationId2",
      "input": {
        "direction": "uplink",
        "meta": {
          "driverId": "${driverId2}"
        },
        "raw": {
          "binary": "${payload_in_hexadecimal2}"
        }
      }
    }
  ]'

示例响应包含每个请求的解码结果，通过id字段关联原始请求。