pilotak/sigfox-influxdb

Sigfox to InfluxDB 转换器

镜像概述

pilotak/sigfox-influxdb 是一个简单高效的 API 服务器镜像，专门用于将 Sigfox 回调机制产生的数据转换并直接保存到 InfluxDB 中。由于 Sigfox 原生不支持直接将回调数据写入 InfluxDB，该镜像填补了这一空白，提供了一个通用的中间件解决方案。

核心功能和特性

• 无缝转换：自动接收 Sigfox 回调数据并将其转换为 InfluxDB 兼容的格式。
• 动态路由：无需重启容器，即可通过请求载荷将数据灵活保存到不同的 InfluxDB 数据库或测量表（Measurement）中。
• 免预配置：API 服务器本身无需预先配置数据库凭证，连接信息通过每次请求的 JSON 载荷动态传递。
• 数据运算：集成 math.js，支持在数据入库前对字段值进行自定义数学表达式运算。

使用场景和适用范围

• 物联网（IoT）项目中，使用 Sigfox 网络传输传感器数据，并需要将数据持久化到 InfluxDB 进行时序数据分析与可视化的场景。
• 需要将不同设备或不同类型的数据动态路由到不同 InfluxDB 数据库或表的复杂多租户架构。

快速部署

使用 Docker Compose

推荐使用 docker-compose 进行部署，以下是基础的配置文件示例：

yaml
version: "3.6"

services:
  sigfox:
    container_name: sigfox
    image: pilotak/sigfox-influxdb
    restart: always
    ports:
      - "4752:8080"

配置与使用说明

该镜像通过接收 HTTP POST 请求中的 JSON 载荷来配置数据库连接和数据映射。

基础 JSON 示例

在最简单的场景下，您只需指定数据库地址、名称以及要写入的数据字段：

json
{
  "db": {
    "host": "website.com",
    "database": "my_db"
  },
  "data": {
    "measurement": "{device}",
    "fields": {
      "temp": {customData#temperature}
    }
  }
}

注：{device} 和 {customData#temperature} 为 Sigfox 后台的占位符变量。

完整 JSON 示例（含认证与数学运算）

如果您的 InfluxDB 需要身份验证，或者您需要对传入的数值进行计算，可以使用完整的 JSON 结构：

json
{
  "db": {
    "host": "website.com",
    "database": "my_db",
    "port": 5987,
    "username": "user",
    "password": "123456"
  },
  "data": {
    "measurement": "{device}",
    "fields": {
      "temp": {customData#temperature}
    }
  },
  "math": {
    "temp": "(x*2)-1.5"
  }
}

参数详细说明

1. 数据库配置 (db)

2. 数据映射 (data)

3. 数学运算 (math)

支持使用 math.js 表达式对字段值进行修改。

• 运算配置中的键名必须与 data.fields 中的键名完全匹配。
• 表达式中的实际字段变量统一使用 x 表示。
• 未配置 math 的字段将保持原值写入。

Sigfox 后台配置

在 Sigfox Backend 中配置 Callback 时，请按照以下步骤操作：

1. 进入设备类型（Device Type）的 Callbacks 设置页面。
2. 创建一个新的 Custom Callback。
3. URL：填写部署该镜像的服务器地址及端口（例如：http://your-server-ip:4752）。
4. HTTP Method：选择 POST。
5. Content Type：选择 application/json。
6. Body：将上述配置好的 JSON 数据示例粘贴到请求体中，确保正确使用了 Sigfox 提供的变量占位符。