Geräteverwaltung

Kernplattform
device_health_readGeräteverwaltung

Vergleicht den letzten Internet-Geschwindigkeitstest einer Einrichtung mit dem Bedarf ihrer Geräte. network gibt die Download- und Upload-Geschwindigkeit in Mbps zurück und für Bildschirme, Kameras (Aufzeichnung plus Live-Streaming) und verbundene Lautsprechersysteme, die in den letzten 24 Stunden erfasst wurden: die Geräteanzahl, die jeweils benötigte Bandbreite und ob die Verbindung ausreicht. Verwenden Sie dies, um langsame oder abbrechende Geräte zu diagnostizieren oder bevor Sie Geräte hinzufügen. Übergeben Sie facilityIds, um mehrere Einrichtungen zu prüfen.

Aktionen:

  • network: Prüfung der Netzwerkbandbreite.

Parameter

NameTypBeschreibung
action*"network"Was getan werden soll; jede Aktion ist in der Tool-Beschreibung erläutert.
facilityIdstringEinrichtungs-ID. Optional, wenn die verbundene Einrichtung gemeint ist.
facilityIdsarrayMehrere Einrichtungs-IDs, um dieselbe Anfrage für jede auszuführen. Anstelle von facilityId verwenden.
device_inventory_readGeräteverwaltung

Jedes für eine Einrichtung registrierte Gerät: Bildschirme, Cloud-Kameras, Netzwerkkameras, KI-Edge Processors, Duress-Tasten, Türcontroller, KI-Agenten und IoT-Sensoren. Verwenden Sie dies zur Fehlerbehebung, zur Bestandsprüfung oder um die ID eines Geräts zu finden.

Jedes Gerät hat Typ, Modell, IDs (deviceUuid; deviceID für Bildschirme; deviceSerialNumber für Duress-Tasten), Standort, Netzwerkdetails (IP, Wi-Fi oder Ethernet, SSID, Kanal, Netzwerke in der Nähe; metadata.networkStats enthält den PoE-Switch-Port), Zustand (CPU-Temperatur, Arbeitsspeicher, Betriebszeit) und metadata.updated, den letzten Heartbeat in Unix-ms. Offline bedeutet seit 5 Minuten kein Heartbeat; ein Gerät, das seit über 7 Tagen offline ist und einen Online-Zwilling hat (gleiche Ausstattung, gleicher Name oder Standort), wurde höchstwahrscheinlich ersetzt. networkCamera-Zeilen sind Streams, die der Edge Processor in edgeProcessorUUID abruft; ihre deviceUuid (beginnend mit ep_) kann keine Befehle empfangen. Zugangsdaten in Stream-URLs erscheinen als :, sofern includeCredentials nicht gesetzt ist. Empfehlen Sie kabelgebundenes Ethernet statt Wi-Fi.

Verwandt: cctv_cameras_read und cctv_cameras_write (Kameras), cctv_edge_processors_write (Edge Processors), device_inventory_write (umbenennen, konfigurieren, verschieben), device_send_command (steuern), device_health_read (Bandbreite).

Aktionen:

  • list: Geräte auflisten. Geräte an der Einrichtung, gefiltert nach Typ oder Name. Mit facilityIds gibt jede Einrichtung ihre erste Seite zurück.

Parameter

NameTypBeschreibung
action*"list"Was getan werden soll; jede Aktion ist in der Tool-Beschreibung erläutert.
facilityIdstringEinrichtungs-ID. Optional, wenn die verbundene Einrichtung gemeint ist.
facilityIdsarrayMehrere Einrichtungs-IDs, um dieselbe Anfrage für jede auszuführen. Anstelle von facilityId verwenden.
deviceTypestringNur dieser Typ, wie in deviceType: screen, camera, networkCamera, duress usw.
querystringName, Raum, deviceID, deviceUuid oder Seriennummer enthält diesen Text
includeCredentialsbooleanStream-URLs mit Benutzername und Passwort zurückgeben. Standardmäßig deaktiviert (Zugangsdaten erscheinen als ***:***). Setzen Sie dies nur, wenn der Benutzer die Zugangsdaten ausdrücklich benötigt; erfordert Videoüberwachungszugriff an der Einrichtung.
limitintegerEinträge pro Seite (Standard 25, höchstens 100)
cursorstringnextCursor der vorherigen Seite
device_inventory_writeGeräteverwaltung

Ändert ein für eine Einrichtung registriertes Gerät. rename_screen und configure_screen ändern einen Bildschirm (identifiziert über die deviceID aus device_inventory_read); für Gruppen, Tags oder Anzeigemodus eines Bildschirms verwenden Sie stattdessen die Display-Tools. move verschiebt einen Bildschirm, eine Cloud-Kamera, eine Duress-Taste, einen Türcontroller, einen KI-Agenten oder einen KI-Edge Processor in eine andere Einrichtung derselben Organisation.

Aktionen:

  • rename_screen: Bildschirm umbenennen. Wird sofort wirksam, auch für Bildschirme, die offline sind oder das Ende ihres Lebenszyklus erreicht haben. Erfordert deviceID, displayName.
  • configure_screen: Hardwareeinstellungen eines Bildschirms ändern. Nur die übergebenen Einstellungen ändern sich. Sie werden an das Gerät übertragen und können dessen Anzeige neu starten. Bildschirme, die offline sind oder das Ende ihres Lebenszyklus erreicht haben (Status 409), können nur umbenannt werden. Erfordert deviceID. Fordert eine Bestätigung an.
  • move: Gerät in eine andere Einrichtung verschieben. facilityId ist der aktuelle Standort des Geräts; Sie benötigen auch Zugriff auf das Ziel. Beim Verschieben eines Edge Processors werden seine Netzwerkkameras mit verschoben; um einzelne Netzwerkkameras zu verschieben, verwenden Sie cctv_edge_processors_write transfer_cameras. Erfordert targetFacilityId, deviceType. Fordert eine Bestätigung an.

