The alienware-cli crate uses the alienware Rust API crate to provide CLI access to the Linux sysfs platform api for
control of the lights on an Alienware Alpha desktop machine. The API is based on the alienware_wmi_control.sh script
that used to come with the SteamOS distribution of Linux for Alienware machines.
You might also want to check out a python project to control the same lights
AlienFX.
To use alienware-cli, first install it.
If cargo is available to your root user with a correct toolchain:
bash
$ sudo cargo install alienware_cli --root /usr/local
Alternatively install for yourself and then copy to a location that is in all users path:
bash
$ cargo install alienware-cli
$ sudo cp ~/.cargo/bin/awc /usr/local/bin
To see a description of the command line parameters use the -h parameter:
```bash $ awc -h Usage: awc [OPTIONS]
awc v0.1.2: Command Line app to control the lights on an Alienware Alpha R1/R2
Optional arguments: -h,--help Show this help message and exit -v,--version Get version info -j,--json Output in JSON format for machine readability -c,--connector State of the HDMI ports -l,--led-state State of the LEDs -H,--head HEAD Set the LED state of the head button -L,--left LEFT Set the LED state of the left LEDs -R,--right RIGHT Set the LED state of the right LEDs ```
The -c and -l parameters show information about the hdmi connections and LEDs respectively, this two parameters can
be used together or separately and can also be used with the -j parameter which formats the response in json format
for machine readability:
```bash $ awc -lc HDMI passthrough state: present Input HDMI is unconnected Output HDMI is connected to gpu
LED state: present head: red: 15 green: 0 blue: 15 left: red: 0 green: 15 blue: 15 ```
bash
$ awc -jlc
{"hdmi":{"hdmi":{"exists":true,"input":"unconnected","output":"gpu"}},"leds":{"exists":true,"left":{"red":0,"green":15,"blue":15},"head":{"red":15,"green":0,"blue":15}}}
The colour of the LEDs can be set for different LED clusters with the -H, -L, and -R parameters for the head, left
and right clusters respectively. The LED colours can be set either with the name of the colour or the RGB value where
the value of each colour has a 0-15 scale. Since these commands are changing the values of files in sysfs, the command
should be run with root permissions:
Both of the following examples sets the head button to cyan:
bash
$ sudo awc -H cyan
bash
$ sudo awc -H "0 15 15"
If you use this software, you use it AT YOUR OWN RISK.
This software is licenced under the Apache-2.0 licence.