跳转到内容
SMI Developer Center

开发者中心入门

SMI 开发者中心在同一处提供 SM Instruments 声学相机产品系列（BATCAM FX、BATCAM FX2）与 FX Viewer 应用程序的对接及开发所需的技术文档。本中心按产品整理了数据流传输协议、参数控制、固件以及外部系统集成方法，为希望将声学与振动数据集成到自有应用程序或工作流中的开发者提供支持。

可以构建什么？

借助开发者中心的文档，您可以实现以下集成。

  • 实时叠加视频应用程序 — 将 BATCAM FX 的 RTSP 原始视频与通过 WebSocket/Protobuf 接收的波束成形数据（1200 个 Float 数组）合成，在自有应用程序中生成叠加视频。BATCAM FX 概述

  • 基于 REST API 的设备控制与监控 — 在代码中直接控制账户、网络、固件、事件、波束成形设置。FX API 演练场 · FX2 API 演练场

  • ROS 2 系统集成 — BATCAM FX 自 v1.0.3b 开发固件起支持基于 ROS 2（Humble Hawksbill）的数据发送。FX ROS 系统集成概述

  • 工厂自动化（PLC·SCADA·HMI）对接 — 通过 FX Viewer 的 Modbus TCP 服务器监控波束功率与报警状态，并从外部控制阈值等部分设置。FX Viewer Modbus 对接

产品与接口选择指南

请根据所使用的产品和对接方式，从下表进入相应的文档路线。

产品接口用于此类工作文档
BATCAM FXRTSP + WebSocket/Protobuf接收实时视频与波束成形数据、叠加合成BATCAM FX 概述
BATCAM FXREST API（HTTP Basic 认证）账户、设备设置、事件、波束成形、ROS Domain 控制FX API 演练场
BATCAM FXROS 2在基于 ROS 2 的系统中接收声学数据FX ROS 系统集成
BATCAM FX2设备管理器（Web UI）在浏览器中管理设备设置与状态FX2 设备入门 · 菜单说明
BATCAM FX2REST API（Basic/Bearer 认证）认证、设备设置、波束成形、事件、麦克风、系统控制FX2 API 演练场
BATCAM FX2WebSocket/Protobuf流数据接收与解码（含 Python 示例）Python Protobuf 示例
BATCAM FX2ONVIF在支持 ONVIF 的设备管理器中搜索设备、获取实时视频ONVIF 支持
BATCAM FX2FX Cloud在云端创建账户、通过 QR 码对接设备、查看实时视频注册 · 设备对接
FX ViewerModbus TCP在 PLC、SCADA、HMI 中监控与控制波束功率和报警Modbus 对接手册

各产品文档路线

  • BATCAM FX 开发文档 — 从数据流概述开始，提供波束成形与叠加参数、Listening Point 坐标、ROS 2 集成、固件更新（Web/Shell）与发行说明、基于 AI 的 PRPD 分类器等文档。

  • BATCAM FX2 开发文档 — 从初次接入与修改密码开始，提供设备管理器各菜单（波束成形、摄像头、麦克风、事件、人工智能等）、FX Cloud、ONVIF、Python Protobuf 示例、发行说明等文档。

  • FX Viewer 开发文档 — 提供 FX Viewer 应用程序的 Modbus TCP 对接手册（寄存器映射、Python 示例、故障排除）。

快速开始：确认首次连接

将设备与开发 PC 连接到同一网络后，只需一次请求即可确认与设备之间的通信。

BATCAM FX2

  1. 通过以太网连接设备与 PC。出厂默认值为以太网 #1 192.168.0.80、以太网 #2 192.168.0.81。请将 PC 的 IP 设置为同一网段（192.168.0.x）。

  2. 通过无需认证即可调用的健康检查端点确认通信。

Terminal window
curl http://192.168.0.80/ping

预期响应：

{"error": 0, "result": "pong"}
  1. 在浏览器中访问 http://192.168.0.80 并登录设备管理器。默认账户为 admin/1234，首次接入时必须修改为新密码。详细步骤请参考 FX2 设备入门。

BATCAM FX

BATCAM FX 的所有 REST 端点均需要 HTTP Basic 认证。设备默认预设了 admin 和 user 两个账户，出厂默认密码务必修改后再使用。通过查询设备信息可以确认连接状态与固件版本。

Terminal window
curl -u admin:<password> http://<设备 IP>/setting/status

预期响应：

{
  "error": 0,
  "result": {
    "hardware_id": "3287162925128",
    "sbrio_version": "1.0.14",
    "firmware_version": "v0.0.1"
  }
}

💡 注意： 部分与叠加、ROS 相关的端点仅在固件 1.0.3 及以上版本中提供。实时数据接收不使用 REST，而是使用 RTSP + WebSocket/Protobuf 路径 — 请参考 BATCAM FX 概述。

API 参考（演练场）

两款产品的 REST API 可在开发者中心集成的 API 演练场中查看。请在浏览器中直接浏览各端点的参数、请求/响应模式与示例。

  • BATCAM FX API — 由设备直接提供服务的嵌入式 REST API。涵盖账户（auth）、设备设置（网络、固件、重启、设备信息）、事件、波束成形（设置、结果、叠加）、ROS Domain ID 端点。

  • BATCAM FX2 API — 涵盖认证、设备设置、波束成形、事件触发与日志、麦克风（选择、校准）、系统（监控、初始化）端点。

BATCAM FX2 还在设备上提供实时 OpenAPI 规范：GET http://{device_ip}/api-docs/json

💡 注意： WebSocket/Protobuf 实时流传输不包含在 REST 规范中。请参考 BATCAM FX 概述 与 Python Protobuf 示例。

开发者资源

C# 对接示例、Protobuf 模式（fx-stream-protocol）、官方软件下载等外部资源整理在开发者资源页面中。