Zarządzanie urządzeniami

Platforma podstawowa
device_health_readZarządzanie urządzeniami

Porównuje najnowszy test prędkości internetu w obiekcie z wymaganiami jego urządzeń. network zwraca prędkość pobierania i wysyłania w Mb/s oraz — dla ekranów, kamer (nagrywanie i transmisja na żywo) i podłączonych systemów głośników widzianych w ciągu ostatnich 24 godzin — liczbę urządzeń, przepustowość potrzebną każdemu z nich i informację, czy połączenie wystarcza. Użyj tego do diagnozowania wolnych lub rozłączających się urządzeń albo przed dodaniem urządzeń. Przekaż facilityIds, aby sprawdzić kilka obiektów.

Akcje:

  • network: Sprawdzenie przepustowości sieci.

Parametry

NazwaTypOpis
action*"network"Co zrobić; każda akcja jest opisana w opisie narzędzia.
facilityIdstringIdentyfikator obiektu. Opcjonalny, jeśli chodzi o połączony obiekt.
facilityIdsarrayKilka identyfikatorów obiektów, aby wykonać to samo żądanie w każdym z nich. Używaj zamiast facilityId.
device_inventory_readZarządzanie urządzeniami

Każde urządzenie zarejestrowane w obiekcie: ekrany wyświetlające, kamery chmurowe, kamery sieciowe, urządzenia Edge Processor, przyciski napadowe, kontrolery drzwi, agenty AI i czujniki IoT. Użyj tego do rozwiązywania problemów, audytu sprzętu lub znalezienia identyfikatora urządzenia.

Każde urządzenie ma typ, model, identyfikatory (deviceUuid; deviceID dla ekranów; deviceSerialNumber dla przycisków napadowych), lokalizację, dane sieciowe (IP, Wi-Fi lub Ethernet, SSID, kanał, pobliskie sieci; metadata.networkStats zawiera port przełącznika PoE), stan (temperatura CPU, pamięć, czas pracy) oraz metadata.updated, czyli ostatni sygnał heartbeat w ms Unix. Offline oznacza brak sygnału heartbeat przez 5 minut; urządzenie offline dłużej niż 7 dni, które ma bliźniaka online (ten sam sprzęt, nazwa lub lokalizacja), zostało najprawdopodobniej wymienione. Wiersze networkCamera to strumienie pobierane przez Edge Processor wskazany w edgeProcessorUUID; ich deviceUuid (zaczynający się od ep_) nie może odbierać poleceń. Dane uwierzytelniające w adresach URL strumieni są widoczne jako :, chyba że ustawiono includeCredentials. Zalecaj przewodowe połączenie Ethernet zamiast Wi-Fi.

Powiązane: cctv_cameras_read i cctv_cameras_write (kamery), cctv_edge_processors_write (urządzenia Edge Processor), device_inventory_write (zmiana nazwy, konfiguracja, przenoszenie), device_send_command (sterowanie), device_health_read (przepustowość).

Akcje:

  • list: Lista urządzeń. Urządzenia w obiekcie, filtrowane według typu lub nazwy. Z facilityIds każdy obiekt zwraca swoją pierwszą stronę.

Parametry

NazwaTypOpis
action*"list"Co zrobić; każda akcja jest opisana w opisie narzędzia.
facilityIdstringIdentyfikator obiektu. Opcjonalny, jeśli chodzi o połączony obiekt.
facilityIdsarrayKilka identyfikatorów obiektów, aby wykonać to samo żądanie w każdym z nich. Używaj zamiast facilityId.
deviceTypestringTylko ten typ, jak w deviceType: screen, camera, networkCamera, duress i tak dalej
querystringNazwa, pomieszczenie, deviceID, deviceUuid lub numer seryjny zawiera ten tekst
includeCredentialsbooleanZwróć adresy URL strumieni z nazwą użytkownika i hasłem. Domyślnie wyłączone (dane uwierzytelniające są widoczne jako ***:***). Ustawiaj tylko wtedy, gdy użytkownik wyraźnie potrzebuje danych uwierzytelniających; wymaga dostępu do CCTV w obiekcie.
limitintegerLiczba elementów na stronę (domyślnie 25, maksymalnie 100)
cursorstringnextCursor z poprzedniej strony
device_inventory_writeZarządzanie urządzeniami

Zmienia urządzenie zarejestrowane w obiekcie. rename_screen i configure_screen zmieniają ekran wyświetlający (wskaż go za pomocą deviceID z device_inventory_read); do grup, tagów lub trybu wyświetlania ekranu używaj zamiast tego narzędzi display. move przenosi ekran, kamerę chmurową, przycisk napadowy, kontroler drzwi, agenta AI lub Edge Processor do innego obiektu w tej samej organizacji.

Akcje:

  • rename_screen: Zmiana nazwy ekranu. Stosowana od razu, także dla ekranów offline lub wycofanych ze wsparcia. Wymaga: deviceID, displayName.
  • configure_screen: Zmiana ustawień sprzętowych ekranu. Zmieniają się tylko przekazane ustawienia. Są wysyłane do urządzenia i mogą zrestartować jego wyświetlacz. Ekranom offline i wycofanym ze wsparcia (status 409) można tylko zmienić nazwę. Wymaga: deviceID. Prosi o potwierdzenie.
  • move: Przeniesienie urządzenia do innego obiektu. facilityId to obiekt, w którym urządzenie jest teraz; potrzebny jest też dostęp do obiektu docelowego. Przeniesienie urządzenia Edge Processor przenosi jego kamery sieciowe; aby przenieść pojedyncze kamery sieciowe, użyj cctv_edge_processors_write transfer_cameras. Wymaga: targetFacilityId, deviceType. Prosi o potwierdzenie.

