デバイス管理

コアプラットフォーム
device_health_readデバイス管理

施設の最新のインターネット速度テストの結果を、デバイスに必要な帯域と比較します。network はダウンロードとアップロードの速度(Mbps)を返し、過去24時間に確認されたスクリーン、カメラ(録画とライブストリーミング)、接続されたスピーカーシステムについて、デバイス数、それぞれに必要な帯域、接続が十分かどうかを返します。動作が遅いデバイスや接続が切れるデバイスの診断、またはデバイスを追加する前の確認に使用します。複数の施設を確認するには facilityIds を渡します。

アクション:

  • network: ネットワーク帯域を確認します。

パラメーター

名前種類説明
action*"network"実行する操作です。各操作はツールの説明に記載されています。
facilityIdstring施設 ID。接続中の施設が対象の場合は省略できます。
facilityIdsarray同じリクエストをそれぞれで実行する複数の施設 ID。facilityId の代わりに使用します。
device_inventory_readデバイス管理

施設に登録されているすべてのデバイス: ディスプレイスクリーン、クラウドカメラ、ネットワークカメラ、AIエッジプロセッサ、緊急ボタン、ドアコントローラー、AIエージェント、IoT センサー。トラブルシューティング、機器の監査、デバイス ID の検索に使用します。

各デバイスには、種類、モデル、ID(deviceUuid。スクリーンは deviceID、緊急ボタンは deviceSerialNumber)、設置場所、ネットワークの詳細(IP、Wi-Fi または Ethernet、SSID、チャネル、近くのネットワーク。metadata.networkStats には PoE スイッチのポートが含まれます)、正常性(CPU 温度、メモリ、稼働時間)、最後のハートビートを Unix ミリ秒で示す metadata.updated があります。オフラインは5分間ハートビートがないことを意味します。7日以上オフラインで、オンラインの同等のデバイス(同じ機器、名前、設置場所)があるものは、交換された可能性が高いです。networkCamera の行は edgeProcessorUUID のエッジプロセッサが取得するストリームで、その deviceUuid(ep_ で始まる)はコマンドを受信できません。includeCredentials を設定しない限り、ストリーム URL の認証情報は : と表示されます。Wi-Fi よりも有線 Ethernet を推奨してください。

関連: cctv_cameras_read と cctv_cameras_write(カメラ)、cctv_edge_processors_write(エッジプロセッサ)、device_inventory_write(名前の変更、設定、移動)、device_send_command(制御)、device_health_read(帯域)。

アクション:

  • list: デバイスを一覧表示します。施設のデバイスを種類または名前でフィルターします。facilityIds を指定すると、各施設の最初のページを返します。

パラメーター

名前種類説明
action*"list"実行する操作です。各操作はツールの説明に記載されています。
facilityIdstring施設 ID。接続中の施設が対象の場合は省略できます。
facilityIdsarray同じリクエストをそれぞれで実行する複数の施設 ID。facilityId の代わりに使用します。
deviceTypestringこの種類のみ(deviceType と同じ値): screen、camera、networkCamera、duress など
querystring名前、部屋、deviceID、deviceUuid、シリアル番号にこの文字列が含まれるもの
includeCredentialsbooleanユーザー名とパスワードを含むストリーム URL を返します。既定ではオフです(認証情報は ***:*** と表示されます)。ユーザーが明示的に認証情報を必要とする場合にのみ設定してください。施設での監視カメラへのアクセス権が必要です。
limitinteger1ページあたりの件数(既定 25、最大 100)
cursorstring前のページの nextCursor
device_inventory_writeデバイス管理

施設に登録されているデバイスを変更します。rename_screen と configure_screen はディスプレイスクリーンを変更します(device_inventory_read の deviceID で特定します)。スクリーンのグループ、タグ、表示モードには、代わりにディスプレイ用のツールを使用してください。move は、スクリーン、クラウドカメラ、緊急ボタン、ドアコントローラー、AIエージェント、AIエッジプロセッサを同じ組織内の別の施設に移動します。

アクション:

  • rename_screen: スクリーンの名前を変更します。オフラインやサポート終了のスクリーンでもすぐに適用されます。deviceID、displayName が必要です。
  • configure_screen: スクリーンのハードウェア設定を変更します。渡した設定だけが変更されます。設定はデバイスに送信され、ディスプレイが再起動することがあります。オフラインとサポート終了のスクリーン(ステータス 409)は名前の変更のみ可能です。deviceID が必要です。確認を求めます。
  • move: デバイスを別の施設に移動します。facilityId はデバイスが現在ある施設です。移動先へのアクセス権も必要です。エッジプロセッサを移動すると、そのネットワークカメラも移動します。ネットワークカメラを個別に移動するには cctv_edge_processors_write の transfer_cameras を使用します。targetFacilityId、deviceType が必要です。確認を求めます。

