コンテンツにスキップ
SMI Developer Center

開発者リソース

BATCAM FX シリーズと FX Viewer の連携開発に必要な公式リソースをまとめたページです。API リファレンス（プレイグラウンド）、公開サンプルリポジトリ、プロトコルスキーマ、ソフトウェアダウンロードリンクを提供します。各リソースの最新の状態は、リンク先のリポジトリおよびドキュメントでご確認ください。

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 Integration––
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 と同様にユーザー認証が必要です。ライブラリが認証に対応していない場合は、Authorization ヘッダーに {username}:{password} を base64 でエンコードして含める必要があります。詳細は BATCAM FX 開発ドキュメント概要を参照してください。

プロトコル定義

サンプルリポジトリは GitHub（SM-Instruments-Inc）に、プロトコル定義リポジトリは OSS GitLab（smins-oss）に公開されています。

リポジトリ内容
fx-stream-protocol (GitLab)FX ストリームデータのエンコード／デコードに使用する Protobuf スキーマと事前生成ファイル。canonical スキーマは fx-protocol-2.proto であり、各言語向けバインディング生成の基準となります。
fx-stream-msgs (GitLab)BATCAM FX がデータ送信に使用する ROS 2 インターフェース（メッセージ）タイプの定義。詳細な仕様は ROS Integration ドキュメントを参照してください。

スキーマから 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）でご確認ください。

関連ドキュメント