Apparaatbeheer

Kernplatform
device_health_readApparaatbeheer

Vergelijkt de laatste internetsnelheidstest van een faciliteit met wat de apparaten nodig hebben. network retourneert de download- en uploadsnelheid in Mbps, en voor schermen, camera's (opname plus livestreaming) en verbonden luidsprekersystemen die in de afgelopen 24 uur zijn gezien: het aantal apparaten, de bandbreedte die elk nodig heeft en of de verbinding volstaat. Gebruik dit om trage of wegvallende apparaten te diagnosticeren, of voordat je apparaten toevoegt. Geef facilityIds mee om meerdere faciliteiten te controleren.

Acties:

  • network: Controle van de netwerkbandbreedte.

Parameters

NaamTypeBeschrijving
action*"network"Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving.
facilityIdstringFaciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt.
facilityIdsarrayMeerdere faciliteit-ID's, om hetzelfde verzoek bij elk ervan uit te voeren. Gebruik dit in plaats van facilityId.
device_inventory_readApparaatbeheer

Elk apparaat dat bij een faciliteit is geregistreerd: Display Screens, cloudcamera's, netwerkcamera's, AI Edge Processors, duress-knoppen, deurcontrollers, AI-agents en IoT-sensoren. Gebruik dit om problemen op te lossen, apparatuur te controleren of de ID van een apparaat te vinden.

Elk apparaat heeft een type, model, ID's (deviceUuid; deviceID voor schermen; deviceSerialNumber voor duress-knoppen), locatie, netwerkgegevens (IP, Wi-Fi of Ethernet, SSID, kanaal, netwerken in de buurt; metadata.networkStats bevat de poort op de PoE-switch), status (CPU-temperatuur, geheugen, uptime) en metadata.updated, de laatste heartbeat in Unix-ms. Offline betekent 5 minuten geen heartbeat; een apparaat dat meer dan 7 dagen offline is en een online tegenhanger heeft (dezelfde apparatuur, naam of locatie), is waarschijnlijk vervangen. Regels met networkCamera zijn streams die de Edge Processor in edgeProcessorUUID ophaalt; hun deviceUuid (beginnend met ep_) kan geen opdrachten ontvangen. Inloggegevens in stream-URL's worden getoond als :, tenzij includeCredentials is ingesteld. Raad bekabeld Ethernet aan boven Wi-Fi.

