Gerenciamento de dispositivos
Plataforma principaldevice_health_readGerenciamento de dispositivosCompara o teste de velocidade de internet mais recente de uma instalação com o que seus dispositivos precisam. network retorna a velocidade de download e upload em Mbps e, para telas, câmeras (gravação mais transmissão ao vivo) e sistemas de alto-falantes conectados vistos nas últimas 24 horas: a contagem de dispositivos, a largura de banda que cada um precisa e se a conexão é suficiente. Use-o para diagnosticar dispositivos lentos ou que caem, ou antes de adicionar dispositivos. Passe facilityIds para verificar várias instalações.
Ações:
- network: Verificação da largura de banda da rede.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
action* | "network" | O que fazer; cada ação é descrita na descrição da ferramenta. |
facilityId | string | ID da instalação. Opcional quando a instalação conectada é a que você quer. |
facilityIds | array | Vários IDs de instalação, para executar a mesma solicitação em cada uma. Use no lugar de facilityId. |
device_inventory_readGerenciamento de dispositivosTodos os dispositivos registrados em uma instalação: telas, câmeras em nuvem, câmeras de rede, Edge Processors de IA, botões de Duress, controladores de porta, agentes de IA e sensores IoT. Use-o para solucionar problemas, auditar equipamentos ou encontrar o ID de um dispositivo.
Cada dispositivo tem tipo, modelo, IDs (deviceUuid; deviceID para telas; deviceSerialNumber para botões de Duress), localização, detalhes de rede (IP, Wi-Fi ou Ethernet, SSID, canal, redes próximas; metadata.networkStats tem a porta do switch PoE), integridade (temperatura da CPU, memória, tempo de atividade) e metadata.updated, o último heartbeat em ms Unix. Off-line significa nenhum heartbeat por 5 minutos; um dispositivo off-line há mais de 7 dias com um gêmeo on-line (mesmo equipamento, nome ou localização) provavelmente foi substituído. As linhas networkCamera são streams puxados pelo Edge Processor em edgeProcessorUUID; o deviceUuid delas (começando com ep_) não pode receber comandos. As credenciais de URL de stream aparecem como : a menos que includeCredentials esteja definido. Recomende Ethernet cabeada em vez de Wi-Fi.
Relacionadas: cctv_cameras_read e cctv_cameras_write (câmeras), cctv_edge_processors_write (Edge Processors), device_inventory_write (renomear, configurar, mover), device_send_command (controle), device_health_read (largura de banda).
Ações:
- list: Listar dispositivos. Dispositivos na instalação, filtrados por tipo ou nome. Com facilityIds, cada instalação retorna sua primeira página.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
action* | "list" | O que fazer; cada ação é descrita na descrição da ferramenta. |
facilityId | string | ID da instalação. Opcional quando a instalação conectada é a que você quer. |
facilityIds | array | Vários IDs de instalação, para executar a mesma solicitação em cada uma. Use no lugar de facilityId. |
deviceType | string | Somente este tipo, como em deviceType: screen, camera, networkCamera, duress e assim por diante |
query | string | Nome, sala, deviceID, deviceUuid ou número de série contém isto |
includeCredentials | boolean | Retornar URLs de stream com nome de usuário e senha. Desativado por padrão (as credenciais aparecem como ***:***). Defina-o somente quando o usuário precisar explicitamente das credenciais; exige acesso ao CFTV na instalação. |
limit | integer | Itens por página (padrão 25, no máximo 100) |
cursor | string | nextCursor da página anterior |
device_inventory_writeGerenciamento de dispositivosAltera um dispositivo registrado em uma instalação. rename_screen e configure_screen alteram uma tela (identifique-a pelo deviceID de device_inventory_read); para grupos, tags ou modo de exibição de uma tela, use as ferramentas de display. move move uma tela, câmera em nuvem, botão de Duress, controlador de porta, agente de IA ou Edge Processor de IA para outra instalação da mesma organização.
Ações:
- rename_screen: Renomear uma tela. Aplicado imediatamente, inclusive para telas off-line ou em fim de vida útil. Exige deviceID, displayName.
- configure_screen: Alterar as configurações de hardware de uma tela. Somente as configurações que você passar mudam. Elas são enviadas ao dispositivo e podem reiniciar a exibição. Telas off-line e em fim de vida útil (status 409) só podem ser renomeadas. Exige deviceID. Pede confirmação.
- move: Mover um dispositivo para outra instalação. facilityId é onde o dispositivo está agora; você também precisa de acesso à instalação de destino. Mover um Edge Processor move suas câmeras de rede; para mover câmeras de rede individuais, use cctv_edge_processors_write transfer_cameras. Exige targetFacilityId, deviceType. Pede confirmação.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
action* | "rename_screen" | "configure_screen" | "move" | O que fazer; cada ação é descrita na descrição da ferramenta. |
deviceID | string | deviceID da tela (código de 6 caracteres) |
displayName | string | Novo nome da tela (rename_screen, configure_screen) |
facilityId | string | ID da instalação. Opcional quando a instalação conectada é a que você quer. |
orientation | "normal" | "left" | "right" | "inverted" | Rotação da tela (configure_screen) |
resolution | "auto" | "1920x1080" | "1280x720" | "720x400" | Resolução de saída; auto usa o que a tela informa (configure_screen) |
scheduledReboot | "disabled" | "daily" | "weekly" | "monthly" | Quando a tela se reinicia sozinha (configure_screen) |
displayBrightness | integer | Brilho da luz de fundo, 0-100 (configure_screen) |
airplayEnabled | boolean | A tela aceita AirPlay (configure_screen) |
airplayName | string | Nome personalizado do receptor AirPlay; vazio para o nome automático (configure_screen) |
airplayPin | string | PIN do AirPlay de 4 dígitos; vazio para remover (configure_screen) |
duressEnabled | boolean | Leitor Bluetooth de botões de Duress (configure_screen) |
sonosEnabled | boolean | Controle de alto-falantes Sonos (configure_screen) |
wifiSupport | boolean | Portal cativo de configuração do Wi-Fi (configure_screen) |
cameraRestreamingEnabled | boolean | Retransmitir os feeds das câmeras locais a partir da tela (configure_screen) |
sessionTimerEnabled | boolean | Synchronised session timer (master clock) and its bells (configure_screen) |
targetFacilityId | string | Instalação para a qual mover o dispositivo (move) |
deviceType | "screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor" | Tipo de dispositivo; define qual identificador passar (move) |
deviceUuid | string | deviceUuid da câmera, controlador de porta, Agente de IA ou Edge Processor (move) |
deviceSerialNumber | string | Número de série do botão de Duress (move) |
confirm | boolean | Defina somente depois que o usuário confirmar a prévia retornada pela primeira chamada |
device_send_commandGerenciamento de dispositivosEnvia um comando em tempo real para um dispositivo ou para todos os dispositivos de uma instalação: reiniciar, ligar ou desligar a tela, reiniciar o navegador, exibir uma mensagem, carregar uma página, instalar atualizações ou desligar e religar uma porta PoE. Dispositivos on-line agem em segundos; dispositivos off-line nunca o recebem. Todo comando pede confirmação antes.
Direcione a um dispositivo com uuid (seu deviceUuid de device_inventory_read) ou a todos os dispositivos com broadcast: true. Passe facilityIds para executar em várias instalações. As telas aceitam todos os comandos; as câmeras aceitam rebootDevice e unlockUpdates. Câmeras de rede (deviceUuid começando com ep_) não podem receber comandos; direcione ao Edge Processor delas (edgeProcessorUUID) ou desligue e religue a porta PoE.
Para recuperar uma câmera PoE off-line, leia seu metadata.networkStats (switchID, sw_port) em device_inventory_read e envie powerCyclePort para qualquer dispositivo on-line na instalação com os argumentos {switchID, switchPort}. Esse dispositivo pede ao controlador de rede da instalação que corte e restaure a energia da porta.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
facilityId | string | ID da instalação. Opcional quando a instalação conectada é a que você quer. |
facilityIds | array | Vários IDs de instalação, para executar a mesma solicitação em cada uma. Use no lugar de facilityId. |
command* | "displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort" | Comando a enviar. Faça broadcast de restartBleScanner quando os botões de Duress não forem detectados; adicionar, mover ou remover um botão já faz isso, e as telas recarregam a lista a cada ~10 minutos. |
broadcast | boolean | Enviar para todos os dispositivos da instalação em vez de um uuid |
uuid | string | O deviceUuid de device_inventory_read; omita ao fazer broadcast |
arguments | objectstring | osd: o texto da mensagem, exibido sobre o conteúdo atual. loadUrl: uma URL http(s), exibida até o próximo carregamento de programação ou reinicialização. powerCyclePort: {switchID, switchPort}. Omita para os outros comandos. |
confirm | boolean | Defina somente depois que o usuário confirmar a prévia retornada pela primeira chamada |