Parametry

NazwaTypOpis
action*"rename_screen" | "configure_screen" | "move"Co zrobić; każda akcja jest opisana w opisie narzędzia.
deviceIDstringdeviceID ekranu (6-znakowy kod)
displayNamestringNowa nazwa ekranu (rename_screen, configure_screen)
facilityIdstringIdentyfikator obiektu. Opcjonalny, jeśli chodzi o połączony obiekt.
orientation"normal" | "left" | "right" | "inverted"Obrót ekranu (configure_screen)
resolution"auto" | "1920x1080" | "1280x720" | "720x400"Rozdzielczość wyjściowa; auto używa wartości zgłaszanej przez wyświetlacz (configure_screen)
scheduledReboot"disabled" | "daily" | "weekly" | "monthly"Kiedy ekran sam się restartuje (configure_screen)
displayBrightnessintegerJasność podświetlenia, 0–100 (configure_screen)
airplayEnabledbooleanEkran akceptuje AirPlay (configure_screen)
airplayNamestringNiestandardowa nazwa odbiornika AirPlay; pusta wartość oznacza nazwę automatyczną (configure_screen)
airplayPinstring4-cyfrowy PIN AirPlay; pusta wartość usuwa PIN (configure_screen)
duressEnabledbooleanSkaner przycisków napadowych Bluetooth (configure_screen)
sonosEnabledbooleanSterowanie głośnikami Sonos (configure_screen)
wifiSupportbooleanPortal konfiguracji Wi-Fi typu captive (configure_screen)
cameraRestreamingEnabledbooleanRetransmisja lokalnych obrazów z kamer z ekranu (configure_screen)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (configure_screen)
targetFacilityIdstringObiekt, do którego ma zostać przeniesione urządzenie (move)
deviceType"screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor"Rodzaj urządzenia; decyduje o tym, który identyfikator przekazać (move)
deviceUuidstringdeviceUuid kamery, kontrolera drzwi, agenta AI lub urządzenia Edge Processor (move)
deviceSerialNumberstringNumer seryjny przycisku napadowego (move)
confirmbooleanUstaw dopiero wtedy, gdy użytkownik potwierdzi podgląd zwrócony przez pierwsze wywołanie
device_send_commandZarządzanie urządzeniami

Wysyła polecenie na żywo do jednego urządzenia lub do każdego urządzenia w obiekcie: restart, włączenie lub wyłączenie wyświetlacza, restart przeglądarki, wyświetlenie komunikatu, załadowanie strony, instalacja aktualizacji lub cykl zasilania portu PoE. Urządzenia online reagują w ciągu kilku sekund; urządzenia offline nigdy go nie otrzymują. Każde polecenie najpierw prosi o potwierdzenie.

Wskaż jedno urządzenie za pomocą uuid (jego deviceUuid z device_inventory_read) lub wszystkie urządzenia za pomocą broadcast: true. Przekaż facilityIds, aby wykonać polecenie w kilku obiektach. Ekrany przyjmują każde polecenie; kamery przyjmują rebootDevice i unlockUpdates. Kamery sieciowe (deviceUuid zaczynający się od ep_) nie mogą odbierać poleceń; wskaż ich Edge Processor (edgeProcessorUUID) lub wykonaj cykl zasilania ich portu PoE.

Aby przywrócić kamerę PoE offline, odczytaj jej metadata.networkStats (switchID, sw_port) w device_inventory_read, a następnie wyślij powerCyclePort do dowolnego urządzenia online w obiekcie z argumentami {switchID, switchPort}. To urządzenie poprosi kontroler sieci obiektu o odcięcie i przywrócenie zasilania portu.

Parametry

NazwaTypOpis
facilityIdstringIdentyfikator obiektu. Opcjonalny, jeśli chodzi o połączony obiekt.
facilityIdsarrayKilka identyfikatorów obiektów, aby wykonać to samo żądanie w każdym z nich. Używaj zamiast facilityId.
command*"displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort"Polecenie do wysłania. Wyślij rozgłoszeniowo restartBleScanner, gdy przyciski napadowe nie są wykrywane; dodanie, przeniesienie lub usunięcie przycisku już to robi, a ekrany przeładowują listę mniej więcej co 10 minut.
broadcastbooleanWyślij do każdego urządzenia w obiekcie zamiast do jednego uuid
uuidstringdeviceUuid z device_inventory_read; pomiń przy wysyłaniu rozgłoszeniowym
argumentsobjectstringosd: tekst komunikatu wyświetlany na bieżącej treści. loadUrl: adres URL http(s) wyświetlany do następnego załadowania programu lub restartu. powerCyclePort: {switchID, switchPort}. Pomiń dla innych poleceń.
confirmbooleanUstaw dopiero wtedy, gdy użytkownik potwierdzi podgląd zwrócony przez pierwsze wywołanie