跳转到内容
SMI Developer Center

开发者资源

本页汇集了 BATCAM FX 系列与 FX Viewer 集成开发所需的官方资源。提供 API 参考（演练场）、公开示例仓库、协议 Schema 以及软件下载链接。各资源的最新状态请在所链接的仓库和文档中确认。

API 参考 & 演练场

各产品的嵌入式 REST API 可在基于 OpenAPI 规范的演练场中浏览端点并直接调用。两款产品均由设备直接提供 API 服务。

产品API 参考认证默认设备 IP
BATCAM FXFX API 演练场HTTP Basic192.168.0.30
BATCAM FX2FX2 API 演练场HTTP Basic 或 Bearer(JWT)192.168.0.80

  • BATCAM FX 的部分端点（叠加、ROS）仅在固件 1.0.3 及以上版本中提供。

  • BATCAM FX2 可直接在设备上查看实时规范：GET http://{device_ip}/api-docs/json

  • 实时音频/波束成形流传输（WebSocket + Protobuf）不包含在 REST 规范中。请参阅下方的示例代码·协议定义章节。

💡 注意：设备出厂时设置的默认账户密码，请务必在首次接入时修改后使用。

产品 × 接口文档路由

请根据要集成的接口，在下表中前往对应的文档。

接口BATCAM FXBATCAM FX2FX Viewer
REST API演练场演练场–
实时流 (WebSocket + Protobuf, RTSP)数据流概览Python Protobuf 示例–
ROS 2ROS 集成––
ONVIF–ONVIF–
Modbus TCP––Modbus 集成
设备管理 Web UI–设备管理器–
FX Cloud–FX Cloud 登录–
软件更新Web 软件更新软件更新download.smins.kr
固件发行说明发行说明发行说明–

示例代码

示例目标产品语言涵盖内容
fx-api-example-csharp (GitHub)BATCAM FXC#接收 WebSocket 流 → Protobuf 解码 → 与 RTSP 视频叠加合成。包含 GUI 示例
batcam-fx-python-protobuf-example (GitHub)BATCAM FX · FX2PythonREST 状态查询、WebSocket Subscribe、Protobuf 消息（Beamforming / Audio / LPoint / Prpd）解析

  • Python 示例的分步说明（环境配置、生成绑定、按消息类型接收、FX2 变更事项）由 FX2 开发者文档的 Python Protobuf 示例页面提供。

  • 建立 WebSocket 连接时必须将 SubProtocol 指定为 Subscribe，并且连接后需通过 Subscribe 对象发送订阅请求，才会开始接收数据。

  • WebSocket 连接与 RTSP 一样需要用户认证。如果所用库不支持认证，则必须将 {username}:{password} 以 base64 编码后包含在 Authorization 头中。详细内容请参阅 BATCAM FX 开发文档概览。

协议定义

示例仓库公开在 GitHub（SM-Instruments-Inc），协议定义仓库公开在 OSS GitLab（smins-oss）。

仓库内容
fx-stream-protocol (GitLab)用于 FX 流数据编码/解码的 Protobuf Schema 及预生成文件。canonical Schema 为 fx-protocol-2.proto，是生成各语言绑定的基准。
fx-stream-msgs (GitLab)BATCAM FX 用于发送数据的 ROS 2 接口（消息）类型定义。详细规范请参阅 ROS 集成文档。

以下是从 Schema 生成 Python 绑定的示例。

Terminal window
# 安装 protoc (macOS / Homebrew)
brew install protobuf


# 生成 Python 绑定
protoc --python_out=. fx-protocol-2.proto

软件下载

FX Viewer 等官方发布的软件可在下载中心 download.smins.kr 下载。设备固件的变更历史请在各产品的发行说明（BATCAM FX, BATCAM FX2）中查看。

相关文档