サンプルプログラム ZaoControlCloud の使用方法

ZaoControlCloudは制御やUIの提供を行うプログラムです。

■ ビルドと導入

ビルド方法にしたがってビルドすると control-cloud/ZaoControlCloud が得られます。 SDK セットアップによってインストールされたビルド済みバイナリと置き換えるには以下のようにコマンド実行してください。

$ sudo install -m 755 -o root -g root control-cloud/ZaoControlCloud /usr/local/libexec/zao/

■ コマンドラインオプション

ZaoControlCloud -u <rest_api_url> [-m <manual_start>] [-c <cert_insecure>] [-p <link-path>]

• -u <rest_api_url>: 接続するクラウドの REST API サーバーの URL 指定
  • 例: -u https://example.com
  • このオプションは必須です。
• -m <manual_start> : アプリケーション起動時のクラウド接続と OnAir の手動開始指定
  • 例: -m 1
  • アプリケーション起動時にクラウド接続と OnAir を手動で開始させたい場合は 1 を指定します。
    • 1 : アプリケーション起動時にクラウド接続と OnAir を自動で開始しません。手動でのメニュー操作が必要になります。
    • 1 以外 : アプリケーション起動時にクラウド接続と OnAir を自動で開始します。
      ※ アプリケーション起動時に未ペアリングだった場合、手動でのペアリング操作を行った後、ペアリング完了時に自動で OnAir を開始します。
      ※ アプリケーション起動時のみの自動開始の指定です。OffAir 後やクラウドとの接続を切断した後は、自動で OnAir を開始しません。
  • オプションを指定していない場合は、上記の 1 以外 の設定と同様の動作となります。
• -c <cert_insecure> : クラウド接続時の HTTPS 通信のサーバー証明書の検証実施を指定します。
  • 例: -c 1
  • クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行わない場合は 1 を指定します。
    • 1 : クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行いません。
    • 1 以外 : クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行います。
  • オプションを指定していない場合は、上記の 1 以外 の設定と同様の動作となります。
• -p <link-path> : 連携用パスの指定
  • ZaoRemoteEndpoint との連携に用いるパスを指定します。
  • 省略時は unix:///run/zao/RemoteEndpoint.sock となります。

■ 環境変数

• 起動時に下記の環境変数を参照します。
• CLOUD_REST_API : 接続するクラウドの REST API サーバーの URL 指定
  • 例: export CLOUD_REST_API='https://example.com'
• CLOUD_MANUAL : アプリケーション起動時のクラウド接続と OnAir の手動開始指定
  • 例: export CLOUD_MANUAL=1
  • アプリケーション起動時にクラウド接続と OnAir を手動で開始させたい場合は 1 を指定します。
    • 1 : アプリケーション起動時にクラウド接続と OnAir を自動で開始しません。手動でのメニュー操作が必要になります。
    • 1 以外 : アプリケーション起動時にクラウド接続と OnAir を自動で開始します。
      ※ アプリケーション起動時に未ペアリングだった場合、手動でのペアリング操作を行った後、ペアリング完了時に自動で OnAir を開始します。
      ※ アプリケーション起動時のみの自動開始の指定です。OffAir 後やクラウドとの接続を切断した後は、自動で OnAir を開始しません。
  • オプションを指定していない場合は、上記の 1 以外 の設定と同様の動作となります。
• CLOUD_CERT_INSECURE : クラウド接続時の HTTPS 通信のサーバー証明書の検証実施を指定します。
  • 例: export CLOUD_CERT_INSECURE=1
  • クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行わない場合は 1 を指定します。
    • 1 : クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行いません。
    • 1 以外 : クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行います。
  • オプションを指定していない場合は、上記の 1 以外 の設定と同様の動作となります。
• コマンドラインオプションで同様の指定していた場合、コマンドラインオプション指定を設定します。

■ 主な操作

• s キー、c キーでメニューが表示されます。メニューの各項目を選択して、操作します。
• 強制終了する場合には、Ctrl-C を入力します。

■ 制限事項

• 画面・ターミナルの列数・行数が少ない場合はエラー終了します。