Pengurusan Peranti
Platform Terasdevice_health_readPengurusan PerantiMembandingkan ujian kelajuan internet terkini sesebuah kemudahan dengan keperluan perantinya. network mengembalikan kelajuan muat turun dan muat naik dalam Mbps, dan bagi skrin, kamera (rakaman serta penstriman langsung) dan sistem pembesar suara bersambung yang dikesan dalam 24 jam terakhir: bilangan peranti, lebar jalur yang diperlukan oleh setiap satu dan sama ada sambungan mencukupi. Gunakannya untuk mendiagnosis peranti yang perlahan atau kerap terputus, atau sebelum menambah peranti. Hantar facilityIds untuk menyemak beberapa kemudahan.
Tindakan:
- network: Semakan lebar jalur rangkaian.
Parameter
| Nama | Jenis | Penerangan |
|---|---|---|
action* | "network" | Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat. |
facilityId | string | ID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan. |
facilityIds | array | Beberapa ID kemudahan, untuk menjalankan permintaan yang sama di setiap satu. Gunakan sebagai ganti facilityId. |
device_inventory_readPengurusan PerantiSetiap peranti yang didaftarkan ke sesebuah kemudahan: skrin paparan, kamera awan, kamera rangkaian, edge processor AI, butang duress, pengawal pintu, ejen AI dan penderia IoT. Gunakannya untuk menyelesaikan masalah, mengaudit peralatan atau mencari ID peranti.
Setiap peranti mempunyai jenis, model, ID (deviceUuid; deviceID untuk skrin; deviceSerialNumber untuk butang duress), lokasi, butiran rangkaian (IP, Wi-Fi atau ethernet, SSID, saluran, rangkaian berdekatan; metadata.networkStats mengandungi port suis PoE), kesihatan (suhu CPU, memori, masa operasi) dan metadata.updated, iaitu degupan jantung terakhir dalam Unix ms. Luar talian bermaksud tiada degupan jantung selama 5 minit; peranti yang luar talian lebih daripada 7 hari dengan kembar dalam talian (peralatan, nama atau lokasi yang sama) berkemungkinan besar telah diganti. Baris networkCamera ialah strim yang ditarik oleh edge processor dalam edgeProcessorUUID; deviceUuid baris tersebut (bermula dengan ep_) tidak boleh menerima arahan. Bukti kelayakan URL strim dipaparkan sebagai : melainkan includeCredentials ditetapkan. Syorkan ethernet berwayar berbanding Wi-Fi.
Berkaitan: cctv_cameras_read dan cctv_cameras_write (kamera), cctv_edge_processors_write (edge processor), device_inventory_write (namakan semula, konfigurasikan, pindah), device_send_command (kawalan), device_health_read (lebar jalur).
Tindakan:
- list: Senaraikan peranti. Peranti di kemudahan, ditapis mengikut jenis atau nama. Dengan facilityIds, setiap kemudahan mengembalikan halaman pertamanya.
Parameter
| Nama | Jenis | Penerangan |
|---|---|---|
action* | "list" | Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat. |
facilityId | string | ID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan. |
facilityIds | array | Beberapa ID kemudahan, untuk menjalankan permintaan yang sama di setiap satu. Gunakan sebagai ganti facilityId. |
deviceType | string | Jenis ini sahaja, seperti dalam deviceType: screen, camera, networkCamera, duress dan sebagainya |
query | string | Nama, bilik, deviceID, deviceUuid atau nombor siri mengandungi ini |
includeCredentials | boolean | Kembalikan URL strim berserta nama pengguna dan kata laluannya. Dimatikan secara lalai (bukti kelayakan dipaparkan sebagai ***:***). Tetapkan ini hanya apabila pengguna benar-benar memerlukan bukti kelayakan; ia memerlukan akses CCTV di kemudahan itu. |
limit | integer | Item setiap halaman (lalai 25, maksimum 100) |
cursor | string | nextCursor daripada halaman sebelumnya |
device_inventory_writePengurusan PerantiMengubah peranti yang didaftarkan ke sesebuah kemudahan. rename_screen dan configure_screen mengubah skrin paparan (kenal pastinya melalui deviceID daripada device_inventory_read); untuk kumpulan, tag atau mod paparan skrin, gunakan alat paparan sebaliknya. move memindahkan skrin, kamera awan, butang duress, pengawal pintu, ejen AI atau edge processor AI ke kemudahan lain dalam organisasi yang sama.
Tindakan:
- rename_screen: Namakan semula skrin. Berkuat kuasa serta-merta, termasuk untuk skrin yang luar talian atau tamat hayat. Memerlukan deviceID, displayName.
- configure_screen: Ubah tetapan perkakasan skrin. Hanya tetapan yang anda hantar akan berubah. Tetapan ditolak ke peranti dan mungkin memulakan semula paparannya. Skrin luar talian dan tamat hayat (status 409) hanya boleh dinamakan semula. Memerlukan deviceID. Meminta pengesahan.
- move: Pindahkan peranti ke kemudahan lain. facilityId ialah lokasi peranti sekarang; anda juga memerlukan akses ke kemudahan sasaran. Memindahkan edge processor turut memindahkan kamera rangkaiannya; untuk memindahkan kamera rangkaian secara individu, gunakan cctv_edge_processors_write transfer_cameras. Memerlukan targetFacilityId, deviceType. Meminta pengesahan.
Parameter
| Nama | Jenis | Penerangan |
|---|---|---|
action* | "rename_screen" | "configure_screen" | "move" | Perkara yang hendak dilakukan; setiap tindakan diterangkan dalam penerangan alat. |
deviceID | string | deviceID skrin (kod 6 aksara) |
displayName | string | Nama skrin baharu (rename_screen, configure_screen) |
facilityId | string | ID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan. |
orientation | "normal" | "left" | "right" | "inverted" | Putaran skrin (configure_screen) |
resolution | "auto" | "1920x1080" | "1280x720" | "720x400" | Resolusi output; auto menggunakan resolusi yang dilaporkan oleh paparan (configure_screen) |
scheduledReboot | "disabled" | "daily" | "weekly" | "monthly" | Waktu skrin but semula dengan sendirinya (configure_screen) |
displayBrightness | integer | Kecerahan lampu latar, 0-100 (configure_screen) |
airplayEnabled | boolean | Skrin menerima AirPlay (configure_screen) |
airplayName | string | Nama penerima AirPlay tersuai; kosongkan untuk nama automatik (configure_screen) |
airplayPin | string | PIN AirPlay 4 digit; kosongkan untuk mengalih keluar (configure_screen) |
duressEnabled | boolean | Pengimbas butang duress Bluetooth (configure_screen) |
sonosEnabled | boolean | Kawalan pembesar suara Sonos (configure_screen) |
wifiSupport | boolean | Portal persediaan Wi-Fi captive (configure_screen) |
cameraRestreamingEnabled | boolean | Strim semula suapan kamera tempatan daripada skrin (configure_screen) |
sessionTimerEnabled | boolean | Synchronised session timer (master clock) and its bells (configure_screen) |
targetFacilityId | string | Kemudahan destinasi peranti (move) |
deviceType | "screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor" | Jenis peranti; ia menentukan pengecam yang perlu dihantar (move) |
deviceUuid | string | deviceUuid kamera, pengawal pintu, ejen AI atau edge processor (move) |
deviceSerialNumber | string | Nombor siri butang duress (move) |
confirm | boolean | Tetapkan hanya selepas pengguna mengesahkan pratonton yang dikembalikan oleh panggilan pertama |
device_send_commandPengurusan PerantiMenghantar arahan langsung kepada satu peranti, atau kepada setiap peranti di sesebuah kemudahan: but semula, hidupkan atau matikan paparan, mulakan semula pelayar, paparkan mesej, muatkan halaman, pasang kemas kini atau kitar kuasa port PoE. Peranti dalam talian bertindak dalam beberapa saat; peranti luar talian tidak akan menerimanya. Setiap arahan meminta pengesahan dahulu.
Sasarkan satu peranti dengan uuid (deviceUuid daripada device_inventory_read), atau setiap peranti dengan broadcast: true. Hantar facilityIds untuk menjalankannya di beberapa kemudahan. Skrin menerima setiap arahan; kamera menerima rebootDevice dan unlockUpdates. Kamera rangkaian (deviceUuid bermula dengan ep_) tidak boleh menerima arahan; sasarkan edge processornya (edgeProcessorUUID) atau kitar kuasa port PoE-nya.
Untuk memulihkan kamera PoE yang luar talian, baca metadata.networkStats (switchID, sw_port) kamera itu dalam device_inventory_read, kemudian hantar powerCyclePort kepada mana-mana peranti dalam talian di kemudahan itu dengan arguments {switchID, switchPort}. Peranti tersebut meminta pengawal rangkaian kemudahan memutuskan dan memulihkan kuasa port itu.
Parameter
| Nama | Jenis | Penerangan |
|---|---|---|
facilityId | string | ID kemudahan. Pilihan jika kemudahan yang disambungkan ialah kemudahan yang Anda maksudkan. |
facilityIds | array | Beberapa ID kemudahan, untuk menjalankan permintaan yang sama di setiap satu. Gunakan sebagai ganti facilityId. |
command* | "displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort" | Arahan yang hendak dihantar. Siarkan restartBleScanner apabila butang duress tidak dikesan; menambah, memindahkan atau mengalih keluar butang sudah melakukannya, dan skrin memuat semula senarai setiap ~10 minit. |
broadcast | boolean | Hantar kepada setiap peranti di kemudahan dan bukannya satu uuid |
uuid | string | deviceUuid daripada device_inventory_read; tinggalkan semasa menyiarkan |
arguments | objectstring | osd: teks mesej, dipaparkan di atas kandungan semasa. loadUrl: URL http(s), dipaparkan sehingga muatan program seterusnya atau but semula. powerCyclePort: {switchID, switchPort}. Tinggalkan untuk arahan lain. |
confirm | boolean | Tetapkan hanya selepas pengguna mengesahkan pratonton yang dikembalikan oleh panggilan pertama |