CLI Reference¶

This page provides documentation for the exoyone command line tool.

exoyone¶

ExoyOne Command-Line Interface (CLI).

Usage:

cli [OPTIONS] COMMAND [ARGS]...

Options:

  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.

get¶

Get information from your ExoyOne.

This includes the current state of the device, including power, color, effects, and more.

Usage:

cli get [OPTIONS] COMMAND [ARGS]...

Options:

  -H, --host TEXT  Hostname or IP address of your ExoyOne.  [env var:
                   EXOYONE_HOST; required]

color¶

Get the current hue, saturation and brightness values.

Usage:

cli get color [OPTIONS]

cycle-speed¶

Get the current effect speed.

Usage:

cli get cycle-speed [OPTIONS]

device-name¶

Get the device name.

Usage:

cli get device-name [OPTIONS]

direction¶

Get the effect direction (left/right).

Usage:

cli get direction [OPTIONS]

effect-speed¶

Get the current effect speed.

Usage:

cli get effect-speed [OPTIONS]

effects¶

Get a list of effects for the specified mode pack or all mode packs.

Usage:

cli get effects [OPTIONS]

Options:

  --mode-pack TEXT

everything¶

Get the state and value of all the things.

Usage:

cli get everything [OPTIONS]

mode-cycle¶

Get mode cycle state (on/off).

Usage:

cli get mode-cycle [OPTIONS]

music-sync¶

Get music sync state (on/off).

Usage:

cli get music-sync [OPTIONS]

power-state¶

Get the power state (on/off).

Usage:

cli get power-state [OPTIONS]

powerbank-mode¶

Get powered by powerbank state (on/off).

Usage:

cli get powerbank-mode [OPTIONS]

scene-generation¶

Get scene generation state (on/off).

Usage:

cli get scene-generation [OPTIONS]

shutdown-timer¶

Get the current shutdown timer.

Usage:

cli get shutdown-timer [OPTIONS]

set¶

Change things on your ExoyOne.

This includes turning it on or off, changing the color, effect, and more.

Usage:

cli set [OPTIONS] COMMAND [ARGS]...

Options:

  -H, --host TEXT  Hostname or IP address of your ExoyOne.  [env var:
                   EXOYONE_HOST; required]

color¶

Set the color by changing the hue, saturation and brightness.

Usage:

cli set color [OPTIONS] [HUE] [SAT] [BRI]

Options:

  [HUE]   Hue value between 0 and 255.  [required]
  [SAT]   Saturation value between 0 and 255.  [required]
  [BRI]   Brightness value between 0 and 255.  [required]

cycle-speed¶

Set the mode cycle duration in seconds.

Usage:

cli set cycle-speed [OPTIONS] [SECONDS]

Options:

  [SECONDS]  Delay in seconds between cycles when mode cycle is on.
             [required]

device-name¶

Set the device name of the ExoyOne.

Usage:

cli set device-name [OPTIONS] [NAME]

Options:

  [NAME]  Custom name for the ExoyOne.  [required]

direction¶

Set a direction for the active effect.

There are only two directions. The list of options is provided for entertainment purposes, as the actual values are 0 and 1. Feel free to mix left with down, right with forward and so on.

Usage:

cli set direction [OPTIONS] [this-way|that-way]

Options:

  [this-way|that-way]  Set the direction of the effect.  [required]

effect¶

Change the active effect.

Usage:

cli set effect [OPTIONS] [EFFECT]

Options:

  [EFFECT]  Name of the effect.  [required]

effect-speed¶

Set the speed of the effect.

Usage:

cli set effect-speed [OPTIONS] [SPEED]

Options:

  [SPEED]  Effect speed  [required]

mode-cycle¶

Turn mode cycle off or on.

Usage:

cli set mode-cycle [OPTIONS] [off|on]

Options:

  [off|on]  Turn mode cycle off or on.  [required]

music-sync¶

Turn music sync on or off.

Usage:

cli set music-sync [OPTIONS] [off|on]

Options:

  [off|on]  Turn music sync off or on.  [required]

power-state¶

Turn power state on or off.

Usage:

cli set power-state [OPTIONS] [off|on]

Options:

  [off|on]  Switch the power on or off  [required]

powerbank-mode¶

Turn powered by powerbank mode on or off.

Usage:

cli set powerbank-mode [OPTIONS] [off|on]

Options:

  [off|on]  Switch powered by powerbank mode on or off  [required]

restart-in-ap-mode¶

Restart the ExoyOne to enable Wi-Fi access point.

Usage:

cli set restart-in-ap-mode [OPTIONS]

scene-generation¶

Turn scene generation off or on.

Usage:

cli set scene-generation [OPTIONS] [off|on]

Options:

  [off|on]  Turn scene generation off or on.  [required]

shutdown-timer¶

Set the shutdown timer duration.

Usage:

cli set shutdown-timer [OPTIONS] [MINUTES]

Options:

  [MINUTES]  Duration of shutdown timer from 5 to 480 minutes, 0 to disable.
             [required]