Skip to content

Commit

Permalink
docs: update README to reflect keylight -> elgato-light
Browse files Browse the repository at this point in the history
  • Loading branch information
wassimk committed Jun 8, 2024
1 parent 07100ff commit 5065a64
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,52 +11,52 @@ During troubleshooting, I learned it always has an IP address and never loses a
It's a CLI tool with my Elgato light IP address of *192.168.0.25*, brightness, and temperature hard-coded as the defaults.

```shell
keylight on
keylight off
elgato-light on
elgato-light off
```

Brightness and/or temperature can be set when turning on.

```shell
keylight on --brightness 20
keylight on --temperature 5000
keylight on --brightness 20 --temperature 5000
elgato-light on --brightness 20
elgato-light on --temperature 5000
elgato-light on --brightness 20 --temperature 5000
```

Change the relative brightness between 0 and 100. *Use `--` for negative values.*

```shell
keylight brightness -- 10
keylight brightness -- -10
elgato-light brightness -- 10
elgato-light brightness -- -10
```

Set the temperature between 2900 and 7000.

```shell
keylight temperature 5000
elgato-light temperature 5000
```

Use a non-default IP address for the light on all commands.

```shell
keylight on --ip-address 192.168.0.10
keylight off --ip-address 192.168.0.10
elgato-light on --ip-address 192.168.0.10
elgato-light off --ip-address 192.168.0.10
```

Help is available for all commands.

```shell
keylight --help
keyligth on --help
keylight brightness --help
elgato-light --help
elgato-light on --help
elgato-light brightness --help
```

### Troubleshooting

Get the light status.

```shell
keylight status
elgato-light status
```

The Apple binaries are not signed with an Apple Developer account, so you must authorize them manually.
Expand Down

0 comments on commit 5065a64

Please sign in to comment.