nerveshub/nerves_hub_api

NervesHubAPI 镜像文档

镜像概述

NervesHubAPI是NervesHub平台的接口服务，提供JSON和Erlang二进制两种数据格式的交互能力。该镜像作为NervesHub生态的核心组件，负责处理嵌入式设备与NervesHub平台之间的通信，支持设备注册、状态上报、固件更新请求等关键操作。

核心功能与特性

• 双协议支持：同时提供JSON和Erlang二进制协议接口，适配不同类型的客户端需求
• 设备管理接口：支持设备注册、认证、状态查询及管理操作
• 固件更新支持：提供固件版本查询、更新请求及进度跟踪功能
• 轻量级设计：基于Erlang/OTP构建，具备高并发、低资源占用特性
• 安全通信：支持TLS加密，确保设备与平台通信的安全性

使用场景

• 嵌入式设备与NervesHub平台的通信接入
• 设备管理系统集成NervesHub功能
• 自动化固件更新服务部署
• 大规模嵌入式设备状态监控与管理

使用方法

基本部署（Docker Run）

bash
docker run -d \
  --name nerveshub-api \
  -p 4000:4000 \
  -e NERVES_HUB_HOST="nerveshub.example.com" \
  -e API_PORT=4000 \
  -e LOG_LEVEL="info" \
  nerveshub/api:latest

Docker Compose 配置

yaml
version: '3'
services:
  nerveshub-api:
    image: nerveshub/api:latest
    container_name: nerveshub-api
    ports:
      - "4000:4000"
    environment:
      - NERVES_HUB_HOST=nerveshub.example.com
      - API_PORT=4000
      - LOG_LEVEL=info
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_USER=nerveshub
      - DB_PASSWORD=secure_password
      - DB_NAME=nerveshub_api
    depends_on:
      - postgres
    restart: unless-stopped

  postgres:
    image: postgres:14
    container_name: nerveshub-db
    environment:
      - POSTGRES_USER=nerveshub
      - POSTGRES_PASSWORD=secure_password
      - POSTGRES_DB=nerveshub_api
    volumes:
      - pgdata:/var/lib/postgresql/data

volumes:
  pgdata:

环境变量配置

接口访问示例

JSON协议设备注册请求

bash
curl -X POST http://localhost:4000/api/v1/devices \
  -H "Content-Type: application/json" \
  -d '{
    "device_id": "device-1234",
    "product": "my-iot-device",
    "firmware_version": "1.0.0"
  }'

Erlang二进制协议示例（Erlang客户端）

erlang
{ok, Socket} = gen_tcp:connect("localhost", 4000, [binary, {active, false}]),
Request = term_to_binary({register_device, "device-1234", "my-iot-device", "1.0.0"}),
ok = gen_tcp:send(Socket, Request),
{ok, Response} = gen_tcp:recv(Socket, 0),
binary_to_term(Response).

注意事项

• 生产环境中必须启用TLS加密，并正确配置证书和私钥
• 数据库需提前初始化，可通过执行容器内/app/bin/migrate命令完成数据库迁移
• 高并发场景下建议调整Erlang VM参数（通过ERL_FLAGS环境变量设置）