Sample Programs Using ZaoControlCloud

ZaoControlCloud is a program that provides control and UI.

■ Build and Installation

Build according to the build method to obtain control-cloud/ZaoControlCloud. To replace the pre-built binary installed by the SDK setup, execute the command as follows.

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

■ Command line options.

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

• -u <rest_api_url>: URL of the cloud REST API server to connect to.
  • Example: -u https://example.com
  • This option is required.
• -m <manual_start> : specify cloud connection and manual start of OnAir at application startup.
  • Example: -m 1.
  • Specify 1 if you want to start cloud connection and OnAir manually at application startup.
    • 1 : Cloud connection and OnAir will not be started automatically when the application is started. Manual menu operation is required.
    • Other than 1 : Cloud connection and OnAir will be started automatically at application startup.
      If the application is not paired at startup, OnAir will start automatically when pairing is completed after manual pairing operation.
      
      • Specifies automatic start only when the application is launched; OnAir will not start automatically after OffAir or after disconnecting from the cloud.
  • If the option is not specified, the behavior is the same as the setting for 1 other than 1 above.
• -c <cert_insecure> : Specify the server certificate verification enforcement for HTTPS communication when connecting to the cloud.
  • Example: -c 1.
  • -c 1 : If you do not always verify server certificates for HTTPS communication when connecting to the cloud, specify 1.
    • 1 : Do not always verify server certificates for HTTPS communication when connecting to the cloud.
    • Other than 1 : Always validate server certificates for HTTPS communication when connecting to the cloud.
  • If the option is not specified, the behavior is the same as the above other than 1 setting.
• -p <link-path> : Specify the path for linking.
  • -p <link-path> : Specify the path for linking with ZaoRemoteEndpoint.
  • If omitted, it is unix:///run/zao/RemoteEndpoint.sock.

■ Environment variables

• The following environment variables are referenced at startup.
• CLOUD_REST_API : URL of the cloud REST API server to connect.
  • Example: export CLOUD_REST_API='https://example.com'
• CLOUD_MANUAL : specify cloud connection and manual start of OnAir at application startup.
  • Example: export CLOUD_MANUAL=1
  • Specify 1 if you want to start cloud connection and OnAir manually at application startup.
    • 1 : Cloud connection and OnAir will not be started automatically when the application starts. Manual menu operation is required.
    • Other than 1 : Cloud connection and OnAir will be started automatically at application startup.
      If the application is not paired at startup, OnAir will start automatically when pairing is completed after manual pairing operation.
      
      • Specifies automatic start only when the application is launched; OnAir will not start automatically after OffAir or after disconnecting from the cloud.
  • If the option is not specified, the behavior is the same as the above setting of other than 1.
• CLOUD_CERT_INSECURE : Specify server certificate verification for HTTPS communication when connecting to the cloud.
  • Example: export CLOUD_CERT_INSECURE=1
  • 1 : always do not validate server certificates for HTTPS communication when connecting to the cloud.
    • 1 : Do not always verify server certificates for HTTPS communication when connecting to the cloud.
    • Other than 1 : Always validate server certificates for HTTPS communication when connecting to the cloud.
  • If the option is not specified, the behavior is the same as the above other than 1 setting.
• If the same is specified by command line option, set the command line option specification.

■ Main operations

• The menu is displayed by pressing the s key or the c key. Select each item on the menu to operate.
• To force close the program, type Ctrl-C.

■ Restrictions

• If the number of columns or lines in the screen/terminal is small, an error will occur.