Démarrer avec le centre développeur

Le centre développeur SMI réunit en un seul endroit la documentation technique nécessaire à l’intégration et au développement pour la gamme de caméras acoustiques SM Instruments (BATCAM FX, BATCAM FX2) et pour l’application FX Viewer. Il organise par produit les protocoles de streaming de données, le contrôle des paramètres, le firmware et les méthodes d’intégration avec des systèmes externes, afin d’accompagner les développeurs qui souhaitent intégrer des données acoustiques et vibratoires dans leurs propres applications ou flux de travail.

Que pouvez-vous créer ?

La documentation du centre développeur vous permet de réaliser les intégrations suivantes.

Application vidéo overlay en temps réel — combinez la vidéo RTSP brute du BATCAM FX avec les données de beamforming reçues via WebSocket/Protobuf (tableau de 1200 Float) afin de générer une vidéo overlay dans votre propre application. Présentation du BATCAM FX
Contrôle et supervision de l’appareil via l’API REST — contrôlez directement depuis votre code les réglages de compte, de réseau, de firmware, d’événement et de beamforming. Playground de l’API FX · Playground de l’API FX2
Intégration système ROS 2 — le BATCAM FX prend en charge l’émission de données basée sur ROS 2 (Humble Hawksbill) à partir du firmware de développement v1.0.3b. Présentation de l’intégration système ROS pour FX
Intégration avec l’automatisation industrielle (PLC/SCADA/HMI) — supervisez le beam power et l’état des alarmes via le serveur Modbus TCP du FX Viewer, et contrôlez depuis l’extérieur certains réglages tels que les seuils. Intégration Modbus du FX Viewer

Guide de choix du produit et de l’interface

Repérez dans le tableau ci-dessous le produit que vous utilisez et le mode d’intégration retenu, puis accédez à la piste documentaire correspondante.

Produit	Interface	À utiliser pour	Documentation
BATCAM FX	RTSP + WebSocket/Protobuf	Réception de la vidéo en temps réel et des données de beamforming, composition de l’overlay	Présentation du BATCAM FX
BATCAM FX	REST API (authentification HTTP Basic)	Contrôle des comptes, des réglages de l’appareil, des événements, du beamforming et du ROS Domain	Playground de l’API FX
BATCAM FX	ROS 2	Réception de données acoustiques dans un système basé sur ROS 2	Intégration système ROS pour FX
BATCAM FX2	Device Manager (interface web)	Gestion des réglages et de l’état de l’appareil depuis un navigateur	Démarrer avec l’appareil FX2 · Guide des menus
BATCAM FX2	REST API (authentification Basic/Bearer)	Contrôle de l’authentification, des réglages de l’appareil, du beamforming, des événements, du microphone et du système	Playground de l’API FX2
BATCAM FX2	WebSocket/Protobuf	Réception et décodage des données de flux (exemples Python inclus)	Exemple Python Protobuf
BATCAM FX2	ONVIF	Découverte de l’appareil et acquisition de la vidéo en temps réel depuis un gestionnaire d’appareils compatible ONVIF	Prise en charge d’ONVIF
BATCAM FX2	FX Cloud	Création d’un compte dans le cloud, association d’un appareil par QR code et visualisation de la vidéo en temps réel	Inscription · Association d’un appareil
FX Viewer	Modbus TCP	Supervision et contrôle du beam power et des alarmes depuis un PLC/SCADA/HMI	Manuel d’intégration Modbus

Pistes documentaires par produit

Documentation développeur BATCAM FX — commence par une présentation du flux de données, puis fournit les paramètres de beamforming et d’overlay, les coordonnées du Listening Point, l’intégration ROS 2, la mise à jour du firmware (web/shell) et les notes de version, ainsi que la documentation du classifieur PRPD basé sur l’IA.
Documentation développeur BATCAM FX2 — commence par la première connexion et le changement de mot de passe, puis fournit chaque menu du Device Manager (beamforming, caméra, microphone, événements, intelligence artificielle, etc.), FX Cloud, ONVIF, l’exemple Python Protobuf et les notes de version.
Documentation développeur FX Viewer — fournit le manuel d’intégration Modbus TCP de l’application FX Viewer (carte des registres, exemples Python, dépannage).

Démarrage rapide : vérifier la première connexion

Une fois l’appareil et le PC de développement raccordés au même réseau, une seule requête suffit pour vérifier la communication avec l’appareil.

BATCAM FX2

Reliez l’appareil et le PC par Ethernet. Les valeurs d’usine sont 192.168.0.80 pour Ethernet #1 et 192.168.0.81 pour Ethernet #2. Réglez l’adresse IP du PC sur la même plage (192.168.0.x).
Vérifiez la communication à l’aide de l’endpoint de health check, qui peut être appelé sans authentification.

curl http://192.168.0.80/ping

Réponse attendue :

{"error": 0, "result": "pong"}

Depuis un navigateur, accédez à http://192.168.0.80 et connectez-vous au Device Manager. Le compte par défaut est admin/1234, et vous devez impérativement définir un nouveau mot de passe lors de la première connexion. Pour la procédure détaillée, reportez-vous à Démarrer avec l’appareil FX2.

BATCAM FX

Tous les endpoints REST du BATCAM FX exigent une authentification HTTP Basic. Deux comptes, admin et user, sont préconfigurés par défaut sur l’appareil ; veillez à impérativement changer les mots de passe d’usine avant utilisation. La consultation des informations de l’appareil permet de vérifier la connexion et la version du firmware.

curl -u admin:<password> http://<IP de l'appareil>/setting/status

Réponse attendue :

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

💡 Remarque : certains endpoints liés à l’overlay et à ROS ne sont disponibles qu’à partir du firmware 1.0.3 ou supérieur. La réception de données en temps réel n’utilise pas REST, mais le chemin RTSP + WebSocket/Protobuf — reportez-vous à Présentation du BATCAM FX.

Référence de l’API (playground)

Les API REST des deux produits sont consultables dans le playground d’API intégré au centre développeur. Explorez directement dans votre navigateur les paramètres, les schémas de requête/réponse et les exemples de chaque endpoint.

BATCAM FX API — API REST embarquée servie directement par l’appareil. Elle couvre les endpoints de compte (auth), de réglages de l’appareil (réseau, firmware, redémarrage, informations sur l’appareil), d’événement, de beamforming (réglages, résultats, overlay) et de ROS Domain ID.
BATCAM FX2 API — couvre les endpoints d’authentification, de réglages de l’appareil, de beamforming, de déclencheur et de journal d’événements, de microphone (sélection, calibration) et de système (supervision, réinitialisation).

Le BATCAM FX2 fournit également une spécification OpenAPI en direct depuis l’appareil : GET http://{device_ip}/api-docs/json

💡 Remarque : le streaming en temps réel WebSocket/Protobuf n’est pas inclus dans la spécification REST. Reportez-vous à Présentation du BATCAM FX et à Exemple Python Protobuf.

Ressources pour développeurs

Les ressources externes telles que les exemples d’intégration C#, le schéma Protobuf (fx-stream-protocol) et les téléchargements de logiciels officiels sont regroupées sur la page Ressources pour développeurs.