Zerobit RTLS Developer Docs
v0.1.0
Zerobit RTLS

实时定位系统的
开发与部署文档

以单个可执行文件交付的 UWB 实时定位服务。这里包含生产部署指南,以及全部 HTTP 接口的在线调试台——填参数、发请求、看响应,无需离开浏览器。

52 个接口 8 个分组 JWT 鉴权 SSE 实时推送
# 1. 启动服务(默认 0.0.0.0:8180)
./rtls

# 2. 登录换取 JWT
curl -X POST http://localhost:8180/auth \
  -H 'Content-Type: application/json' \
  -d '{"username":"admin","password":"123456qw"}'

# 3. 携带 Token 调用接口
curl http://localhost:8180/rtls/positions \
  -H 'Authorization: Bearer <token>'

快速开始

01

部署服务

将交付的可执行文件拷贝到目标机器,配置数据目录与鉴权密钥后直接运行。

部署与目录 →
02

获取 Token

调用 POST /auth 换取 JWT。写接口需要 Authorization: Bearer,账号管理需要权限 0。

在线登录 →
03

接入数据

通过 TCP / MQTT / Redis 上报测距,或用 POST /rtls/positions 直接写入定位源,再订阅 SSE 获取实时结果。

写入定位源 →

数据流

接入
HTTP API :8180 · REST / SSE
TCP 网关 :8181 · 测距上报
MQTT / Redis 可选 · 上行订阅
→
处理
RTLS 引擎 解算 · 平滑 · 区域 / 围栏 · 告警
TOF skel GNSS AOA IMU
→
存储与查询
OLAP 时序库 原始源 · 定位结果 · 告警
文档库 锚点 / 映射 / 人员 / 规则
对象存储 模型 · 图片 · 附件

接口分组

接口约定

鉴权

除公开读接口外,写操作需携带 Authorization: Bearer <jwt>。Token 默认 1 小时过期,可通过 HEAD /auth?exp= 刷新。账号管理接口要求 JWT 包含权限 0。

批量写入

配置类接口使用 PUT + { id: 实体 | null } 语义:值存在则新增/更新,值为 null 则删除。响应统一返回 { deleted, updated, created }。

分页查询

历史数据使用 PATCH 分页,参数含 start、end、page、limit, 总数通过响应头 x-total-count 返回。计数接口使用同条件的 HEAD。

实时事件

GET /sse 建立 Server-Sent Events 长连接,事件数据为 base64(MessagePack)。浏览器 EventSource 不能设置请求头时,可通过 ?jwt= 鉴权。