command line utility - ntim/hyperion GitHub Wiki
Hyperion comes with a simple command line utility, hyperion-remote, to send command to the Hyperion server using the Json interface.
The leds can be set using the color or image command. The color command will set all leds to the same color and the image command will read an image file and set all leds according to this image. Both commands can optionally be given a priority and/or a duration. When no duration is given, a clear command is needed to switch the leds off again. A priority channel can be cleared using the two clear command: clear and clearall. Clear will only clear the priority channel provided by the priority parameter or use the default when the parameter is not provided. Clearall on the other hand will clear all active priority channels and effectively set all leds to black. Color transformation can be applied to adjust the values written to the led device. The following transformations are supported (All transformations are executed in the order of the list below): * HSV color transform * Saturation: apply gain factor * Value: apply gain factor * Transform for each color component (red, green, and blue) * Threshold: all values below the threshold will be zeroed * Gamma: apply a gamma curve * Blacklevel/whitelevel: Scale the output value from [0,1] to [blacklevel,whitelevel]Note: changes to the color transformations are not written to the configuration file of Hyperion at this moment. Any changes made to the color transformations using the Json interface will be lost after a restart of Hyperion. Nevertheless, setting the color transformations using the command line utility provides an easy and fast way to find a good configuration.
The Json interface provided by the server is a simple text base interface where messages are newline separated. The format of each message can simply be seen by running the _hyperion-remote_ with the --print options to display the messages which are exchanged between the client and the server. ```Shell Simple application to send a command to hyperion using the Json interface Build time: Dec 9 2013 19:51:54Usage: hyperion-remote [OPTIONS]
Parameters: -a, --address Set the address of the hyperion server [default: localhost:19444] -p, --priority Use to the provided priority channel (the lower the number, the higher the priority) [default: 100] -d, --duration Specify how long the leds should be switched on in millseconds [default: infinity] -c, --color Set all leds to a constant color (either RRGGBB hex value or a color name. The color may be repeated multiple time like: RRGGBBRRGGBB) -i, --image Set the leds to the colors according to the given image file -e, --effect Enable the effect with the given name --effectArgs Arguments to use in combination with the specified effect. Should be a Json object string. -l, --list List server info -x, --clear Clear data for the priority channel provided by the -p option --clearall Clear data for all active priority channels -q, --qualifier Identifier(qualifier) of the transform to set -s, --saturation Set the HSV saturation gain of the leds -v, --value Set the HSV value gain of the leds -g, --gamma Set the gamma of the leds (requires 3 space seperated values) -t, --threshold Set the threshold of the leds (requires 3 space seperated values between 0.0 and 1.0) -b, --blacklevel Set the blacklevel of the leds (requires 3 space seperated values which are normally between 0.0 and 1.0) -w, --whitelevel Set the whitelevel of the leds (requires 3 space seperated values which are normally between 0.0 and 1.0) --print Print the json input and output messages on stdout -h, --help Show this help message and exit