Parameter

NameTypBeschreibung
action*"rename_screen" | "configure_screen" | "move"Was getan werden soll; jede Aktion ist in der Tool-Beschreibung erläutert.
deviceIDstringdeviceID des Bildschirms (6-stelliger Code)
displayNamestringNeuer Bildschirmname (rename_screen, configure_screen)
facilityIdstringEinrichtungs-ID. Optional, wenn die verbundene Einrichtung gemeint ist.
orientation"normal" | "left" | "right" | "inverted"Bildschirmdrehung (configure_screen)
resolution"auto" | "1920x1080" | "1280x720" | "720x400"Ausgabeauflösung; auto verwendet den vom Display gemeldeten Wert (configure_screen)
scheduledReboot"disabled" | "daily" | "weekly" | "monthly"Wann der Bildschirm sich selbst neu startet (configure_screen)
displayBrightnessintegerHelligkeit der Hintergrundbeleuchtung, 0-100 (configure_screen)
airplayEnabledbooleanBildschirm akzeptiert AirPlay (configure_screen)
airplayNamestringBenutzerdefinierter AirPlay-Empfängername; leer für den automatischen Namen (configure_screen)
airplayPinstring4-stellige AirPlay-PIN; leer zum Entfernen (configure_screen)
duressEnabledbooleanBluetooth-Scanner für Duress-Tasten (configure_screen)
sonosEnabledbooleanSonos-Lautsprechersteuerung (configure_screen)
wifiSupportbooleanCaptive-Portal für die Wi-Fi-Einrichtung (configure_screen)
cameraRestreamingEnabledbooleanLokale Kamerafeeds vom Bildschirm aus weiterstreamen (configure_screen)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (configure_screen)
targetFacilityIdstringEinrichtung, in die das Gerät verschoben wird (move)
deviceType"screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor"Geräteart; bestimmt, welche Kennung übergeben wird (move)
deviceUuidstringdeviceUuid von Kamera, Türcontroller, KI-Agent oder Edge Processor (move)
deviceSerialNumberstringSeriennummer der Duress-Taste (move)
confirmbooleanErst setzen, nachdem der Benutzer die vom ersten Aufruf zurückgegebene Vorschau bestätigt hat
device_send_commandGeräteverwaltung

Sendet einen Live-Befehl an ein Gerät oder an jedes Gerät einer Einrichtung: neu starten, Display ein oder aus, Browser neu starten, Nachricht anzeigen, Seite laden, Updates installieren oder einen PoE-Port aus- und wieder einschalten. Online-Geräte reagieren innerhalb von Sekunden; Offline-Geräte erhalten den Befehl nie. Für jeden Befehl wird zuerst eine Bestätigung angefordert.

Zielen Sie mit uuid (der deviceUuid aus device_inventory_read) auf ein Gerät oder mit broadcast: true auf alle Geräte. Übergeben Sie facilityIds, um den Befehl an mehreren Einrichtungen auszuführen. Bildschirme akzeptieren jeden Befehl; Kameras akzeptieren rebootDevice und unlockUpdates. Netzwerkkameras (deviceUuid beginnend mit ep_) können keine Befehle empfangen; zielen Sie auf ihren Edge Processor (edgeProcessorUUID) oder schalten Sie ihren PoE-Port aus und wieder ein.

Um eine Offline-PoE-Kamera wieder in Betrieb zu nehmen, lesen Sie ihre metadata.networkStats (switchID, sw_port) in device_inventory_read und senden Sie dann powerCyclePort mit den Argumenten {switchID, switchPort} an ein beliebiges Online-Gerät der Einrichtung. Dieses Gerät weist den Netzwerkcontroller der Einrichtung an, die Stromversorgung des Ports zu trennen und wiederherzustellen.

Parameter

NameTypBeschreibung
facilityIdstringEinrichtungs-ID. Optional, wenn die verbundene Einrichtung gemeint ist.
facilityIdsarrayMehrere Einrichtungs-IDs, um dieselbe Anfrage für jede auszuführen. Anstelle von facilityId verwenden.
command*"displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort"Zu sendender Befehl. Senden Sie restartBleScanner per Broadcast, wenn Duress-Tasten nicht erkannt werden; Hinzufügen, Verschieben oder Entfernen einer Taste erledigt dies bereits, und Bildschirme laden die Liste etwa alle 10 Minuten neu.
broadcastbooleanAn jedes Gerät der Einrichtung statt an eine uuid senden
uuidstringDie deviceUuid aus device_inventory_read; beim Broadcast weglassen
argumentsobjectstringosd: der Nachrichtentext, über dem aktuellen Inhalt angezeigt. loadUrl: eine http(s)-URL, angezeigt bis zum nächsten Programmladen oder Neustart. powerCyclePort: {switchID, switchPort}. Bei anderen Befehlen weglassen.
confirmbooleanErst setzen, nachdem der Benutzer die vom ersten Aufruf zurückgegebene Vorschau bestätigt hat