Gestión de dispositivos
Plataforma principaldevice_health_readGestión de dispositivosCompara la última prueba de velocidad de internet de una instalación con lo que necesitan sus dispositivos. network devuelve la velocidad de descarga y de subida en Mbps y, para pantallas, cámaras (grabación más transmisión en vivo) y sistemas de altavoces conectados vistos en las últimas 24 horas: la cantidad de dispositivos, el ancho de banda que necesita cada uno y si la conexión es suficiente. Úsalo para diagnosticar dispositivos lentos o que se desconectan, o antes de agregar dispositivos. Pasa facilityIds para comprobar varias instalaciones.
Acciones:
- network: Comprobación del ancho de banda de la red.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
action* | "network" | Qué hacer; cada acción se describe en la descripción de la herramienta. |
facilityId | string | ID de la instalación. Opcional si te refieres a la instalación conectada. |
facilityIds | array | Varios ID de instalación, para ejecutar la misma solicitud en cada una. Úsalo en lugar de facilityId. |
device_inventory_readGestión de dispositivosTodos los dispositivos registrados en una instalación: pantallas, cámaras en la nube, cámaras de red, Edge Processors de IA, botones de Duress, controladores de puerta, agentes de IA y sensores IoT. Úsalo para solucionar problemas, auditar el equipamiento o encontrar el ID de un dispositivo.
Cada dispositivo tiene su tipo, modelo, IDs (deviceUuid; deviceID para las pantallas; deviceSerialNumber para los botones de Duress), ubicación, datos de red (IP, Wi-Fi o Ethernet, SSID, canal, redes cercanas; metadata.networkStats tiene el puerto del switch PoE), estado (temperatura de la CPU, memoria, tiempo de actividad) y metadata.updated, la última señal de actividad en ms Unix. Desconectado significa sin señal de actividad durante 5 minutos; un dispositivo desconectado durante más de 7 días con un gemelo en línea (mismo equipo, nombre o ubicación) probablemente se reemplazó. Las filas networkCamera son transmisiones que extrae el Edge Processor de edgeProcessorUUID; su deviceUuid (que empieza por ep_) no puede recibir comandos. Las credenciales de las URL de transmisión se muestran como : a menos que se defina includeCredentials. Recomienda Ethernet por cable en lugar de Wi-Fi.
Relacionado: cctv_cameras_read y cctv_cameras_write (cámaras), cctv_edge_processors_write (Edge Processors), device_inventory_write (cambiar el nombre, configurar, mover), device_send_command (control), device_health_read (ancho de banda).
Acciones:
- list: Mostrar los dispositivos. Dispositivos de la instalación, filtrados por tipo o nombre. Con facilityIds, cada instalación devuelve su primera página.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
action* | "list" | Qué hacer; cada acción se describe en la descripción de la herramienta. |
facilityId | string | ID de la instalación. Opcional si te refieres a la instalación conectada. |
facilityIds | array | Varios ID de instalación, para ejecutar la misma solicitud en cada una. Úsalo en lugar de facilityId. |
deviceType | string | Solo este tipo, como en deviceType: screen, camera, networkCamera, duress, etc. |
query | string | El nombre, la sala, el deviceID, el deviceUuid o el número de serie contiene esto |
includeCredentials | boolean | Devolver las URL de transmisión con su nombre de usuario y contraseña. Desactivado de forma predeterminada (las credenciales se muestran como ***:***). Actívalo solo cuando el usuario necesite explícitamente las credenciales; requiere acceso a CCTV en la instalación. |
limit | integer | Elementos por página (predeterminado 25, máximo 100) |
cursor | string | nextCursor de la página anterior |
device_inventory_writeGestión de dispositivosCambia un dispositivo registrado en una instalación. rename_screen y configure_screen cambian una pantalla (identifícala por el deviceID de device_inventory_read); para los grupos, las etiquetas o el modo de visualización de una pantalla, usa las herramientas de pantallas. move mueve una pantalla, una cámara en la nube, un botón de Duress, un controlador de puerta, un agente de IA o un Edge Processor de IA a otra instalación de la misma organización.
Acciones:
- rename_screen: Cambiar el nombre de una pantalla. Se aplica de inmediato, también en pantallas desconectadas o al final de su vida útil. Requiere deviceID, displayName.
- configure_screen: Cambiar la configuración de hardware de una pantalla. Solo cambia la configuración que pases. Se envía al dispositivo y puede reiniciar su pantalla. A las pantallas desconectadas y al final de su vida útil (estado 409) solo se les puede cambiar el nombre. Requiere deviceID. Pide confirmación.
- move: Mover un dispositivo a otra instalación. facilityId es donde está el dispositivo ahora; también necesitas acceso a la de destino. Mover un Edge Processor mueve sus cámaras de red; para mover cámaras de red individuales, usa cctv_edge_processors_write transfer_cameras. Requiere targetFacilityId, deviceType. Pide confirmación.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
action* | "rename_screen" | "configure_screen" | "move" | Qué hacer; cada acción se describe en la descripción de la herramienta. |
deviceID | string | deviceID de la pantalla (código de 6 caracteres) |
displayName | string | Nuevo nombre de la pantalla (rename_screen, configure_screen) |
facilityId | string | ID de la instalación. Opcional si te refieres a la instalación conectada. |
orientation | "normal" | "left" | "right" | "inverted" | Rotación de la pantalla (configure_screen) |
resolution | "auto" | "1920x1080" | "1280x720" | "720x400" | Resolución de salida; auto usa la que informa la pantalla (configure_screen) |
scheduledReboot | "disabled" | "daily" | "weekly" | "monthly" | Cuándo se reinicia la pantalla por sí sola (configure_screen) |
displayBrightness | integer | Brillo de la retroiluminación, 0-100 (configure_screen) |
airplayEnabled | boolean | La pantalla acepta AirPlay (configure_screen) |
airplayName | string | Nombre personalizado del receptor AirPlay; vacío para el nombre automático (configure_screen) |
airplayPin | string | PIN de AirPlay de 4 dígitos; vacío para quitarlo (configure_screen) |
duressEnabled | boolean | Escáner Bluetooth de botones de Duress (configure_screen) |
sonosEnabled | boolean | Control de altavoces Sonos (configure_screen) |
wifiSupport | boolean | Portal cautivo de configuración de Wi-Fi (configure_screen) |
cameraRestreamingEnabled | boolean | Retransmitir las señales de las cámaras locales desde la pantalla (configure_screen) |
sessionTimerEnabled | boolean | Synchronised session timer (master clock) and its bells (configure_screen) |
targetFacilityId | string | Instalación a la que se moverá el dispositivo (move) |
deviceType | "screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor" | Tipo de dispositivo; determina qué identificador se debe pasar (move) |
deviceUuid | string | deviceUuid de la cámara, el controlador de puerta, el agente de IA o el Edge Processor (move) |
deviceSerialNumber | string | Número de serie del botón de Duress (move) |
confirm | boolean | Defínelo solo después de que el usuario haya confirmado la vista previa que devolvió la primera llamada |
device_send_commandGestión de dispositivosEnvía un comando en vivo a un dispositivo o a todos los dispositivos de una instalación: reiniciar, encender o apagar la pantalla, reiniciar el navegador, mostrar un mensaje, cargar una página, instalar actualizaciones o reiniciar la alimentación de un puerto PoE. Los dispositivos en línea actúan en segundos; los desconectados nunca lo reciben. Cada comando pide confirmación primero.
Apunta a un dispositivo con uuid (su deviceUuid de device_inventory_read) o a todos con broadcast: true. Pasa facilityIds para ejecutarlo en varias instalaciones. Las pantallas aceptan todos los comandos; las cámaras aceptan rebootDevice y unlockUpdates. Las cámaras de red (deviceUuid que empieza por ep_) no pueden recibir comandos; apunta a su Edge Processor (edgeProcessorUUID) o reinicia la alimentación de su puerto PoE.
Para recuperar una cámara PoE desconectada, lee su metadata.networkStats (switchID, sw_port) en device_inventory_read y luego envía powerCyclePort a cualquier dispositivo en línea de la instalación con los argumentos {switchID, switchPort}. Ese dispositivo le pide al controlador de red de la instalación que corte y restablezca la alimentación del puerto.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
facilityId | string | ID de la instalación. Opcional si te refieres a la instalación conectada. |
facilityIds | array | Varios ID de instalación, para ejecutar la misma solicitud en cada una. Úsalo en lugar de facilityId. |
command* | "displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort" | Comando que se va a enviar. Difunde restartBleScanner cuando no se detectan los botones de Duress; agregar, mover o quitar un botón ya lo hace, y las pantallas recargan la lista cada ~10 minutos. |
broadcast | boolean | Enviar a todos los dispositivos de la instalación en lugar de a un uuid |
uuid | string | El deviceUuid de device_inventory_read; omítelo al difundir |
arguments | objectstring | osd: el texto del mensaje, que se muestra sobre el contenido actual. loadUrl: una URL http(s), que se muestra hasta la siguiente carga del programa o el siguiente reinicio. powerCyclePort: {switchID, switchPort}. Omítelo para los demás comandos. |
confirm | boolean | Defínelo solo después de que el usuario haya confirmado la vista previa que devolvió la primera llamada |