Zum Inhalt springen

Erste Schritte im Developer Center

Das SMI Developer Center stellt an einem Ort die technische Dokumentation bereit, die für die Anbindung und die Entwicklung mit der Schallkamera-Produktfamilie von SM Instruments (BATCAM FX, BATCAM FX2) und der Anwendung FX Viewer erforderlich ist. Datenstreaming-Protokolle, Parametersteuerung, Firmware und Methoden zur Integration externer Systeme sind nach Produkt gegliedert und unterstützen Entwickler, die Schall- und Schwingungsdaten in eigene Anwendungen oder Workflows integrieren möchten.

Was können Sie damit entwickeln?

Mit der Dokumentation des Developer Centers können Sie die folgenden Integrationen umsetzen.

  • Echtzeit-Overlay-Videoanwendung — Sie kombinieren das RTSP-Originalvideo der BATCAM FX mit den über WebSocket/Protobuf empfangenen Beamforming-Daten (Array aus 1200 Float-Werten) und erzeugen in Ihrer eigenen Anwendung ein Overlay-Video. BATCAM FX Übersicht

  • Gerätesteuerung und -überwachung über die REST API — Sie steuern Konto-, Netzwerk-, Firmware-, Ereignis- und Beamforming-Einstellungen direkt aus dem Code. FX API-Playground · FX2 API-Playground

  • ROS 2-Systemintegration — Die BATCAM FX unterstützt ab der Entwicklungs-Firmware v1.0.3b die Datenübertragung auf Basis von ROS 2 (Humble Hawksbill). Übersicht zur FX ROS-Systemintegration

  • Anbindung an die Fabrikautomatisierung (PLC·SCADA·HMI) — Über den Modbus TCP-Server des FX Viewer überwachen Sie Beam-Power und Alarmstatus und steuern einzelne Einstellungen wie Schwellenwerte von außen. FX Viewer Modbus-Anbindung

Auswahlhilfe für Produkt und Schnittstelle

Wechseln Sie je nach eingesetztem Produkt und Art der Anbindung über die folgende Tabelle zum passenden Dokumentations-Track.

ProduktSchnittstelleFür diese AufgabenDokumentation
BATCAM FXRTSP + WebSocket/ProtobufEmpfang von Echtzeitvideo- und Beamforming-Daten, Overlay-KompositionBATCAM FX Übersicht
BATCAM FXREST API (HTTP Basic-Authentifizierung)Steuerung von Konto, Geräteeinstellungen, Ereignissen, Beamforming und ROS DomainFX API-Playground
BATCAM FXROS 2Empfang von Schalldaten in ROS 2-basierten SystemenFX ROS-Systemintegration
BATCAM FX2Device Manager (Web-UI)Geräteeinstellungen und Statusverwaltung im BrowserErste Schritte mit dem FX2-Gerät · Menüübersicht
BATCAM FX2REST API (Basic-/Bearer-Authentifizierung)Steuerung von Authentifizierung, Geräteeinstellungen, Beamforming, Ereignissen, Mikrofon und SystemFX2 API-Playground
BATCAM FX2WebSocket/ProtobufEmpfang und Decodierung von Streamdaten (inklusive Python-Beispiel)Python-Protobuf-Beispiel
BATCAM FX2ONVIFGerätesuche und Abruf von Echtzeitvideo in ONVIF-fähigen Device ManagernONVIF-Unterstützung
BATCAM FX2FX CloudKonto in der Cloud erstellen, Gerät per QR-Code anbinden, Echtzeitvideo prüfenRegistrierung · Geräteanbindung
FX ViewerModbus TCPÜberwachung und Steuerung von Beam-Power und Alarmen aus PLC·SCADA·HMIHandbuch zur Modbus-Anbindung

