Quản lý thiết bị

Nền tảng cốt lõi
device_health_readQuản lý thiết bị

So sánh kết quả kiểm tra tốc độ internet gần nhất của một cơ sở với nhu cầu của các thiết bị. network trả về tốc độ tải xuống và tải lên tính bằng Mbps, và đối với màn hình, camera (ghi hình cùng phát trực tiếp) và hệ thống loa đã kết nối được ghi nhận trong 24 giờ qua: số lượng thiết bị, băng thông mỗi thiết bị cần và kết nối có đủ hay không. Dùng để chẩn đoán thiết bị chậm hoặc hay mất kết nối, hoặc trước khi thêm thiết bị. Truyền facilityIds để kiểm tra nhiều cơ sở.

Các hành động:

  • network: Kiểm tra băng thông mạng.

Tham số

TênLoạiMô tả
action*"network"Việc cần làm; mỗi hành động được mô tả trong phần mô tả công cụ.
facilityIdstringID cơ sở. Không bắt buộc khi cơ sở đang kết nối chính là cơ sở bạn muốn chỉ đến.
facilityIdsarrayNhiều ID cơ sở, để chạy cùng một yêu cầu tại từng cơ sở. Dùng thay cho facilityId.
device_inventory_readQuản lý thiết bị

Mọi thiết bị đã đăng ký với một cơ sở: màn hình hiển thị, camera đám mây, camera mạng, AI Edge Processor, nút duress, bộ điều khiển cửa, AI Agents và cảm biến IoT. Dùng để khắc phục sự cố, kiểm kê thiết bị hoặc tìm ID của một thiết bị.

Mỗi thiết bị có loại, model, các ID (deviceUuid; deviceID đối với màn hình; deviceSerialNumber đối với nút duress), vị trí, thông tin mạng (IP, Wi-Fi hoặc Ethernet, SSID, kênh, các mạng lân cận; metadata.networkStats có cổng switch PoE), tình trạng (nhiệt độ CPU, bộ nhớ, thời gian hoạt động) và metadata.updated, heartbeat gần nhất tính bằng Unix ms. Ngoại tuyến nghĩa là không có heartbeat trong 5 phút; một thiết bị ngoại tuyến hơn 7 ngày mà có thiết bị song sinh đang trực tuyến (cùng thiết bị, tên hoặc vị trí) nhiều khả năng đã được thay thế. Các dòng networkCamera là các luồng được Edge Processor trong edgeProcessorUUID kéo về; deviceUuid của chúng (bắt đầu bằng ep_) không thể nhận lệnh. Thông tin xác thực trong URL luồng hiển thị dưới dạng : trừ khi đặt includeCredentials. Nên khuyến nghị dùng Ethernet có dây thay cho Wi-Fi.

Liên quan: cctv_cameras_read và cctv_cameras_write (camera), cctv_edge_processors_write (Edge Processor), device_inventory_write (đổi tên, cấu hình, di chuyển), device_send_command (điều khiển), device_health_read (băng thông).

Các hành động:

  • list: Liệt kê thiết bị. Các thiết bị tại cơ sở, lọc theo loại hoặc tên. Khi có facilityIds, mỗi cơ sở trả về trang đầu tiên của mình.

Tham số

TênLoạiMô tả
action*"list"Việc cần làm; mỗi hành động được mô tả trong phần mô tả công cụ.
facilityIdstringID cơ sở. Không bắt buộc khi cơ sở đang kết nối chính là cơ sở bạn muốn chỉ đến.
facilityIdsarrayNhiều ID cơ sở, để chạy cùng một yêu cầu tại từng cơ sở. Dùng thay cho facilityId.
deviceTypestringChỉ loại này, như trong deviceType: screen, camera, networkCamera, duress, v.v.
querystringTên, phòng, deviceID, deviceUuid hoặc số sê-ri có chứa giá trị này
includeCredentialsbooleanTrả về URL luồng kèm tên người dùng và mật khẩu. Tắt theo mặc định (thông tin xác thực hiển thị dưới dạng ***:***). Chỉ đặt giá trị này khi người dùng thực sự cần thông tin xác thực; cần quyền truy cập camera giám sát tại cơ sở.
limitintegerSố mục mỗi trang (mặc định 25, tối đa 100)
cursorstringnextCursor từ trang trước
device_inventory_writeQuản lý thiết bị

Thay đổi một thiết bị đã đăng ký với một cơ sở. rename_screen và configure_screen thay đổi một màn hình hiển thị (xác định bằng deviceID lấy từ device_inventory_read); đối với nhóm, thẻ hoặc chế độ hiển thị của màn hình, hãy dùng các công cụ hiển thị. move chuyển một màn hình, camera đám mây, nút duress, bộ điều khiển cửa, AI Agent hoặc AI Edge Processor sang một cơ sở khác trong cùng tổ chức.

Các hành động:

  • rename_screen: Đổi tên màn hình. Áp dụng ngay, kể cả với màn hình ngoại tuyến hoặc đã hết vòng đời. Cần deviceID, displayName.
  • configure_screen: Thay đổi cài đặt phần cứng của màn hình. Chỉ các cài đặt bạn truyền vào mới thay đổi. Cài đặt được đẩy xuống thiết bị và có thể khởi động lại màn hình. Màn hình ngoại tuyến và đã hết vòng đời (status 409) chỉ có thể đổi tên. Cần deviceID. Yêu cầu xác nhận.
  • move: Chuyển thiết bị sang cơ sở khác. facilityId là nơi thiết bị đang ở; bạn cũng cần có quyền truy cập cơ sở đích. Chuyển một Edge Processor sẽ chuyển cả các camera mạng của nó; để chuyển từng camera mạng, hãy dùng cctv_edge_processors_write transfer_cameras. Cần targetFacilityId, deviceType. Yêu cầu xác nhận.

