Zoom Roomsのルームコントロール

ルームコントロール機能を使用すると、サードパーティのIP対応機器を制御でき、ユーザーはZoom Roomsコントローラを通じてその機器を操作できるようになります。管理者は、構成プロファイルを作成して、Zoom Roomから発信IP制御メッセージを追加できます。

ルームコントロールを使用するための要件

注: オーディオ / ビデオ（A/V）用にルームコントロールを使用している場合、複数のNICを持つZoom Roomのコンピュータに個別のネットワークインテ―フェースカード（NIC）を割り当てることができます。NICは、Zoom Room対応のコンピュータに接続されている代替ネットワークに接続されたルームコントロールデバイスから個別に選択できます。この構成により、オーディオ / ビデオのトラフィックをプライマリネットワークから遠ざけることができます。

LANまたはWLANで制御可能なサードパーティデバイス

• Zoom Rooms:
  • PC: グローバル必要最低バージョン 以降
  • macOS: グローバル必要最低バージョン以降
  • 専用ハードウェア: グローバル必要最低バージョン 以降
• Zoom Roomsタッチ バージョン5.16.0以降
• デバイスにLANまたはWLAN アクセスがない場合は、iTachネットワークアダプター（IP2SL / IP2CCまたはWiFiに相当するもの）

USBシリアルアダプター

• Zoom Rooms:
  • PC: バージョン5.15.0以降
  • macOS: 5.15.0以降
• StartechやSabrentなど、Prolific PL2303チップセットを搭載したデバイス

ルームコントロールを有効にする方法

JSON構成プロファイルをアップロードする前に、Zoom Roomの設定を有効にする必要があります。

1. Zoomウェブポータルにサインインします。
2. [ルーム管理] をクリックし、[Zoom Rooms] を選択します。
3. Zoom Room名の右側にある [編集] をクリックします。
4. [デバイス] で、[ルームコントロールを有効にする] のトグルをオン（青）にします。
5. （オプション）[「ルームコントロール」をZoom Roomsコントローラのホーム画面として設定] の横にあるボックスにチェック を入れます。注: これには、Zoom RoomsおよびZoom Roomsコントローラアプリのバージョン6.3.0以降が必要です。
6. [プロファイルを作成] をクリックします。
7. このルームのJSON構成を入力します。

ルームコントロールプロファイルの書き方

はじめに

ルームコントロールプロファイルを書くには、JSONに関する実用的な知識が必要です。注意すべき点は、JSONがキー:値ペアベースのシステムであり、ファイルを正確にレイアウトするためには構文が重要だということです。JSONの基礎に関する詳細は、オンライン入門コースを参照してください。

どのコーディング言語でも、ファイルを次に処理する人にある程度の配慮を示す必要があります。ルームコントロールに対する特定の要件はありませんが、推奨されています。作成者、バージョン、その他の履歴の記録を残すために、'about'オブジェクトを使用して'adapters'の上に配置することができます。ルームコントロールはこれを解析しませんが、ポータルには残ります。以下はこれを活用するための例です。

