Управление устройствами
Основная платформаdevice_health_readУправление устройствамиСравнивает последний тест скорости интернета на объекте с потребностями его устройств. network возвращает скорость загрузки и отдачи в Мбит/с, а для экранов, камер (запись и трансляция в реальном времени) и подключённых акустических систем, обнаруженных за последние 24 часа, — число устройств, необходимую каждому пропускную способность и достаточно ли подключения. Используйте для диагностики медленных или отключающихся устройств или перед добавлением устройств. Передайте facilityIds, чтобы проверить несколько объектов.
Действия:
- network: Проверка пропускной способности сети.
Параметры
| Имя | Тип | Описание |
|---|---|---|
action* | "network" | Что сделать; каждое действие описано в описании инструмента. |
facilityId | string | ID объекта. Необязателен, если имеется в виду подключённый объект. |
facilityIds | array | Несколько ID объектов, чтобы выполнить один и тот же запрос для каждого. Используйте вместо facilityId. |
device_inventory_readУправление устройствамиВсе устройства, зарегистрированные на объекте: экраны, облачные камеры, сетевые камеры, AI Edge Processor, тревожные кнопки, дверные контроллеры, ИИ-агенты и датчики IoT. Используйте для диагностики, аудита оборудования или поиска ID устройства.
Для каждого устройства указаны тип, модель, ID (deviceUuid; deviceID для экранов; deviceSerialNumber для тревожных кнопок), расположение, сетевые данные (IP, Wi-Fi или Ethernet, SSID, канал, ближайшие сети; metadata.networkStats содержит порт коммутатора PoE), состояние (температура ЦП, память, время работы) и metadata.updated — последний сигнал активности в Unix ms. Оффлайн означает отсутствие сигнала активности в течение 5 минут; устройство, находящееся оффлайн более 7 дней при наличии двойника в сети (то же оборудование, название или расположение), скорее всего, было заменено. Строки networkCamera — это потоки, получаемые Edge Processor из edgeProcessorUUID; их deviceUuid (начинается с ep_) не может получать команды. Учётные данные в URL потоков отображаются как :, если не задан includeCredentials. Рекомендуйте проводной Ethernet вместо Wi-Fi.
Связанные инструменты: cctv_cameras_read и cctv_cameras_write (камеры), cctv_edge_processors_write (Edge Processor), device_inventory_write (переименование, настройка, перенос), device_send_command (управление), device_health_read (пропускная способность).
Действия:
- list: Список устройств. Устройства на объекте с фильтром по типу или названию. С facilityIds для каждого объекта возвращается первая страница.
Параметры
| Имя | Тип | Описание |
|---|---|---|
action* | "list" | Что сделать; каждое действие описано в описании инструмента. |
facilityId | string | ID объекта. Необязателен, если имеется в виду подключённый объект. |
facilityIds | array | Несколько ID объектов, чтобы выполнить один и тот же запрос для каждого. Используйте вместо facilityId. |
deviceType | string | Только этот тип, как в deviceType: screen, camera, networkCamera, duress и так далее |
query | string | Название, помещение, deviceID, deviceUuid или серийный номер содержит это значение |
includeCredentials | boolean | Возвращать URL потоков с именем пользователя и паролем. По умолчанию отключено (учётные данные отображаются как ***:***). Задавайте, только если пользователю явно нужны учётные данные; требуется доступ к видеонаблюдению на объекте. |
limit | integer | Элементов на странице (по умолчанию 25, не более 100) |
cursor | string | nextCursor с предыдущей страницы |
device_inventory_writeУправление устройствамиИзменяет устройство, зарегистрированное на объекте. rename_screen и configure_screen изменяют экран (определяйте его по deviceID из device_inventory_read); для групп, тегов или режима отображения экрана используйте инструменты экранов. move переносит экран, облачную камеру, тревожную кнопку, дверной контроллер, ИИ-агента или AI Edge Processor на другой объект в той же организации.
Действия:
- rename_screen: Переименовать экран. Применяется сразу, в том числе для экранов оффлайн или с завершённым сроком поддержки. Требуются deviceID, displayName.
- configure_screen: Изменить аппаратные настройки экрана. Изменяются только переданные настройки. Они передаются на устройство и могут перезапустить его дисплей. Экраны оффлайн и с завершённым сроком поддержки (статус 409) можно только переименовать. Требуется deviceID. Запрашивает подтверждение.
- move: Перенести устройство на другой объект. facilityId — объект, на котором устройство находится сейчас; вам также нужен доступ к целевому объекту. При переносе Edge Processor переносятся и его сетевые камеры; чтобы перенести отдельные сетевые камеры, используйте cctv_edge_processors_write transfer_cameras. Требуются targetFacilityId, deviceType. Запрашивает подтверждение.
Параметры
| Имя | Тип | Описание |
|---|---|---|
action* | "rename_screen" | "configure_screen" | "move" | Что сделать; каждое действие описано в описании инструмента. |
deviceID | string | deviceID экрана (6-символьный код) |
displayName | string | Новое название экрана (rename_screen, configure_screen) |
facilityId | string | ID объекта. Необязателен, если имеется в виду подключённый объект. |
orientation | "normal" | "left" | "right" | "inverted" | Поворот экрана (configure_screen) |
resolution | "auto" | "1920x1080" | "1280x720" | "720x400" | Выходное разрешение; auto использует значение, сообщаемое дисплеем (configure_screen) |
scheduledReboot | "disabled" | "daily" | "weekly" | "monthly" | Когда экран перезагружается автоматически (configure_screen) |
displayBrightness | integer | Яркость подсветки, 0–100 (configure_screen) |
airplayEnabled | boolean | Экран принимает AirPlay (configure_screen) |
airplayName | string | Собственное имя приёмника AirPlay; пустое значение для автоматического имени (configure_screen) |
airplayPin | string | 4-значный PIN-код AirPlay; пустое значение, чтобы удалить (configure_screen) |
duressEnabled | boolean | Bluetooth-сканер тревожных кнопок (configure_screen) |
sonosEnabled | boolean | Управление динамиками Sonos (configure_screen) |
wifiSupport | boolean | Портал настройки Wi-Fi (captive portal) (configure_screen) |
cameraRestreamingEnabled | boolean | Ретрансляция локальных потоков камер с экрана (configure_screen) |
sessionTimerEnabled | boolean | Synchronised session timer (master clock) and its bells (configure_screen) |
targetFacilityId | string | Объект, на который переносится устройство (move) |
deviceType | "screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor" | Вид устройства; определяет, какой идентификатор передавать (move) |
deviceUuid | string | deviceUuid камеры, дверного контроллера, ИИ-агента или Edge Processor (move) |
deviceSerialNumber | string | Серийный номер тревожной кнопки (move) |
confirm | boolean | Задавайте только после того, как пользователь подтвердил предпросмотр, возвращённый первым вызовом |
device_send_commandУправление устройствамиОтправляет команду в реальном времени одному устройству или всем устройствам на объекте: перезагрузка, включение или выключение дисплея, перезапуск браузера, показ сообщения, загрузка страницы, установка обновлений или перезапуск питания порта PoE. Устройства в сети выполняют команду за секунды; устройства оффлайн её никогда не получат. Каждая команда сначала запрашивает подтверждение.
Выберите одно устройство с помощью uuid (его deviceUuid из device_inventory_read) или все устройства с помощью broadcast: true. Передайте facilityIds, чтобы выполнить команду на нескольких объектах. Экраны принимают все команды; камеры принимают rebootDevice и unlockUpdates. Сетевые камеры (deviceUuid начинается с ep_) не могут получать команды; отправляйте команды их Edge Processor (edgeProcessorUUID) или перезапустите питание их порта PoE.
Чтобы вернуть в сеть камеру PoE, прочитайте её metadata.networkStats (switchID, sw_port) в device_inventory_read, затем отправьте powerCyclePort любому устройству в сети на объекте с аргументами {switchID, switchPort}. Это устройство попросит сетевой контроллер объекта отключить и восстановить питание порта.
Параметры
| Имя | Тип | Описание |
|---|---|---|
facilityId | string | ID объекта. Необязателен, если имеется в виду подключённый объект. |
facilityIds | array | Несколько ID объектов, чтобы выполнить один и тот же запрос для каждого. Используйте вместо facilityId. |
command* | "displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort" | Отправляемая команда. Отправьте restartBleScanner всем устройствам, если тревожные кнопки не обнаруживаются; добавление, перенос или удаление кнопки уже делает это, а экраны перезагружают список примерно каждые 10 минут. |
broadcast | boolean | Отправить всем устройствам на объекте вместо одного uuid |
uuid | string | deviceUuid из device_inventory_read; не указывайте при отправке всем устройствам |
arguments | objectstring | osd: текст сообщения, отображаемый поверх текущего контента. loadUrl: URL http(s), отображается до следующей загрузки программы или перезагрузки. powerCyclePort: {switchID, switchPort}. Для других команд не указывайте. |
confirm | boolean | Задавайте только после того, как пользователь подтвердил предпросмотр, возвращённый первым вызовом |