Entwickler-Ressourcen

Diese Seite bündelt die offiziellen Ressourcen, die Sie für die Integrationsentwicklung mit der BATCAM FX Serie und dem FX Viewer benötigen. Sie stellt API-Referenzen (Playground), öffentliche Beispiel-Repositories, Protokollschemata und Links zum Software-Download bereit. Den aktuellen Stand der einzelnen Ressourcen entnehmen Sie bitte den jeweils verlinkten Repositories und Dokumenten.

API-Referenz & Playground

Bei der produktspezifischen eingebetteten REST-API können Sie die Endpunkte im Playground auf Basis der OpenAPI-Spezifikation erkunden und direkt aufrufen. Bei beiden Produkten stellt das Gerät die API selbst bereit.

Produkt	API-Referenz	Authentifizierung	Standard-Geräte-IP
BATCAM FX	FX API Playground	HTTP Basic	`192.168.0.30`
BATCAM FX2	FX2 API Playground	HTTP Basic oder Bearer (JWT)	`192.168.0.80`

Einige Endpunkte von BATCAM FX (Overlay, ROS) stehen nur ab Firmware 1.0.3 oder höher zur Verfügung.
Bei BATCAM FX2 können Sie die Live-Spezifikation direkt am Gerät abrufen: GET http://{device_ip}/api-docs/json
Das Echtzeit-Streaming von Audio/Beamforming (WebSocket + Protobuf) ist nicht in der REST-Spezifikation enthalten. Beachten Sie dazu die Abschnitte Beispielcode·Protokolldefinition weiter unten.

💡 Hinweis: Ändern Sie das Passwort des ab Werk eingerichteten Standardkontos unbedingt beim ersten Zugriff, bevor Sie es verwenden.

Dokumentations-Routing Produkt × Schnittstelle

Wechseln Sie je nach der Schnittstelle, die Sie anbinden möchten, über die folgende Tabelle zum entsprechenden Dokument.

Schnittstelle	BATCAM FX	BATCAM FX2	FX Viewer
REST API	Playground	Playground	–
Echtzeit-Stream (WebSocket + Protobuf, RTSP)	Überblick über den Datenfluss	Python-Protobuf-Beispiel	–
ROS 2	ROS-Integration	–	–
ONVIF	–	ONVIF	–
Modbus TCP	–	–	Modbus-Anbindung
Web-UI zur Geräteverwaltung	–	Geräte-Manager	–
FX Cloud	–	FX Cloud Anmeldung	–
Software-Update	Web-Software-Update	Software-Update	download.smins.kr
Firmware-Release-Notes	Release Notes	Release Notes	–

Beispielcode

Beispiel	Zielprodukt	Sprache	Behandelte Inhalte
fx-api-example-csharp (GitHub)	BATCAM FX	C#	Empfang des WebSocket-Streams → Protobuf-Dekodierung → Überlagerung des RTSP-Videobilds mit dem Overlay. Inklusive GUI-Beispiel
batcam-fx-python-protobuf-example (GitHub)	BATCAM FX · FX2	Python	REST-Statusabfrage, WebSocket Subscribe, Parsen von Protobuf-Nachrichten (Beamforming / Audio / LPoint / Prpd)

Die schrittweise Beschreibung des Python-Beispiels (Einrichten der Umgebung, Erzeugen der Bindings, Empfang je Nachrichtentyp, Änderungen bei FX2) finden Sie in der FX2-Entwicklerdokumentation auf der Seite Python-Protobuf-Beispiel.
Beim Aufbau der WebSocket-Verbindung müssen Sie als SubProtocol Subscribe angeben; der Datenempfang beginnt erst, wenn Sie nach dem Verbindungsaufbau mit einem Subscribe-Objekt eine Abonnementanfrage senden.
Auch die WebSocket-Verbindung erfordert – wie RTSP – eine Benutzerauthentifizierung. Falls die verwendete Bibliothek keine Authentifizierung unterstützt, müssen Sie im Header Authorization die Angabe {username}:{password} base64-kodiert mitsenden. Einzelheiten finden Sie im Überblick über die BATCAM FX Entwicklerdokumentation.

Protokolldefinition

Die Beispiel-Repositories sind auf GitHub (SM-Instruments-Inc) veröffentlicht, die Repositories mit den Protokolldefinitionen im OSS-GitLab (smins-oss).

Repository	Inhalt
fx-stream-protocol (GitLab)	Protobuf-Schema und vorab generierte Dateien für das Kodieren/Dekodieren der FX-Streamdaten. Das kanonische Schema ist `fx-protocol-2.proto`; es bildet die Grundlage für die Erzeugung der sprachspezifischen Bindings.
fx-stream-msgs (GitLab)	Definition der ROS 2-Schnittstellentypen (Nachrichten), die BATCAM FX zum Senden von Daten verwendet. Die ausführliche Spezifikation finden Sie im Dokument ROS-Integration.

Nachfolgend ein Beispiel für das Erzeugen von Python-Bindings aus dem Schema.

# protoc installieren (macOS / Homebrew)
brew install protobuf

# Python-Bindings erzeugen
protoc --python_out=. fx-protocol-2.proto

Software-Download

Offiziell ausgelieferte Software wie den FX Viewer können Sie über den Download-Hub download.smins.kr herunterladen. Den Änderungsverlauf der Gerätefirmware entnehmen Sie den produktspezifischen Release Notes (BATCAM FX, BATCAM FX2).