Dokumentations-Tracks nach Produkt

  • BATCAM FX Entwicklerdokumentation — Beginnend mit einer Übersicht über den Datenfluss werden Beamforming- und Overlay-Parameter, Listening Point-Koordinaten, die ROS 2-Integration, Firmware-Updates (Web/Shell) und Release Notes sowie die Dokumentation zum KI-basierten PRPD-Klassifikator bereitgestellt.

  • BATCAM FX2 Entwicklerdokumentation — Beginnend mit dem ersten Zugriff und der Passwortänderung werden die einzelnen Menüs des Device Managers (Beamforming, Kamera, Mikrofon, Ereignisse, künstliche Intelligenz usw.), FX Cloud, ONVIF, Python-Protobuf-Beispiele und Release Notes dokumentiert.

  • FX Viewer Entwicklerdokumentation — Hier finden Sie das Handbuch zur Modbus TCP-Anbindung der Anwendung FX Viewer (Register-Map, Python-Beispiele, Troubleshooting).

Schnellstart: Erste Verbindung prüfen

Nachdem Sie das Gerät und den Entwicklungs-PC mit demselben Netzwerk verbunden haben, können Sie die Kommunikation mit dem Gerät mit einer einzigen Anfrage prüfen.

BATCAM FX2

  1. Verbinden Sie das Gerät und den PC über Ethernet. Die Werkseinstellungen lauten Ethernet #1 192.168.0.80 und Ethernet #2 192.168.0.81. Stellen Sie die IP des PCs auf denselben Adressbereich (192.168.0.x) ein.

  2. Prüfen Sie die Kommunikation über den Health-Check-Endpunkt, der ohne Authentifizierung aufgerufen werden kann.

Terminal-Fenster
curl http://192.168.0.80/ping

Erwartete Antwort:

{"error": 0, "result": "pong"}
  1. Rufen Sie im Browser http://192.168.0.80 auf und melden Sie sich am Device Manager an. Das Standardkonto lautet admin/1234; beim ersten Zugriff müssen Sie es unbedingt auf ein neues Passwort ändern. Einzelheiten zum Ablauf finden Sie unter Erste Schritte mit dem FX2-Gerät.

BATCAM FX

Alle REST-Endpunkte der BATCAM FX erfordern eine HTTP Basic-Authentifizierung. Auf dem Gerät sind standardmäßig die beiden Konten admin und user vorkonfiguriert; ändern Sie das werkseitige Standardpasswort unbedingt vor der Verwendung. Über die Abfrage der Geräteinformationen können Sie die Verbindung und die Firmware-Version prüfen.

Terminal-Fenster
curl -u admin:<password> http://<Geräte-IP>/setting/status

Erwartete Antwort:

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

💡 Hinweis: Einige Endpunkte rund um Overlay und ROS werden erst ab Firmware 1.0.3 oder höher bereitgestellt. Für den Empfang von Echtzeitdaten wird nicht REST, sondern der Pfad RTSP + WebSocket/Protobuf verwendet — siehe BATCAM FX Übersicht.

API-Referenz (Playground)

Die REST APIs beider Produkte können Sie im API-Playground einsehen, der in das Developer Center integriert ist. Erkunden Sie die Parameter, die Request-/Response-Schemata und die Beispiele jedes Endpunkts direkt im Browser.

  • BATCAM FX API — Eine eingebettete REST API, die das Gerät selbst bereitstellt. Sie umfasst Endpunkte für Konto (auth), Geräteeinstellungen (Netzwerk, Firmware, Neustart, Geräteinformationen), Ereignisse, Beamforming (Einstellungen, Ergebnisse, Overlay) und ROS Domain ID.

  • BATCAM FX2 API — Umfasst Endpunkte für Authentifizierung, Geräteeinstellungen, Beamforming, Ereignistrigger und -logs, Mikrofon (Auswahl, Kalibrierung) sowie System (Monitoring, Zurücksetzen).

Die BATCAM FX2 stellt auf dem Gerät zusätzlich eine Live-OpenAPI-Spezifikation bereit: GET http://{device_ip}/api-docs/json

💡 Hinweis: Das Echtzeit-Streaming über WebSocket/Protobuf ist nicht in der REST-Spezifikation enthalten. Siehe BATCAM FX Übersicht und Python-Protobuf-Beispiel.

Entwickler-Ressourcen

Externe Ressourcen wie C#-Integrationsbeispiele, das Protobuf-Schema (fx-stream-protocol) und offizielle Software-Downloads sind auf der Seite Entwickler-Ressourcen zusammengestellt.