From 6f718ac51f0725f0093ed973ba9ebf9754b899e9 Mon Sep 17 00:00:00 2001 From: Luke Jones Date: Fri, 26 Jun 2020 09:14:18 +1200 Subject: [PATCH 1/2] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 91dacc42..de3b12f3 100644 --- a/README.md +++ b/README.md @@ -115,7 +115,7 @@ Occasionally I might break things for you by tweaking or changing the config fil need to remove `/etc/rog-core.conf` and restart the daemon to create a new one. You *can* back up the old one and copy settings back over (then restart daemon again). -## Use +# Usage **NOTE! Fan mode toggling requires a newer kernel**. I'm unsure when the patches required for it got merged - I've tested with the 5.6.6 kernel and above only. To see if the fan-mode changed cat either: @@ -175,6 +175,10 @@ Commands: `FanMode`, `LedWriteBytes`, `LedWriteMultizone`, `LedWriteEffect` TODO: fill in this info +### AniMe input + +You will want to look at what MeuMeu has done with [https://github.com/Meumeu/ZephyrusBling/](https://github.com/Meumeu/ZephyrusBling/) + ### Wireshark captures TODO: see `./wireshark_data/` for some captures. From 0b2df1b4684572ec6c5d3c7e67e9f4251f69f0cd Mon Sep 17 00:00:00 2001 From: Luke Jones Date: Fri, 26 Jun 2020 10:27:34 +1200 Subject: [PATCH 2/2] Update README.md --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/README.md b/README.md index de3b12f3..718e8739 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,60 @@ Some commands may have subcommands: rog-core --help ``` +### Example + +``` +$ rog-core --help +Usage: rog-core [OPTIONS] + +Optional arguments: + -h, --help print help message + -v, --version show program version number + -d, --daemon start daemon + -b, --bright VAL + -f, --fan-mode FAN + +Available commands: + led-mode Set the keyboard lighting from built-in modes + +$ rog-core led-mode --help +Usage: rog-core led-mode [OPTIONS] + +Optional arguments: + -h, --help print help message + +Available commands: + stable set a single static colour + breathe pulse between one or two colours + strobe strobe through all colours + rainbow rainbow cycling in one of four directions + star rain pattern mimicking raindrops + rain rain pattern of three preset colours + highlight pressed keys are highlighted to fade + laser pressed keys generate horizontal laser + ripple pressed keys ripple outwards like a splash + pulse set a rapid pulse + comet set a vertical line zooming from left + flash set a wide vertical line zooming from left + multi-static 4-zone multi-colour + +$ rog-core led-mode stable --help +Usage: rog-core led-mode stable [OPTIONS] + +Optional arguments: + -h, --help print help message + -c HEX set the RGB value e.g, ff00ff + +$ rog-core led-mode star --help +Usage: rog-core led-mode star [OPTIONS] + +Optional arguments: + -h, --help print help message + -c HEX set the first RGB value e.g, ff00ff + -C HEX set the second RGB value e.g, ff00ff + -s SPEED set the speed: low, med, high +``` + ## Daemon mode If the daemon service is enabled then on boot the following will be reloaded from save: