schrofi
/
happy-cat
1
0
Fork 0
Code Releases Activity

update readme

master
Florian Schrofner 2022-02-27 11:15:35 +01:00
parent 61b420a322
commit e646c9253c
1 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,19 +1,37 @@
# Happy Cat 🐈🌞 # happy-cat 🐈🌞
A commandline utility to control your [Elgato Key Light](https://www.elgato.com/en/key-light) and [Key Light Air](https://www.elgato.com/en/key-light-air). A commandline utility to control your [Elgato Key Light](https://www.elgato.com/en/key-light) and [Key Light Air](https://www.elgato.com/en/key-light-air), written in [Kotlin](https://kotlinlang.org/).
Change your light settings easily inside scripts or use configuration files to automatically apply your preferred setup over the course of the day, possibly even exploring the use as a [light therapy](https://en.wikipedia.org/wiki/Light_therapy) device. Script your light settings or use configuration files to automatically apply your preferred setup over the course of the day, possibly even exploring the use as a [light therapy](https://en.wikipedia.org/wiki/Light_therapy) device.
Please report issues, bugs or feature requests [here](https://codeberg.org/schrofi/happy-cat/issues). Please report issues, bugs or feature requests [here](https://codeberg.org/schrofi/happy-cat/issues).
## Running ## Running
Download the newest release for your system from the [releases page](https://codeberg.org/schrofi/happy-cat/releases). Download the newest release for your system from the [releases page](https://codeberg.org/schrofi/happy-cat/releases).
On Linux and Mac OS you can run the native binaries by simply executing `./hc`. On Linux and Mac OS you can run the native binaries by simply executing `./hc`.
On all other systems you have to resort to java by running the jar like `java -jar ./hc.jar` On all other systems you have to resort to java by downloading the JVM version and running the jar like `java -jar ./hc.jar`
## Usage ## Usage
Happy cat is split up into multiple subcommands, each of which have their own parameters. ```
schrofi@linux ~> hc
Usage: hc [OPTIONS] COMMAND [ARGS]...
A commandline utility to control your elgato keylight
Options:
-h, --help Show this message and exit
Commands:
apply Applies the currently valid configuration inside the configuration
file to the specified light
daemon Starts a daemon which applies the currently valid configuration
inside the configuration file every minute
get Gets and prints the current setting of the specified light
set Sets the defined values to the specified light
```
happy-cat is split up into multiple subcommands, each of which have their own parameters.
To find out more about each command, check out the help pages by appending `--help` after the command. To find out more about each command, check out the help pages by appending `--help` after the command.
*Important: Happy cat uses Kelvin to measure light temperature, while Elgato lamps use their own format internally. Conversion between the two is done on the fly* *Important: happy-cat uses Kelvin to measure light temperature, while Elgato lamps use their own format internally. Conversion between the two is done on the fly*
#### Apply #### Apply
Reads the provided configuration file, determines the currently active state based on time definitions and applies the state to the given light once. Reads the provided configuration file, determines the currently active state based on time definitions and applies the state to the given light once.
It's basically a oneshot version of the `daemon` command. For examples of the configuration file, check the corresponding paragraph below. It's basically a oneshot version of the `daemon` command. For examples of the configuration file, check the corresponding paragraph below.