Cet article est dédié aux intégrateurs et administrateurs de Miris Box qui ont besoin de piloter les stations grâce à l'API Miris.

Pour rappel, cette API est accessible via HTTP, Websockets et TCP (sur le port 6666 par défaut). Elle est également disponible via RS232 si elle est activée et si le matériel le permet.

Voyons maintenant comment vérifier que la connexion vers la Miris Box en TCP est fonctionnelle.

L'utilisation du terminal virtuel est requise pour pouvoir lancer une commande de test de connexion TCP 

Prérequis

Tout d'abord, activez l'API Miris TCP via l'onglet Paramètres > Configuration > Paramètres avancés > API : 

Test de connexion TCP

Une fois l'API activée, connectez-vous au terminal de la station Miris en vous appuyant sur une autre Miris Box présente dans le même sous-réseau. La lecture de l'article "Diagnostic Miris", au chapitre  "Ligne de commande" vous aidera à réaliser cette connexion.

Par exemple, si le mot de passe du compte ubicast est admin, nous pouvons entrer la ligne de commande ci-dessous avec l'IP de la station Miris (ici 10.0.0.7) pour laquelle l'API TCP a été activée. Dans ce cas, nous utiliserons l'appel d'API Miris /api/system/get_state qui permet de récupérer des informations sur l'état de la station :

echo "/api/system/get_state*token=$(echo -n admin | sha1sum | awk -e '{print $1}')\r" | socat - tcp:10.0.0.7:6666

Si la connexion est établie, la réponse sera semblable à la ligne ci-dessous :

/api/system/get_state*success=True*time=2024-07-26T14:53:39.410929+02:00*free_space_bytes=90803716096*total_space_bytes=97373327360*hostname=ubi-box-54b2030ea259*friendly_name=ubi-box-54b2030ea259*gpu_connected=False*filesystems_dirty=False*settings_locked=False

Si le mot de passe est incorrect, ce message sera renvoyé :

/api/system/get_state*success=False*error=Authentication error

Nous espérons que cet article vous aura été utile. N'hésitez pas à consulter la documentation sur la configuration des profils d'enregistrement pour approfondir le sujet.