パラメーター

名前種類説明
action*"rename_screen" | "configure_screen" | "move"実行する操作です。各操作はツールの説明に記載されています。
deviceIDstringスクリーンの deviceID(6文字のコード)
displayNamestring新しいスクリーン名(rename_screen、configure_screen)
facilityIdstring施設 ID。接続中の施設が対象の場合は省略できます。
orientation"normal" | "left" | "right" | "inverted"スクリーンの回転(configure_screen)
resolution"auto" | "1920x1080" | "1280x720" | "720x400"出力解像度。auto はディスプレイが報告する解像度を使用します(configure_screen)
scheduledReboot"disabled" | "daily" | "weekly" | "monthly"スクリーンが自動的に再起動するタイミング(configure_screen)
displayBrightnessintegerバックライトの明るさ(0~100)(configure_screen)
airplayEnabledbooleanスクリーンで AirPlay を受け付けます(configure_screen)
airplayNamestringAirPlay レシーバーのカスタム名。空にすると自動の名前になります(configure_screen)
airplayPinstring4桁の AirPlay PIN。空にすると削除します(configure_screen)
duressEnabledbooleanBluetooth 緊急ボタンのスキャナー(configure_screen)
sonosEnabledbooleanSonos スピーカーの制御(configure_screen)
wifiSupportbooleanWi-Fi セットアップ用のキャプティブポータル(configure_screen)
cameraRestreamingEnabledbooleanローカルのカメラ映像をスクリーンから再配信します(configure_screen)
sessionTimerEnabledbooleanSynchronised session timer (master clock) and its bells (configure_screen)
targetFacilityIdstringデバイスの移動先の施設(move)
deviceType"screen" | "camera" | "duress" | "door-controller" | "ph-ai-agent" | "ai-edge-processor"デバイスの種類。渡す識別子が決まります(move)
deviceUuidstringカメラ、ドアコントローラー、AIエージェント、エッジプロセッサの deviceUuid(move)
deviceSerialNumberstring緊急ボタンのシリアル番号(move)
confirmboolean最初の呼び出しで返されたプレビューをユーザーが確認した後にのみ設定します
device_send_commandデバイス管理

1台のデバイス、または施設のすべてのデバイスにライブコマンドを送信します: 再起動、ディスプレイのオン/オフ、ブラウザーの再起動、メッセージの表示、ページの読み込み、更新のインストール、PoE ポートの電源の入れ直し。オンラインのデバイスは数秒以内に実行し、オフラインのデバイスには届きません。どのコマンドも事前に確認を求めます。

1台のデバイスを対象にするには uuid(device_inventory_read から取得した deviceUuid)を、すべてのデバイスを対象にするには broadcast: true を指定します。複数の施設で実行するには facilityIds を渡します。スクリーンはすべてのコマンドを受け付け、カメラは rebootDevice と unlockUpdates を受け付けます。ネットワークカメラ(deviceUuid が ep_ で始まる)はコマンドを受信できません。そのエッジプロセッサ(edgeProcessorUUID)を対象にするか、PoE ポートの電源を入れ直してください。

オフラインの PoE カメラを復旧するには、device_inventory_read でその metadata.networkStats(switchID、sw_port)を確認し、施設内の任意のオンラインのデバイスに引数 {switchID, switchPort} を付けて powerCyclePort を送信します。そのデバイスが施設のネットワークコントローラーにポートの電源の遮断と復旧を依頼します。

パラメーター

名前種類説明
facilityIdstring施設 ID。接続中の施設が対象の場合は省略できます。
facilityIdsarray同じリクエストをそれぞれで実行する複数の施設 ID。facilityId の代わりに使用します。
command*"displayOff" | "displayOn" | "unlockUpdates" | "rebootDevice" | "restartBrowser" | "gpuDebugOn" | "gpuDebugOff" | "restartBleScanner" | "osd" | "loadUrl" | "powerCyclePort"送信するコマンド。緊急ボタンが検出されない場合は restartBleScanner をブロードキャストします。ボタンの追加、移動、削除ではこれが自動的に行われ、スクリーンは約10分ごとに一覧を再読み込みします。
broadcastboolean1つの uuid ではなく、施設のすべてのデバイスに送信します
uuidstringdevice_inventory_read から取得した deviceUuid。ブロードキャストする場合は省略します
argumentsobjectstringosd: 現在のコンテンツの上に表示するメッセージテキスト。loadUrl: http(s) の URL。次のプログラムの読み込みまたは再起動まで表示されます。powerCyclePort: {switchID, switchPort}。その他のコマンドでは省略します。
confirmboolean最初の呼び出しで返されたプレビューをユーザーが確認した後にのみ設定します