Tham số

TênLoạiMô tả
action*"rename_screen" | "configure_screen" | "move"Việc cần làm; mỗi hành động được mô tả trong phần mô tả công cụ.
deviceIDstringdeviceID của màn hình (mã 6 ký tự)
displayNamestringTên mới của màn hình (rename_screen, configure_screen)
facilityIdstringID cơ sở. Không bắt buộc khi cơ sở đang kết nối chính là cơ sở bạn muốn chỉ đến.
orientation"normal" | "left" | "right" | "inverted"Hướng xoay màn hình (configure_screen)
resolution"auto" | "1920x1080" | "1280x720" | "720x400"Độ phân giải đầu ra; auto dùng giá trị mà màn hình báo cáo (configure_screen)
scheduledReboot"disabled" | "daily" | "weekly" | "monthly"Thời điểm màn hình tự khởi động lại (configure_screen)
displayBrightnessintegerĐộ sáng đèn nền, 0-100 (configure_screen)
airplayEnabledbooleanMàn hình chấp nhận AirPlay (configure_screen)
airplayNamestringTên bộ nhận AirPlay tùy chỉnh; để trống để dùng tên tự động (configure_screen)
airplayPinstringMã PIN AirPlay 4 chữ số; để trống để xóa (configure_screen)
duressEnabledbooleanTrình quét nút duress qua Bluetooth (configure_screen)
sonosEnabledbooleanĐiều khiển loa Sonos (configure_screen)
wifiSupportbooleanCổng thiết lập Wi-Fi dạng captive portal (configure_screen)
cameraRestreamingEnabledbooleanPhát lại nguồn camera cục bộ từ màn hình (configure_screen)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (configure_screen)
targetFacilityIdstringCơ sở sẽ chuyển thiết bị đến (move)
deviceType"screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor"Loại thiết bị; quyết định mã định danh cần truyền (move)
deviceUuidstringdeviceUuid của camera, bộ điều khiển cửa, AI Agent hoặc Edge Processor (move)
deviceSerialNumberstringSố sê-ri của nút duress (move)
confirmbooleanChỉ đặt sau khi người dùng đã xác nhận bản xem trước do lần gọi đầu tiên trả về
device_send_commandQuản lý thiết bị

Gửi lệnh trực tiếp đến một thiết bị, hoặc đến mọi thiết bị tại một cơ sở: khởi động lại, bật hoặc tắt màn hình, khởi động lại trình duyệt, hiển thị tin nhắn, tải một trang, cài đặt bản cập nhật hoặc ngắt rồi cấp lại nguồn cho cổng PoE. Thiết bị trực tuyến thực hiện trong vài giây; thiết bị ngoại tuyến không bao giờ nhận được lệnh. Mọi lệnh đều yêu cầu xác nhận trước.

Nhắm tới một thiết bị bằng uuid (deviceUuid của thiết bị lấy từ device_inventory_read), hoặc mọi thiết bị bằng broadcast: true. Truyền facilityIds để chạy tại nhiều cơ sở. Màn hình nhận mọi lệnh; camera nhận rebootDevice và unlockUpdates. Camera mạng (deviceUuid bắt đầu bằng ep_) không thể nhận lệnh; hãy nhắm tới Edge Processor của chúng (edgeProcessorUUID) hoặc ngắt rồi cấp lại nguồn cho cổng PoE của chúng.

Để khôi phục một camera PoE đang ngoại tuyến, hãy đọc metadata.networkStats (switchID, sw_port) của camera trong device_inventory_read, sau đó gửi powerCyclePort đến bất kỳ thiết bị trực tuyến nào tại cơ sở với đối số {switchID, switchPort}. Thiết bị đó sẽ yêu cầu bộ điều khiển mạng của cơ sở ngắt và cấp lại nguồn cho cổng.

Tham số

TênLoạiMô tả
facilityIdstringID cơ sở. Không bắt buộc khi cơ sở đang kết nối chính là cơ sở bạn muốn chỉ đến.
facilityIdsarrayNhiều ID cơ sở, để chạy cùng một yêu cầu tại từng cơ sở. Dùng thay cho facilityId.
command*"displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort"Lệnh cần gửi. Phát restartBleScanner đến mọi thiết bị khi không phát hiện được nút duress; việc thêm, di chuyển hoặc xóa một nút đã tự thực hiện việc này, và màn hình tải lại danh sách khoảng mỗi 10 phút.
broadcastbooleanGửi đến mọi thiết bị tại cơ sở thay vì một uuid
uuidstringdeviceUuid lấy từ device_inventory_read; bỏ qua khi gửi đến mọi thiết bị
argumentsobjectstringosd: nội dung tin nhắn, hiển thị đè lên nội dung hiện tại. loadUrl: một URL http(s), hiển thị cho đến lần tải chương trình tiếp theo hoặc lần khởi động lại. powerCyclePort: {switchID, switchPort}. Bỏ qua đối với các lệnh khác.
confirmbooleanChỉ đặt sau khi người dùng đã xác nhận bản xem trước do lần gọi đầu tiên trả về