Gerelateerd: cctv_cameras_read en cctv_cameras_write (camera's), cctv_edge_processors_write (Edge Processors), device_inventory_write (hernoemen, configureren, verplaatsen), device_send_command (bediening), device_health_read (bandbreedte).

Acties:

  • list: Apparaten weergeven. Apparaten bij de faciliteit, gefilterd op type of naam. Met facilityIds retourneert elke faciliteit de eerste pagina.

Parameters

NaamTypeBeschrijving
action*"list"Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving.
facilityIdstringFaciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt.
facilityIdsarrayMeerdere faciliteit-ID's, om hetzelfde verzoek bij elk ervan uit te voeren. Gebruik dit in plaats van facilityId.
deviceTypestringAlleen dit type, zoals in deviceType: screen, camera, networkCamera, duress enzovoort
querystringNaam, ruimte, deviceID, deviceUuid of serienummer bevat dit
includeCredentialsbooleanStream-URL's retourneren met gebruikersnaam en wachtwoord. Standaard uit (inloggegevens worden getoond als ***:***). Stel dit alleen in als de gebruiker de inloggegevens uitdrukkelijk nodig heeft; vereist camerabewakingstoegang bij de faciliteit.
limitintegerItems per pagina (standaard 25, maximaal 100)
cursorstringnextCursor van de vorige pagina
device_inventory_writeApparaatbeheer

Wijzigt een apparaat dat bij een faciliteit is geregistreerd. rename_screen en configure_screen wijzigen een scherm (identificeer het met deviceID uit device_inventory_read); gebruik voor groepen, tags of weergavemodus van een scherm de displaytools. move verplaatst een scherm, cloudcamera, duress-knop, deurcontroller, AI-agent of AI Edge Processor naar een andere faciliteit in dezelfde organisatie.

Acties:

  • rename_screen: Een scherm hernoemen. Wordt direct toegepast, ook voor offline schermen of schermen aan het einde van hun levensduur. Vereist deviceID, displayName.
  • configure_screen: De hardware-instellingen van een scherm wijzigen. Alleen de instellingen die je meegeeft veranderen. Ze worden naar het apparaat gepusht en kunnen de weergave opnieuw starten. Offline schermen en schermen aan het einde van hun levensduur (status 409) kunnen alleen worden hernoemd. Vereist deviceID. Vraagt om bevestiging.
  • move: Een apparaat naar een andere faciliteit verplaatsen. facilityId is waar het apparaat nu staat; je hebt ook toegang tot de doelfaciliteit nodig. Een Edge Processor verplaatsen verplaatst ook de netwerkcamera's ervan; gebruik cctv_edge_processors_write transfer_cameras om losse netwerkcamera's te verplaatsen. Vereist targetFacilityId, deviceType. Vraagt om bevestiging.

Parameters

NaamTypeBeschrijving
action*"rename_screen" | "configure_screen" | "move"Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving.
deviceIDstringdeviceID van het scherm (code van 6 tekens)
displayNamestringNieuwe schermnaam (rename_screen, configure_screen)
facilityIdstringFaciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt.
orientation"normal" | "left" | "right" | "inverted"Schermrotatie (configure_screen)
resolution"auto" | "1920x1080" | "1280x720" | "720x400"Uitvoerresolutie; auto gebruikt wat het beeldscherm meldt (configure_screen)
scheduledReboot"disabled" | "daily" | "weekly" | "monthly"Wanneer het scherm zichzelf herstart (configure_screen)
displayBrightnessintegerHelderheid van de achtergrondverlichting, 0-100 (configure_screen)
airplayEnabledbooleanScherm accepteert AirPlay (configure_screen)
airplayNamestringEigen naam voor de AirPlay-ontvanger; leeg voor de automatische naam (configure_screen)
airplayPinstringAirPlay-pincode van 4 cijfers; leeg om te verwijderen (configure_screen)
duressEnabledbooleanBluetooth-scanner voor duress-knoppen (configure_screen)
sonosEnabledbooleanBediening van Sonos-luidsprekers (configure_screen)
wifiSupportbooleanCaptive portal voor het instellen van Wi-Fi (configure_screen)
cameraRestreamingEnabledbooleanLokale camerafeeds opnieuw streamen vanaf het scherm (configure_screen)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (configure_screen)
targetFacilityIdstringFaciliteit waarnaar het apparaat moet (move)
deviceType"screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor"Soort apparaat; bepaalt welke identificatie je meegeeft (move)
deviceUuidstringdeviceUuid van de camera, deurcontroller, AI-agent of Edge Processor (move)
deviceSerialNumberstringSerienummer van de duress-knop (move)
confirmbooleanAlleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd
device_send_commandApparaatbeheer

Stuurt een live opdracht naar één apparaat, of naar elk apparaat bij een faciliteit: herstarten, weergave aan of uit, de browser herstarten, een bericht tonen, een pagina laden, updates installeren of een PoE-poort uit- en weer aanzetten. Online apparaten voeren de opdracht binnen enkele seconden uit; offline apparaten ontvangen hem nooit. Elke opdracht vraagt eerst om bevestiging.

Richt je op één apparaat met uuid (de deviceUuid uit device_inventory_read), of op elk apparaat met broadcast: true. Geef facilityIds mee om bij meerdere faciliteiten uit te voeren. Schermen accepteren elke opdracht; camera's accepteren rebootDevice en unlockUpdates. Netwerkcamera's (deviceUuid beginnend met ep_) kunnen geen opdrachten ontvangen; richt je op hun Edge Processor (edgeProcessorUUID) of zet hun PoE-poort uit en weer aan.

Om een offline PoE-camera terug te krijgen, lees je de metadata.networkStats (switchID, sw_port) ervan in device_inventory_read en stuur je powerCyclePort naar een willekeurig online apparaat bij de faciliteit met de argumenten {switchID, switchPort}. Dat apparaat vraagt de netwerkcontroller van de faciliteit de stroom op de poort te onderbreken en te herstellen.

Parameters

NaamTypeBeschrijving
facilityIdstringFaciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt.
facilityIdsarrayMeerdere faciliteit-ID's, om hetzelfde verzoek bij elk ervan uit te voeren. Gebruik dit in plaats van facilityId.
command*"displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort"Te versturen opdracht. Stuur restartBleScanner naar alle apparaten als duress-knoppen niet worden gedetecteerd; een knop toevoegen, verplaatsen of verwijderen doet dit al, en schermen laden de lijst ongeveer elke 10 minuten opnieuw.
broadcastbooleanNaar elk apparaat bij de faciliteit sturen in plaats van naar één uuid
uuidstringDe deviceUuid uit device_inventory_read; weglaten bij broadcast
argumentsobjectstringosd: de berichttekst, getoond over de huidige content. loadUrl: een http(s)-URL, getoond tot het volgende laden van een programma of de volgende herstart. powerCyclePort: {switchID, switchPort}. Weglaten bij andere opdrachten.
confirmbooleanAlleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd