Updated Home (markdown)

poljvd 2013-08-31 07:31:43 -07:00
parent 520a8d974c
commit c135cbb5d9
1 changed files with 40 additions and 1 deletions

41
Home.md

@ -23,7 +23,46 @@ TODO
TODO
<h2 id="utility">Command line utility</h2>
TODO
Hyperion comes with a simple command line utility, _hyperion-remote_, to send command to the Hyperion server using the Json interface.
<h4>Setting the leds</h4>
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.
<h4>Clearing the leds</h4>
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.
<h4>Color transformations</h4>
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]
<h4>Usage</h4>
```Shell
Usage: ./hyperion-remote [OPTIONS]
Parameters:
-a, --address <arg> Set the address of the hyperion server [default: localhost:19444]
-p, --priority <arg> Use to the provided priority channel (the lower the number, the higher the priority) [default: 100]
-d, --duration <arg> Specify how long the leds should be switched on in millseconds [default: infinity]
-c, --color <arg> Set all leds to a constant color (either RRGGBB hex value or a color name)
-i, --image <arg> Set the leds to the colors according to the given image file
-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
-s, --saturation <arg> Set the HSV saturation gain of the leds
-v, --value <arg> Set the HSV value gain of the leds
-g, --gamma <arg> Set the gamma of the leds (requires 3 space seperated values)
-t, --threshold <arg> Set the threshold of the leds (requires 3 space seperated values between 0.0 and 1.0)
-b, --blacklevel <arg> Set the blacklevel of the leds (requires 3 space seperated values which are normally between 0.0 and 1.0)
-w, --whitelevel <arg> 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
```
<h2 id="hardware">Hardware</h2>
TODO