Update README.md

This commit is contained in:
q3aql 2021-07-06 12:59:12 +02:00
parent dd32014fb9
commit 08e0ae7174

View File

@ -1,4 +1,4 @@
# Logitech G203 Prodigy / G203 LightSync Mouse LED control
# Logitech G203 Prodigy/LightSync Mouse LED control (GUI)
Allows you to control the LED lighting of your G203 Prodigy or G203 LightSync Mouse programmatically. \
Inspired by and based on [g810-led](https://github.com/MatMoul/g810-led).
@ -7,24 +7,33 @@ Inspired by and based on [g810-led](https://github.com/MatMoul/g810-led).
- Python 3.5+
- PyUSB 1.0.2+
- Zenity
- **Root privileges**
## Installation
1) Clone the repository: `git clone https://github.com/smasty/g203-led.git`
2) Prepare _virtualenv_: `virtualenv ./env`
3) Install dependencies: `env/bin/pip install -r requirements.txt`
4) Run (as root): `sudo ./g203-led.py solid 00FFFF`
1) Clone the repository: `git clone https://github.com/q3aql/zenidrv-g203`
2) Install dependencies: `sudo apt-get install python3 python3-usb zenity coreutils`
3) Change directory: `cd zenidrv-g203`
4) Install as root: `sudo make install`
## Usage
## Usage (GUI)
Open application from menu or run the following command as root:
```
$ sudo zenidrv-g203
```
## Usage (CLI)
```
Usage:
g203-led [lightsync] solid {color} - Solid color mode
g203-led [lightsync] cycle [{rate} [{brightness}]] - Cycle through all colors
g203-led [lightsync] breathe {color} [{rate} [{brightness}]] - Single color breathing
g203-led [lightsync] intro {on|off} - Enable/disable startup effect
g203-led [lightsync] dpi {dpi} - Set mouse dpi
sudo g203-led.py [lightsync] solid {color} - Solid color mode
sudo g203-led.py [lightsync] cycle [{rate} [{brightness}]] - Cycle through all colors
sudo g203-led.py [lightsync] breathe {color} [{rate} [{brightness}]] - Single color breathing
sudo g203-led.py [lightsync] intro {on|off} - Enable/disable startup effect
sudo g203-led.py [lightsync] dpi {dpi} - Set mouse dpi
Arguments:
Color: RRGGBB (RGB hex value)
@ -33,9 +42,9 @@ Arguments:
DPI: 200-8000 (Prodigy), 50-8000 (Lightsync)
Additional features for G203 LightSync:
g203-led lightsync triple {color color color} - Sets all 3 colors from left to right.
g203-led lightsync wave {rate} [{brightness} [{direction}]] - Like cycle but appears to move right or left.
g203-led lightsync blend [{rate} [{brightness}]] - Like breathe with the side colors changing after some delay.
sudo g203-led.py lightsync triple {color color color} - Sets all 3 colors from left to right.
sudo g203-led.py lightsync wave {rate} [{brightness} [{direction}]] - Like cycle but appears to move right or left.
sudo g203-led.py lightsync blend [{rate} [{brightness}]] - Like breathe with the side colors changing after some delay.
Direction is either "left" or "right". Default: right).