{
"about": {
"type": "Medium Conference A",
"version": "v1.2.4",
"design_ref": "\\files\MediumConfA",
"created": "Mon, 21 Oct 2020 16:35:52 GMT"
},

アダプター

アダプターを設定すると、ルームコントロールがデバイスに接続されます。このセクションは、構成の主要なセクションです。入れ子になったJSON形式内の個々のデバイスは、同様の形式に従う必要があります（この例は、以下のコード例と並行して入れ子になっています）。

• Adapters: 個々のデバイス接続を定義したアダプター
  • Model: モデルは「GenericNetworkAdapter」、「IP2CC」、「IP2SL」のいずれかです。詳細は以下をご覧ください。
  • IP: これはネットワークデバイスのIPアドレスとポートです
    • 注: 現在のソフトウェアバージョンでは、ルームコントロールはIPアドレスの代わりにホスト名もサポートするようになりました。
  • UUID: これはGlobal Cachéデバイスでのみ必要で、「GlobalCache_[MAC]」に従います
  • Ports: ポートは、接続に添付されるデバイスを定義します
    • ID: コードのデバイスの名前です。JSON変数の形式に従う必要があります。
    • Name: これはユーザーがインターフェースで確認するフレンドリ名です
    • Methods: 個々のUIセクションの定義方法です
      • ID: これはコードで呼び出されるコントロールタイプのIDです（コントロールタイプに固有）。
      • Name: ユーザーがアクセスできるZoom Roomsインターフェースに表示される名前です。
      • Command: アクションタイプに応じて、コマンド文字列の完全なコマンドまたは共有部分のいずれかです。
        • 注: アクションタイプが'action'の場合、'params'内に挿入された要素のプレースホルダーとして、コマンド文字列に%が配置される必要があります。
         
      • Params: このセクションは'actions'タイプでのみ使用され、親コマンドに集約できる要素が含まれています。
        • ID: これはコードで呼び出されるプログラミングIDです。
        • Name: ルームコントロールボタンでユーザーがアクセスできるテキストです。
        • Value: 親コマンドに挿入されるコマンドセクションです。たとえば、'POWR000%\\x0D'を親コマンドとして使用し、一部のSharpディスプレイのオフに'0'、オンに'1'を挿入できます。

{
"adapters": [
            {
            "model": "iTachIP2SL",
            "ip": "[IP_ADDRESS]",
            "uuid": "GlobalCache_[UNIT_MAC_ADDRESS]",
            "ports": [
                     {
                     "id": "sl_sharp_tv",
                     "name": "Sharp Display",
                     "settings": {
                     "baud_rate": "38400",
                     "flow_control": "FLOW_NONE",
                     "parity": "PARITY_NO"
                     },
                     "methods": [
                                {
                                "id": "power",
                                "name": "Power",
                                "command": "POWR000%\\x0D",
                                "params": [
                                          {
                                          "id": "displayOn",
                                          "name": "On",
                                          "value": "0001"
                                          },
                                          {
                                          "id": "displayOff",
                                          "name": "Off",
                                          "value": "0000"
                                          }
                                          ],
                                "type": "actions" 
                                },
...

'methods'の下に、追加のセクション'response_filter'を追加できます。応答フィルタは、以下に定義された応答フィルタがリッスンする接続を理解するのを可能にするビーコンです。この領域には、定義されている関数はありません。応答フィルタが他のセクションでどのように適合するかは、それらのセクションで説明します。

スタイル

スタイルは、インターフェース要素の視覚的なスタイルを制御します。それほど広範に調整する必要がなく、比較的簡単に学ぶことができます。

インターフェースには多くのアイコンがあります。エアコンからスピーカーフォンまで、さまざまな製品に対応しています。以下のアイコンは現在のリストのものですが、リストは定期的に拡大しています。

デバイス	名前	画像
エアコン	icon_air_conditioner
ケーブルテレビ	icon_cable_tv
シーリングマイク	icon_ceiling_mic
カーテン	icon_curtain
DVDプレーヤー	icon_dvd_player
Xbox / PS4システム	icon_game_console
HDMI	icon_hdmi
ノートパソコン	icon_laptop
照明	icon_light
プロジェクター	icon_projector
ラック機器	icon_rack_equipment
衛星放送受信用アンテナ	icon_satellite_dish
スピーカー	icon_speaker
スピーカーフォン	icon_speakerphone
テレビ	icon_tv
電源	icon_power
上	icon_up
下	icon_down
冷	icon_cold
暖	icon_hot
乾燥	icon_dry
風	icon_wind

スタイル内にはアイコン（上記参照）、メインメソッド、可視性という3つの主要な修飾子があります。

アイコンは、システムを視覚化したものです。デバイスをマークしたり、ボタンに関連付けられたテキストを置き換えたりするために使用できます。以下の例では、'example'というデバイスを定義しています。

{
"adapters": [
            {
            "model": "ExternalControlSystem",
            "ip": "tcp://[USER_IP_ADDRESS]:[USER_PORT]",
            "ports": [
                     {
                     "id": "example",
                     "name": "Example Device",
                     "methods": [
...

'example'をデバイスとして定義すると、このIDをスタイル内で使用できます。たとえば、このexampleデバイスのメインアイコンを簡単に照明に設定することができます。

"styles": [
          "example.icon=icon_light",
          "example.main_method=power"
          ]

Zoomは、Googleの公式MDIサイトにあるマテリアルデザインアイコン（MDI）もサポートしています。

これらのアイコンのいずれかを指定するには、以下の形式の従います。

• mdi: この接頭辞を使用してアイコンをGoogle MDIアイコンとして識別します
• icon_name: Google Material Icons公式サイトでアイコンを検索して、'_'を使用してアイコン名の'(space)'を置き換えます
• style_name: support "outlined"、"filled"、"rounded"、"sharp"、"two_tone"

"example.icon=mdi:local_airport:two_tone"

これはすべて小文字である必要があります。アイコン名にはスペースの代わりにアンダースコア （_） を使用します。アイコンをダウンロードできない場合は、デフォルトのアイコンが表示されます。

また、お気づきかもしれませんが、1行内にデバイスのメインメソッドも定義しています。メインメソッドは、定義した参照コマンドをデバイスのタイトルバーに表示し、次のように目立たせます。

電源コマンドをメインメソッドとして定義したので、他のコマンドとは別に上部のバーに表示されています。

3つ目のスタイルタイプは「可視性」です。可視性は、プログラマーが関数を定義した後、その関数をユーザーのインターフェースから完全に非表示するのを可能にします。これは簡単に定義できます。

"example.power.invisible=true"

"device.command.invisible=true"の形式に従うと、このコマンドがRoomsユーザーから完全に非表示になります。

ルール

ルールはルームコントロールの自動化エンジンです。ここで自動的に実行される内容を定義します。たとえば、ミーティングがアクティブなときにのみディスプレイをアクティブにする場合は、「meeting_started」と「meeting_ended」（ストックZoomイベント）を使用して有効にします。

"rules": {
          "meeting_started": [
                             "display.power.on",
                             "camera.power.wake"
                             ]
          ）,
          "meeting_ended": [
                           "display.power.off"
                           ]
          }

この例は、システムの電源消費を削減するために使用できます。

1つのルールにつき1つのコマンドでは十分でない場合は、これらのコマンドを簡単にスタックすることもできます。各コマンドは技術的には順番に実行されますが、イベントが同時に実行されていると見なせるほど十分な速度で処理されます。上記の例では、ディスプレイが起動したときにカメラをアクティブにするために「display.power.on」の下に「camera.power.wake」を追加しました。

注:

• Zoom Roomsバージョン5.13.0で、ルール内で使用可能なZoomの共有コマンドが拡張されました。また、会議の開始 / 終了イベントは、Microsoft Teamsのダイレクトゲスト参加ミーティングを含む、サードパーティの相互接続ミーティングにも適用されるようになりました。このリリースでは、その他のイベントはサードパーティの相互接続ミーティングには適用されません。
• ルームコントロールのユーザーは、JSON構成で「events only」を指定して、不要なルームコントロールインターフェースを非表示にできます。このフィールドがJSONで明確に定義されている場合、ネイティブルームコントロールUIはZoom Roomsコントローラに表示されません。NRCイベントとZoomアプリの両方を使用するデプロイメントでは、ルームコントロールボタンは空のルームコントロールページを表示せずにZoomアプリのインターフェースを直接起動します。

注: 稼働時間イベントの稼働時間はZoom Rooms設定ページで設定します。

また、応答フィルタ用に独自のものを簡単に追加できます。ルールセクション内で、以下で説明するトリガーイベントを使用して、外部からの入力で独自の自動化を稼働させることもできます。

"rules":{
 "operation_time_started":[ 
 "light.power.on" 
],
 "user_customized_event1":[ 
 "light.power.off" 
]
         }

この例では、「user_customized_event1」で、制御対象の照明をオフにします。これは、ボタンからの入力や、モーションセンサーが非アクティブになった場合や、予約システムのようなサードパーティシステムがミーティングにチェックインしたユーザーがいないことをルームに伝えることで作動するようにできます。この機能は、ユーザーの想像力次第でさまざまな用途に使用できます。

シーン

「シーン」はZoom Rooms 5.13.0の新機能です。これにより、ルームコントロール機能の愛用者は自身のユーザー体験にマクロ機能（単一ボタンにスタックされた複数のコマンド）を追加できるようになりました。これは、シーンリコールや、プロジェクター画面を下げる場合やプロジェクターの電源を入れるなど、依存デバイスに役立ちます。

ルールやアダプターと同様に、シーンはJSONファイルの最上位レベルのセクションです。現在、最大20のシーンを設定できます。これらのシーンでは、最大50の独立したコマンドがサポートされます。

一度設定すると、これらの新しいシーンボタンはルームコントロールウィンドウの上部に表示されます。

シーンを設定するには、下記のコードサンプルを参照してください。

このコンテンツをコピーする前に、'//text'セクションは参照用のメモであり、最終的なJSONファイルに含めることはできないことにご留意ください。

"scenes":[
     {
          "id":"scene_1",                     //required
          "name":"Turn on all lights",        //optional, shown if name and icon are empty
          "icon":"icon_light",                //optional, see icon list
          "commands": [                       //required
               "light1.power.on",
"light2.power.on"
]
},
 {
          "id":"scene 2",
          "name":"Turn off all lights"
          "icon":"icon_light"
          "commands": [
               "light1.power.off",
"light2.power.off"
]
      }
  ]

応答フィルタ

応答フィルタは、ルームコントロール機能における強力な進歩です。これらのフィルタは、定義されたデバイスから戻ってくるメッセージを読み取り、一致するフレーズを瞬時にスキャンします。このフレーズ（または式）がその接続で識別されると、（上記で説明されているように）ルールトリガーイベントの処理が開始します。

各応答フィルタは、以下の3つの要素で構成されます。

• 「name」: 名前は「methods」の「ports」セクションで使用されます。応答フィルタが「ports」領域のこの名前と一致すると、定義された接続の範囲が広がり始めます
• 「filter_regex」: 正規表現（Regex）とは、応答フィルタが一致を試みる文字のセットです。一致すると「trigger_event」がアクティブになります
• 「trigger_event」: トリガーイベントはルールセクション内で使用されます。「filter_regex」がアクティブになると、ルールのこのトリガーイベントで定義された自動化が発生します

ルームコントロールの使用方法

Zoom Roomsコントローラで、[ルームコントロール] アイコンをタップすると、これらの追加機能にアクセスできます。

ミーティングに参加していない場合は、メインメニューにルームコントロールアイコンがあります。

ミーティング中、コントローラウィンドウの右上にあるアイコンをタップすると、同じルームコントロールが表示されます。

トラブルシューティング

トラブルシューティングは、カスタム設定において重要な部分です。ルームコントロールはシンプルですが、必要に応じて複雑にすることもできます。以下のセクションでは、潜在的な障壁を解決するのに役立ちます。

ルームコントロールのエラー

サンプルファイル

これらのファイルはさまざまなソースから集められており、開始点としてのみ使用してください。アプリケーションに適合させるために一部の修正が必要になる可能性があります。

• 汎用ファイル
  • Zoom RoomsコントロールJSONプロファイル
  • Zoom RoomコントロールJSONプロファイルと追加のコメント
  • 汎用照明JSONプロファイル（リレー）
  • 汎用照明JSONプロファイル（シリアル）
  • Zoom RoomコントロールJSONプロファイル（イベントのみ）
• Avocor
  • JSONプロファイル（IP）
• Middle Atlantic
  • Racklink JSONプロファイル（IP）
• Shure
  • MXA910 JSONプロファイル（IP）
• DTEN
  • DTEN Board D7 (USB-シリアル)