Gestion d'appareils
Plateforme principaledevice_health_readGestion d'appareilsCompare le dernier test de débit Internet d'une installation avec les besoins de ses appareils. network renvoie les débits descendant et montant en Mbit/s et, pour les écrans, les caméras (enregistrement et diffusion en direct) et les systèmes d'enceintes connectés vus au cours des dernières 24 heures : le nombre d'appareils, la bande passante requise par chacun et si la connexion est suffisante. Utilisez-le pour diagnostiquer des appareils lents ou qui se déconnectent, ou avant d'ajouter des appareils. Passez facilityIds pour vérifier plusieurs installations.
Actions :
- network : Vérification de la bande passante réseau.
Paramètres
| Nom | Type | Description |
|---|---|---|
action* | "network" | L'action à effectuer ; chaque action est décrite dans la description de l'outil. |
facilityId | string | ID de l'installation. Facultatif lorsque l'installation connectée est celle que vous visez. |
facilityIds | array | Plusieurs ID d'installation, pour exécuter la même requête sur chacune. À utiliser à la place de facilityId. |
device_inventory_readGestion d'appareilsChaque appareil enregistré dans une installation : écrans d'affichage, caméras cloud, caméras réseau, Edge Processors IA, boutons de détresse, contrôleurs de porte, Agents IA et capteurs IoT. Utilisez-le pour diagnostiquer, auditer l'équipement ou trouver l'ID d'un appareil.
Chaque appareil comporte son type, son modèle, ses ID (deviceUuid ; deviceID pour les écrans ; deviceSerialNumber pour les boutons de détresse), son emplacement, ses détails réseau (IP, Wi-Fi ou Ethernet, SSID, canal, réseaux à proximité ; metadata.networkStats indique le port du commutateur PoE), son état (température du CPU, mémoire, temps de fonctionnement) et metadata.updated, le dernier signal de vie en ms Unix. Hors ligne signifie aucun signal de vie pendant 5 minutes ; un appareil hors ligne depuis plus de 7 jours ayant un jumeau en ligne (même équipement, nom ou emplacement) a très probablement été remplacé. Les lignes networkCamera sont des flux récupérés par l'Edge Processor indiqué dans edgeProcessorUUID ; leur deviceUuid (commençant par ep_) ne peut pas recevoir de commandes. Les identifiants des URL de flux s'affichent sous la forme : sauf si includeCredentials est défini. Recommandez l'Ethernet filaire plutôt que le Wi-Fi.
Voir aussi : cctv_cameras_read et cctv_cameras_write (caméras), cctv_edge_processors_write (Edge Processors), device_inventory_write (renommer, configurer, déplacer), device_send_command (contrôle), device_health_read (bande passante).
Actions :
- list : Lister les appareils. Les appareils de l'installation, filtrés par type ou par nom. Avec facilityIds, chaque installation renvoie sa première page.
Paramètres
| Nom | Type | Description |
|---|---|---|
action* | "list" | L'action à effectuer ; chaque action est décrite dans la description de l'outil. |
facilityId | string | ID de l'installation. Facultatif lorsque l'installation connectée est celle que vous visez. |
facilityIds | array | Plusieurs ID d'installation, pour exécuter la même requête sur chacune. À utiliser à la place de facilityId. |
deviceType | string | Uniquement ce type, comme dans deviceType : screen, camera, networkCamera, duress, etc. |
query | string | Le nom, la salle, le deviceID, le deviceUuid ou le numéro de série contient ce texte |
includeCredentials | boolean | Renvoyer les URL des flux avec leur nom d'utilisateur et leur mot de passe. Désactivé par défaut (les identifiants s'affichent sous la forme ***:***). Ne le définissez que lorsque l'utilisateur a explicitement besoin des identifiants ; requiert un accès à la vidéosurveillance dans l'installation. |
limit | integer | Éléments par page (25 par défaut, 100 au maximum) |
cursor | string | nextCursor de la page précédente |
device_inventory_writeGestion d'appareilsModifie un appareil enregistré dans une installation. rename_screen et configure_screen modifient un écran d'affichage (identifiez-le par son deviceID issu de device_inventory_read) ; pour les groupes, tags ou le mode d'affichage d'un écran, utilisez plutôt les outils d'affichage. move déplace un écran, une caméra cloud, un bouton de détresse, un contrôleur de porte, un Agent IA ou un Edge Processor IA vers une autre installation de la même organisation.
Actions :
- rename_screen : Renommer un écran. S'applique immédiatement, y compris pour les écrans hors ligne ou en fin de vie. Requiert deviceID, displayName.
- configure_screen : Modifier les paramètres matériels d'un écran. Seuls les paramètres que vous passez changent. Ils sont envoyés à l'appareil et peuvent redémarrer son affichage. Les écrans hors ligne et en fin de vie (statut 409) peuvent seulement être renommés. Requiert deviceID. Demande une confirmation.
- move : Déplacer un appareil vers une autre installation. facilityId est l'installation où se trouve actuellement l'appareil ; vous devez aussi avoir accès à l'installation cible. Déplacer un Edge Processor déplace ses caméras réseau ; pour déplacer des caméras réseau individuelles, utilisez cctv_edge_processors_write transfer_cameras. Requiert targetFacilityId, deviceType. Demande une confirmation.
Paramètres
| Nom | Type | Description |
|---|---|---|
action* | "rename_screen" | "configure_screen" | "move" | L'action à effectuer ; chaque action est décrite dans la description de l'outil. |
deviceID | string | deviceID de l'écran (code de 6 caractères) |
displayName | string | Nouveau nom de l'écran (rename_screen, configure_screen) |
facilityId | string | ID de l'installation. Facultatif lorsque l'installation connectée est celle que vous visez. |
orientation | "normal" | "left" | "right" | "inverted" | Rotation de l'écran (configure_screen) |
resolution | "auto" | "1920x1080" | "1280x720" | "720x400" | Résolution de sortie ; auto utilise celle que signale l'écran (configure_screen) |
scheduledReboot | "disabled" | "daily" | "weekly" | "monthly" | Quand l'écran redémarre de lui-même (configure_screen) |
displayBrightness | integer | Luminosité du rétroéclairage, 0-100 (configure_screen) |
airplayEnabled | boolean | L'écran accepte AirPlay (configure_screen) |
airplayName | string | Nom personnalisé du récepteur AirPlay ; vide pour le nom automatique (configure_screen) |
airplayPin | string | Code PIN AirPlay à 4 chiffres ; vide pour le supprimer (configure_screen) |
duressEnabled | boolean | Scanner Bluetooth de boutons de détresse (configure_screen) |
sonosEnabled | boolean | Contrôle des enceintes Sonos (configure_screen) |
wifiSupport | boolean | Portail captif de configuration Wi-Fi (configure_screen) |
cameraRestreamingEnabled | boolean | Rediffuser les flux des caméras locales depuis l'écran (configure_screen) |
sessionTimerEnabled | boolean | Synchronised session timer (master clock) and its bells (configure_screen) |
targetFacilityId | string | Installation vers laquelle déplacer l'appareil (move) |
deviceType | "screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor" | Type d'appareil ; il détermine l'identifiant à passer (move) |
deviceUuid | string | deviceUuid de la caméra, du contrôleur de porte, de l'Agent IA ou de l'Edge Processor (move) |
deviceSerialNumber | string | Numéro de série du bouton de détresse (move) |
confirm | boolean | À définir uniquement après que l'utilisateur a confirmé l'aperçu renvoyé par le premier appel |
device_send_commandGestion d'appareilsEnvoie une commande en direct à un appareil, ou à tous les appareils d'une installation : redémarrer, allumer ou éteindre l'affichage, redémarrer le navigateur, afficher un message, charger une page, installer des mises à jour ou effectuer un cycle d'alimentation d'un port PoE. Les appareils en ligne agissent en quelques secondes ; les appareils hors ligne ne la reçoivent jamais. Chaque commande demande d'abord une confirmation.
Ciblez un appareil avec uuid (son deviceUuid issu de device_inventory_read), ou tous les appareils avec broadcast: true. Passez facilityIds pour exécuter dans plusieurs installations. Les écrans acceptent toutes les commandes ; les caméras acceptent rebootDevice et unlockUpdates. Les caméras réseau (deviceUuid commençant par ep_) ne peuvent pas recevoir de commandes ; ciblez leur Edge Processor (edgeProcessorUUID) ou effectuez un cycle d'alimentation de leur port PoE.
Pour remettre en ligne une caméra PoE hors ligne, lisez son metadata.networkStats (switchID, sw_port) dans device_inventory_read, puis envoyez powerCyclePort à n'importe quel appareil en ligne de l'installation avec les arguments {switchID, switchPort}. Cet appareil demande au contrôleur réseau de l'installation de couper puis de rétablir l'alimentation du port.
Paramètres
| Nom | Type | Description |
|---|---|---|
facilityId | string | ID de l'installation. Facultatif lorsque l'installation connectée est celle que vous visez. |
facilityIds | array | Plusieurs ID d'installation, pour exécuter la même requête sur chacune. À utiliser à la place de facilityId. |
command* | "displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort" | Commande à envoyer. Diffusez restartBleScanner lorsque les boutons de détresse ne sont pas détectés ; l'ajout, le déplacement ou la suppression d'un bouton le fait déjà, et les écrans rechargent la liste environ toutes les 10 minutes. |
broadcast | boolean | Envoyer à tous les appareils de l'installation au lieu d'un seul uuid |
uuid | string | Le deviceUuid issu de device_inventory_read ; omettez-le lors d'une diffusion |
arguments | objectstring | osd : le texte du message, affiché par-dessus le contenu actuel. loadUrl : une URL http(s), affichée jusqu'au prochain chargement de programme ou redémarrage. powerCyclePort : {switchID, switchPort}. Omettez pour les autres commandes. |
confirm | boolean | À définir uniquement après que l'utilisateur a confirmé l'aperçu renvoyé par le premier appel |