ZaoControlCloud の使用方法

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

■ ビルドと導入

ビルド方法にしたがって apps/control-cloud/ でビルドすると ZaoControlCloud が得られます。

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

ZaoControlCloud <options...>

• -u <url> または --url=<url> : 接続するクラウドの REST API サーバーの URL 指定
  • 例: -u https://example.com
  • このオプションは必須です。
• -m <bool> または --manual=<bool> : アプリケーション起動時のクラウド接続と OnAir の手動開始指定
  • 例: -m 1
  • アプリケーション起動時にクラウド接続と OnAir を手動で開始させたい場合は 1 を指定します。
    • 1 または true : アプリケーション起動時にクラウド接続と OnAir を自動で開始しません。手動でのメニュー操作が必要になります。
    • 0 または false : アプリケーション起動時にクラウド接続と OnAir を自動で開始します。
      ※ アプリケーション起動時に未ペアリングだった場合、手動でのペアリング操作を行った後、ペアリング完了時に自動で OnAir を開始します。
      ※ アプリケーション起動時のみの自動開始の指定です。OffAir 後やクラウドとの接続を切断した後は、自動で OnAir を開始しません。
  • オプションを指定していない場合は、上記の 0/false の設定と同様の動作となります。
• -c <bool> または --insecure=<bool> : クラウド接続時の HTTPS 通信のサーバー証明書の検証実施を指定します。
  • 例: -c 1
  • クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行わない場合は 1 を指定します。
    • 1 または true : クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行いません。
    • 0 または false : クラウド接続時の HTTPS 通信のサーバー証明書の検証を常に行います。
  • オプションを指定していない場合は、上記の 0/false の設定と同様の動作となります。
• --link-path=<path> : 連携用パスの指定 (SDK1.6から短いオプション(-p)は廃止されました)
  • ZaoRemoteEndpointとの連携に用いるパスを指定します。
  • 省略時は unix:///run/zao/RemoteEndpoint.sock となります。
• -l <level> または --log-level=<level> : ログ出力レベルの指定
  • LEVELには trace, debug, info, warning, error, critical, off または、その頭文字である T, D, I, W, E, C, O (大文字)が指定できます。
  • デフォルトは info となります。
• --log-color : ログへの色付けを有効にします。
• --log-no-color : ログへの色付けを無効にします。
  • デフォルトでは、出力先が端末(tty)か否かに基づき自動で色の有無を決定します。
• --log-output=<output> : ログの出力先。
  • stdout, stderr, syslog, null のいずれかを指定します。
  • デフォルトは syslog となります。
• --syslog-ident=<name> : syslog出力時のident名称。
  • デフォルトは CC (ControlCloudの略)となります。
• --syslog-facility=<name_or_number> : syslog出力時のfacilityコード。
  • alert 等の文字列か、0～23の数値でfacilityを指定します。
  • デフォルトは local0 となります。
• -v または --verbose : verbose 指定
  • -l/--log-level によるログレベルを1段階詳細な方に引き上げるのと同等です。
• -h または --help : コマンドラインオプションに関するヘルプを表示して終了します。

■ 環境変数

• 起動時に下記の環境変数を参照します。
• 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 以外 の設定と同様の動作となります。
• コマンドラインオプションで同様の指定していた場合、コマンドラインオプション指定を設定します。

■ 設定ファイル

起動時に /etc/zao/Cotrol.conf を読み込みます。 以下に例を示します。

ZAO_CLOUD_URL='https://cvp-08694305-00v.zaoweb.net/api/v1/transmitters/'

■ 自動実行

CUI 時

Linux が CUI モードで起動する場合、getty@tty1.service の働きでアカウント zaoauto に自動ログインします。 zaoauto のログインシェルとしてシェルスクリプトが実行され、結果として ZaoCotrolCloud が実行されませす。

GUI 時

Linux が GUI モードで起動する場合、zao-control-cloud.service から tmux 下で ZaoControlCloud が起動されます。

tmux 化で動作している ZaoControlCloud にアタッチ

tmux 下で動作している ZaoControlCloud にアタッチするには以下のコマンドを実行します。

$ tmux -S /tmp/tmux-ZaoCotrol attach

■ 手動実行

• 自動実行と多重に起動すると正常に動作しませんので、自動実行していない状態でのみ手動実行可能です
• zao group に属しているアカウントで実行する必要があります

■ 制限事項

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