Aller au contenu
SMI Developer Center

Ressources développeur

Cette page rassemble les ressources officielles nécessaires au développement d’intégrations avec la série BATCAM FX et FX Viewer. Elle fournit la référence d’API (playground), les dépôts d’exemples publics, les schémas de protocole et les liens de téléchargement des logiciels. Pour connaître l’état le plus récent de chaque ressource, consultez le dépôt et la documentation associés.

Référence d’API & playground

Pour l’API REST embarquée de chaque produit, vous pouvez explorer les endpoints et les appeler directement depuis le playground basé sur la spécification OpenAPI. Sur les deux produits, c’est l’appareil lui-même qui sert l’API.

ProduitRéférence d’APIAuthentificationAdresse IP par défaut de l’appareil
BATCAM FXPlayground de l’API FXHTTP Basic192.168.0.30
BATCAM FX2Playground de l’API FX2HTTP Basic ou Bearer (JWT)192.168.0.80

  • Certains endpoints de BATCAM FX (overlay, ROS) ne sont disponibles qu’avec le firmware 1.0.3 ou supérieur.

  • Sur BATCAM FX2, la spécification en direct peut être consultée directement depuis l’appareil : GET http://{device_ip}/api-docs/json

  • Le streaming audio/beamforming en temps réel (WebSocket + Protobuf) n’est pas inclus dans la spécification REST. Reportez-vous aux sections Exemples de code·Définitions de protocole ci-dessous.

💡 Remarque : le mot de passe du compte par défaut configuré en sortie d’usine doit impérativement être modifié lors de la première connexion.

Routage documentaire produit × interface

Selon l’interface que vous souhaitez intégrer, accédez au document correspondant à partir du tableau ci-dessous.

InterfaceBATCAM FXBATCAM FX2FX Viewer
API RESTPlaygroundPlayground–
Flux temps réel (WebSocket + Protobuf, RTSP)Vue d’ensemble du flux de donnéesExemple Python Protobuf–
ROS 2ROS Integration––
ONVIF–ONVIF–
Modbus TCP––Intégration Modbus
Interface web de gestion des appareils–Gestionnaire d’appareils–
FX Cloud–Connexion FX Cloud–
Mise à jour logicielleMise à jour logicielle par le webMise à jour logicielledownload.smins.kr
Notes de version du firmwareNotes de versionNotes de version–

Exemples de code

ExempleProduit concernéLangageContenu traité
fx-api-example-csharp (GitHub)BATCAM FXC#Réception du flux WebSocket → décodage Protobuf → composition de l’overlay avec la vidéo RTSP. Exemple GUI inclus
batcam-fx-python-protobuf-example (GitHub)BATCAM FX · FX2PythonInterrogation de l’état via REST, Subscribe WebSocket, analyse des messages Protobuf (Beamforming / Audio / LPoint / Prpd)

  • Les explications pas à pas de l’exemple Python (configuration de l’environnement, génération des bindings, réception par type de message, changements FX2) sont fournies sur la page Exemple Python Protobuf de la documentation développeur FX2.

  • Lors de la connexion WebSocket, le SubProtocol doit être défini sur Subscribe ; une fois la connexion établie, la réception des données ne démarre qu’après l’envoi d’une demande d’abonnement au moyen d’un objet Subscribe.

  • La connexion WebSocket requiert elle aussi une authentification de l’utilisateur, tout comme RTSP. Si la bibliothèque ne prend pas en charge l’authentification, vous devez inclure dans l’en-tête Authorization la valeur {username}:{password} encodée en base64. Pour plus de détails, reportez-vous à la vue d’ensemble de la documentation développeur BATCAM FX.

Définitions de protocole

Les dépôts d’exemples sont publiés sur GitHub (SM-Instruments-Inc) et les dépôts de définitions de protocole sur le GitLab OSS (smins-oss).

DépôtContenu
fx-stream-protocol (GitLab)Schéma Protobuf et fichiers pré-générés utilisés pour l’encodage/décodage des données de flux FX. Le schéma canonique est fx-protocol-2.proto ; il sert de référence pour la génération des bindings de chaque langage.
fx-stream-msgs (GitLab)Définitions des types d’interfaces (messages) ROS 2 utilisés par BATCAM FX pour l’émission des données. Pour la spécification détaillée, reportez-vous au document ROS Integration.

Voici un exemple de génération de bindings Python à partir du schéma.

Fenêtre de terminal
# Installation de protoc (macOS / Homebrew)
brew install protobuf


# Génération des bindings Python
protoc --python_out=. fx-protocol-2.proto

Téléchargement des logiciels

Les logiciels distribués officiellement, tels que FX Viewer, peuvent être téléchargés depuis le hub de téléchargement download.smins.kr. Pour l’historique des modifications du firmware de l’appareil, consultez les notes de version de chaque produit (BATCAM FX, BATCAM FX2).

Documents associés