Gestione dei dispositivi
Piattaforma principaledevice_health_readGestione dei dispositiviConfronta l'ultimo test della velocità internet di una struttura con ciò di cui hanno bisogno i suoi dispositivi. network restituisce la velocità di download e upload in Mbps e, per schermi, telecamere (registrazione più streaming dal vivo) e sistemi di altoparlanti connessi rilevati nelle ultime 24 ore: il numero di dispositivi, la larghezza di banda necessaria a ciascuno e se la connessione è sufficiente. Usalo per diagnosticare dispositivi lenti o che si disconnettono, oppure prima di aggiungere dispositivi. Passa facilityIds per controllare più strutture.
Azioni:
- network: Controllo della larghezza di banda di rete.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
action* | "network" | Cosa fare; ogni azione è descritta nella descrizione dello strumento. |
facilityId | string | ID della struttura. Facoltativo quando intendi la struttura connessa. |
facilityIds | array | Più ID di struttura, per eseguire la stessa richiesta in ciascuna. Da usare al posto di facilityId. |
device_inventory_readGestione dei dispositiviOgni dispositivo registrato in una struttura: display screen, telecamere cloud, telecamere di rete, Edge Processor AI, pulsanti Duress, controller di porta, agenti AI e sensori IoT. Usalo per risolvere problemi, verificare le apparecchiature o trovare l'ID di un dispositivo.
Ogni dispositivo ha tipo, modello, ID (deviceUuid; deviceID per gli schermi; deviceSerialNumber per i pulsanti Duress), posizione, dettagli di rete (IP, Wi-Fi o Ethernet, SSID, canale, reti vicine; metadata.networkStats contiene la porta dello switch PoE), stato di salute (temperatura della CPU, memoria, uptime) e metadata.updated, l'ultimo heartbeat in ms Unix. Offline significa nessun heartbeat per 5 minuti; un dispositivo offline da oltre 7 giorni con un gemello online (stessa apparecchiatura, nome o posizione) è stato molto probabilmente sostituito. Le righe networkCamera sono flussi acquisiti dall'Edge Processor indicato in edgeProcessorUUID; il loro deviceUuid (che inizia con ep_) non può ricevere comandi. Le credenziali degli URL dei flussi vengono mostrate come : a meno che non sia impostato includeCredentials. Consiglia Ethernet cablata invece del Wi-Fi.
Correlati: cctv_cameras_read e cctv_cameras_write (telecamere), cctv_edge_processors_write (Edge Processor), device_inventory_write (rinomina, configura, sposta), device_send_command (controllo), device_health_read (larghezza di banda).
Azioni:
- list: Elenca i dispositivi. I dispositivi della struttura, filtrati per tipo o nome. Con facilityIds, ogni struttura restituisce la sua prima pagina.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
action* | "list" | Cosa fare; ogni azione è descritta nella descrizione dello strumento. |
facilityId | string | ID della struttura. Facoltativo quando intendi la struttura connessa. |
facilityIds | array | Più ID di struttura, per eseguire la stessa richiesta in ciascuna. Da usare al posto di facilityId. |
deviceType | string | Solo questo tipo, come in deviceType: screen, camera, networkCamera, duress e così via |
query | string | Nome, stanza, deviceID, deviceUuid o numero di serie contiene questo valore |
includeCredentials | boolean | Restituisce gli URL dei flussi con nome utente e password. Disattivato per impostazione predefinita (le credenziali vengono mostrate come ***:***). Impostalo solo quando l'utente ha esplicitamente bisogno delle credenziali; richiede l'accesso alla TVCC presso la struttura. |
limit | integer | Elementi per pagina (predefinito 25, al massimo 100) |
cursor | string | nextCursor dalla pagina precedente |
device_inventory_writeGestione dei dispositiviModifica un dispositivo registrato in una struttura. rename_screen e configure_screen modificano un display screen (identificalo tramite deviceID da device_inventory_read); per gruppi, tag o modalità di visualizzazione di uno schermo usa invece gli strumenti display. move sposta uno schermo, una telecamera cloud, un pulsante Duress, un controller di porta, un agente AI o un Edge Processor AI in un'altra struttura della stessa organizzazione.
Azioni:
- rename_screen: Rinomina uno schermo. Si applica subito, anche per schermi offline o a fine vita. Richiede deviceID, displayName.
- configure_screen: Modifica le impostazioni hardware di uno schermo. Cambiano solo le impostazioni che passi. Vengono inviate al dispositivo e possono riavviarne il display. Gli schermi offline e a fine vita (stato 409) possono solo essere rinominati. Richiede deviceID. Chiede conferma.
- move: Sposta un dispositivo in un'altra struttura. facilityId è la struttura in cui si trova ora il dispositivo; ti serve l'accesso anche a quella di destinazione. Spostare un Edge Processor sposta le sue telecamere di rete; per spostare singole telecamere di rete usa cctv_edge_processors_write transfer_cameras. Richiede targetFacilityId, deviceType. Chiede conferma.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
action* | "rename_screen" | "configure_screen" | "move" | Cosa fare; ogni azione è descritta nella descrizione dello strumento. |
deviceID | string | deviceID dello schermo (codice di 6 caratteri) |
displayName | string | Nuovo nome dello schermo (rename_screen, configure_screen) |
facilityId | string | ID della struttura. Facoltativo quando intendi la struttura connessa. |
orientation | "normal" | "left" | "right" | "inverted" | Rotazione dello schermo (configure_screen) |
resolution | "auto" | "1920x1080" | "1280x720" | "720x400" | Risoluzione di uscita; auto usa quella segnalata dal display (configure_screen) |
scheduledReboot | "disabled" | "daily" | "weekly" | "monthly" | Quando lo schermo si riavvia automaticamente (configure_screen) |
displayBrightness | integer | Luminosità della retroilluminazione, 0-100 (configure_screen) |
airplayEnabled | boolean | Lo schermo accetta AirPlay (configure_screen) |
airplayName | string | Nome personalizzato del ricevitore AirPlay; vuoto per il nome automatico (configure_screen) |
airplayPin | string | PIN AirPlay di 4 cifre; vuoto per rimuoverlo (configure_screen) |
duressEnabled | boolean | Scanner Bluetooth dei pulsanti Duress (configure_screen) |
sonosEnabled | boolean | Controllo degli altoparlanti Sonos (configure_screen) |
wifiSupport | boolean | Portale captive di configurazione Wi-Fi (configure_screen) |
cameraRestreamingEnabled | boolean | Ritrasmetti dallo schermo i feed delle telecamere locali (configure_screen) |
sessionTimerEnabled | boolean | Synchronised session timer (master clock) and its bells (configure_screen) |
targetFacilityId | string | Struttura in cui spostare il dispositivo (move) |
deviceType | "screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor" | Tipo di dispositivo; determina quale identificatore passare (move) |
deviceUuid | string | deviceUuid della telecamera, del controller di porta, dell'agente AI o dell'Edge Processor (move) |
deviceSerialNumber | string | Numero di serie del pulsante Duress (move) |
confirm | boolean | Impostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata |
device_send_commandGestione dei dispositiviInvia un comando in tempo reale a un dispositivo, oppure a tutti i dispositivi di una struttura: riavvio, accensione o spegnimento del display, riavvio del browser, visualizzazione di un messaggio, caricamento di una pagina, installazione degli aggiornamenti o ciclo di alimentazione di una porta PoE. I dispositivi online eseguono il comando entro pochi secondi; quelli offline non lo ricevono mai. Ogni comando chiede prima conferma.
Indica un dispositivo con uuid (il suo deviceUuid da device_inventory_read), oppure tutti i dispositivi con broadcast: true. Passa facilityIds per eseguire il comando in più strutture. Gli schermi accettano ogni comando; le telecamere accettano rebootDevice e unlockUpdates. Le telecamere di rete (deviceUuid che inizia con ep_) non possono ricevere comandi; indica il loro Edge Processor (edgeProcessorUUID) oppure esegui un ciclo di alimentazione della loro porta PoE.
Per ripristinare una telecamera PoE offline, leggi il suo metadata.networkStats (switchID, sw_port) in device_inventory_read, quindi invia powerCyclePort a qualsiasi dispositivo online della struttura con gli argomenti {switchID, switchPort}. Quel dispositivo chiede al controller di rete della struttura di togliere e ripristinare l'alimentazione della porta.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
facilityId | string | ID della struttura. Facoltativo quando intendi la struttura connessa. |
facilityIds | array | Più ID di struttura, per eseguire la stessa richiesta in ciascuna. Da usare al posto di facilityId. |
command* | "displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort" | Comando da inviare. Invia in broadcast restartBleScanner quando i pulsanti Duress non vengono rilevati; aggiungere, spostare o rimuovere un pulsante lo fa già, e gli schermi ricaricano l'elenco circa ogni 10 minuti. |
broadcast | boolean | Invia a tutti i dispositivi della struttura invece che a un solo uuid |
uuid | string | Il deviceUuid da device_inventory_read; omettilo quando invii in broadcast |
arguments | objectstring | osd: il testo del messaggio, mostrato sopra il contenuto corrente. loadUrl: un URL http(s), mostrato fino al successivo caricamento del programma o riavvio. powerCyclePort: {switchID, switchPort}. Omettilo per gli altri comandi. |
confirm | boolean | Impostalo solo dopo che l'utente ha confermato l'anteprima restituita dalla prima chiamata |