Skip to content

Command line tool options

arvydas edited this page Sep 24, 2014 · 3 revisions
> blinkstick --help
BlinkStick control script 1.1.3
(c) Agile Innovative Ltd 2013-2014

Usage: blinkstick [options] [color]

Options:
  -h, --help            show this help message and exit
  -i, --info            Display BlinkStick info
  -s SERIAL, --serial=SERIAL
                        Select device by serial number. If unspecified, action
                        will be performed on all BlinkSticks.
  -v, --verbose         Display debug output

  Change color:
    These options control the color of the device

    --channel=CHANNEL   Select channel. Applies only to BlinkStick Pro.
    --index=INDEX       Select index. Applies only to BlinkStick Pro.
    --brightness=LIMIT  Limit the brightness of the color 0..100
    --limit=LIMIT       Alias to --brightness option
    --set-color=COLOR   Set the color for the device. This can also be the
                        last argument for the script. The value can either be
                        a named color, hex value, 'random' or 'off'.
                        CSS color names are defined
                        http://www.w3.org/TR/css3-color/ e.g. red, green,
                        blue. Specify color using hexadecimal color value e.g.
                        'FF3366'
    --inverse           Control BlinkSticks in inverse mode

  Control animations:
    These options will blink, morph or pulse selected color.

    --blink             Blink LED (requires --set-color or color set as last
                        argument, and optionally --delay)
    --pulse             Pulse LED (requires --set-color or color set as last
                        argument, and optionally --duration).
    --morph             Morph to specified color (requires --set-color or
                        color set as last argument, and optionally
                        --duration).
    --duration=DURATION
                        Set duration of transition in milliseconds (use with
                        --morph and --pulse).
    --delay=DELAY       Set time in milliseconds to light LED for (use with
                        --blink).
    --repeats=REPEATS   Number of repetitions (use with --blink and --pulse).

  Device data and behaviour:
    These options will change device mode and data stored internally.

    --set-mode=MODE     Set mode for BlinkStick Pro:
                            0 - default
                            1 - inverse
                            2 - ws2812
    --set-infoblock1=INFOBLOCK1
                        Set the first info block for the device.
    --set-infoblock2=INFOBLOCK2
                        Set the second info block for the device.

  Advanced options:
    --add-udev-rule     Add udev rule to access BlinkSticks without root
                        permissions. Must be run as root.