diff --git a/README.md b/README.md index bb36bb7..1df0abf 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,35 @@ -# hue-plus -## Now with custom LED, audio mode on Windows, turning on and off based on time, and a custom mode builder and a developer library, plus bug fixes! -Support me on patreon: https://www.patreon.com/kusti8 +# hue-plus [](https://ci.appveyor.com/project/kusti8/hue-plus) + -[](https://ci.appveyor.com/project/kusti8/hue-plus) +Support me on patreon: https://www.patreon.com/kusti8 A **cross-platform** driver in Python for the NZXT Hue+. Supports **all functionality** except FPS, CPU, and GPU lighting. +Latest features: +* Custom LED +* Audio mode for Windows +* On/Off Timer +* Custom mode builder +* Developer library +    -## Install -### Windows -There is always an easy exe installer available here: +## Installation +### Windows: +Installer available here: https://github.com/kusti8/hue-plus/releases/latest -### Linux +### Linux: You must have `python3-dev` and `portaudio19-dev` installed! -To install it system wide, simply install using pip: +To install it system wide use pip: ``` sudo pip3 install hue_plus ``` Now it will be available as `hue` or `hue_ui` for the GUI. ## Quick Start -Each mode accepts different arguments, so it's easiest to just read the usage. -Basic usage is shown below. +Each mode accepts different arguments, so just read the usage. +Basic usage is shown below: ### Set a fixed color on all channels `sudo hue fixed FFFFFF` where FFFFFF is the color in hex. @@ -32,12 +38,10 @@ Basic usage is shown below. `sudo hue -g 1 fixed FFFFFF` will bring up a color picker to choose a color ### Set a specific channel `sudo hue -c 1 fixed FFFFFF` where 1 is channel one and 2 is channel two -## Usage +## Help All help and usage can be found by running ``hue -h`` *The default hue.py now includes the color selector, simply set -g to however many colors you want* -## Limitations -No FPS, CPU temp, or GPU temp, but other than that a perfect replica. ## Developers Hue_plus can easily be integrated into existing software. The entire codebase is separated into simple functions that separate all usage and can be directly called. The script provides a simple argument wrapper around them, but they are easily usable. **I highly suggest you read through the main ``hue.py`` file, specifically ``hue.main()`` to get acquianted with how to use it. Each function is slightly different.** @@ -57,19 +61,19 @@ hue_plus.fixed(ser, 0, 0, 'FF0000') # First argument is ser, second is whether t Argument name | Description --- | --- ser | The serial object, created as shown above -gui | How many colors to select in the GUI, 0 is none -channel | The channel number to use, 1 or 2, 0 is both +gui | How many colors to select in the GUI. 0 for none. +channel | The channel number to use, 1 or 2. 0 for both. color(s) | The color(s) to use. If accepts more than 1 color, then in a list (`['FF0000', '00FF00']`) -speed | The speed, from 0 (Slowest) to 4 (Fastest). 2 is normal +speed | The speed, from 0 (Slowest) to 4 (Fastest). 2 for normal. size | The amount of LEDs to shine, from 0-3, where 0=3, 1=4, 2=5, 3=6 -direction | Supports going backwards, where backwards=1 and forwards=0. **Not supported in marquee or cover_marquee** +direction | Supports going backwards (1) and forwards (0). **Not supported in marquee or cover_marquee** moving | `true` or `false` if alternating looks like it is moving state | For power mode, either `'on'` or `'off'` mode | For custom mode, either `'fixed'`, `'breathing'`, or `'wave'` ## Notes -Hue-plus does not automatically run on startup. This will not be added as a feature, but you should do this manually if you want that. For windows, follow this: http://www.thewindowsclub.com/make-programs-run-on-startup-windows. For Mac/Linux, use cron. +Hue-plus does not automatically run on startup. This will not be added as a feature. For windows, follow this: http://www.thewindowsclub.com/make-programs-run-on-startup-windows. Use cron for Mac/Linux. ## Warning - I (the author) hold no liability for any broken or not working Hue+ by running this script. It is provided as is. It worked for me, but your milage may vary + I (the author) hold no liability for any broken or not working Hue+ by running this script. It is provided as is. It worked for me, but your mileage may vary.