Device Management

Compares a facility's latest internet speed test with what its devices need. network returns the download and upload speed in Mbps, and for screens, cameras (recording plus live streaming) and connected speaker systems seen in the last 24 hours: the device count, the bandwidth each needs and whether the connection is enough. Use it to diagnose slow or dropping devices, or before adding devices. Pass facilityIds to check several facilities.

Actions:

• network: Network bandwidth check.

Every device registered to a facility: display screens, cloud cameras, network cameras, AI edge processors, duress buttons, door controllers, AI agents and IoT sensors. Use it to troubleshoot, audit equipment or find a device's ID.

Each device has its type, model, IDs (deviceUuid; deviceID for screens; deviceSerialNumber for duress buttons), location, network details (IP, Wi-Fi or ethernet, SSID, channel, nearby networks; metadata.networkStats has the PoE switch port), health (CPU temperature, memory, uptime) and metadata.updated, the last heartbeat in Unix ms. Offline means no heartbeat for 5 minutes; a device offline over 7 days with an online twin (same equipment, name or location) was most likely replaced. networkCamera rows are streams pulled by the edge processor in edgeProcessorUUID; their deviceUuid (starting ep_) can't receive commands. Stream URL credentials show as : unless includeCredentials is set. Recommend wired ethernet over Wi-Fi.

Related: cctv_cameras_read and cctv_cameras_write (cameras), cctv_edge_processors_write (edge processors), device_inventory_write (rename, configure, move), device_send_command (control), device_health_read (bandwidth).

Actions:

• list: List devices. Devices at the facility, filtered by type or name. With facilityIds, each facility returns its first page.

Changes a device registered to a facility. rename_screen and configure_screen change a display screen (identify it by deviceID from device_inventory_read); for a screen's groups, tags or display mode use the display tools instead. move moves a screen, cloud camera, duress button, door controller, AI agent or AI edge processor to another facility in the same organisation.

Actions:

• rename_screen: Rename a screen. Applies straight away, also for offline or end-of-life screens. Needs deviceID, displayName.
• configure_screen: Change a screen's hardware settings. Only the settings you pass change. They are pushed to the device and may restart its display. Offline and end-of-life screens (status 409) can only be renamed. Needs deviceID. Asks for confirmation.
• move: Move a device to another facility. facilityId is where the device is now; you need access to the target too. Moving an edge processor moves its network cameras; to move single network cameras use cctv_edge_processors_write transfer_cameras. Needs targetFacilityId, deviceType. Asks for confirmation.

Sends a live command to one device, or to every device at a facility: reboot, display on or off, restart the browser, show a message, load a page, install updates or power cycle a PoE port. Online devices act within seconds; offline devices never get it. Every command asks for confirmation first.

Target one device with uuid (its deviceUuid from device_inventory_read), or every device with broadcast: true. Pass facilityIds to run at several facilities. Screens take every command; cameras take rebootDevice and unlockUpdates. Network cameras (deviceUuid starting ep_) can't receive commands; target their edge processor (edgeProcessorUUID) or power cycle their PoE port.

To bring back an offline PoE camera, read its metadata.networkStats (switchID, sw_port) in device_inventory_read, then send powerCyclePort to any online device at the facility with arguments {switchID, switchPort}. That device asks the facility's network controller to cut and restore the port's power.