Files
asusctl/README.md
2020-04-16 16:02:16 +12:00

62 lines
1.6 KiB
Markdown

# ROG-Core
rog-core is a utility for Linux to control many aspects (eventually) of the ASUS ROG laptops like the Zephyrus GX502GW.
The laptop I currently have is the GX502RW and so I'll be using that for the basis of this app. If I get wireshark captures from others with different ROG laptops then I should be able to add something like laptop and feature detection.
## Requirements
- Rust!
- `libusb-1.0-0-dev` or equivalent package for your distro
- `libdbus-1-dev` or equivalent package for your distro
## Installing
Run `make` then `sudo make install`. If you want to use the daemon mode on system boot you'll need to enable and start the systemd service with:
```
$ sudo systemctl start rog-core.service
$ sudo systemctl enable rog-core.service
```
## Use
Running the program in standard mode (not daemon or client) will require sudo.
Otherwise if running in daemon mode (option `-d`) then you will need to add option `-c` before all commands to send the command to the daemon - this will change to default to sending to the daemon in future.
Commands are given by:
```
rog-core <option> <command> <command-options>
```
Help is available through:
```
rog-core --help
rog-core <command> --help
```
Some commands may have subcommands:
```
rog-core <command> <subcommand> --help
```
## Implemented
- [X] Setting/modifying built-in LED modes
- [ ] Per-key LED setting
- [ ] Fancy LED modes (custom programs)
- [X] Daemon mode (functionally done)
- [ ] Saving settings for reload (CLI and daemon mode)
- [ ] System control
- [ ] Capture and use hotkeys, e.g, Aura controls to control LEDs
## Wireshark captures
TODO
## License
Mozilla Public License 2 (MPL-2.0)