aura_led: capitalize "asus" name for consistency with previous code
This commit is contained in:
Jonas Malaco
parent
344ce6b7b5
commit
0839a571a0
|
|
@ -140,7 +140,7 @@ The notes are sorted alphabetically, major (upper case) notes before minor
|
|||
| Graphics card RGB | [Additional ASUS GTX and RTX cards](docs/nvidia-guide.md) | I²C | <sup>_Uex_</sup> |
|
||||
| Graphics card RGB | [EVGA GTX 1080 FTW](docs/nvidia-guide.md) | I²C | <sup>_Ux_</sup> |
|
||||
| Graphics card RGB | [Additional EVGA GTX 1070 and 1070 Ti cards](docs/nvidia-guide.md) | I²C | <sup>_Uenx_</sup> |
|
||||
| Motherboard | [Asus Aura LED motherboards](docs/asus-aura-led-guide.md) | USB HID | <sup>_e_</sup> |
|
||||
| Motherboard | [ASUS Aura LED motherboards](docs/asus-aura-led-guide.md) | USB HID | <sup>_e_</sup> |
|
||||
| Motherboard | [Gigabyte RGB Fusion 2.0 motherboards](docs/gigabyte-rgb-fusion2-guide.md) | USB HID | |
|
||||
| Power supply | [Corsair HX750i, HX850i, HX1000i, HX1200i](docs/corsair-hxi-rmi-psu-guide.md) | USB HID | <sup>_h_</sup> |
|
||||
| Power supply | [Corsair RM650i, RM750i, RM850i, RM1000i](docs/corsair-hxi-rmi-psu-guide.md) | USB HID | <sup>_h_</sup> |
|
||||
|
|
@ -712,7 +712,7 @@ As an alternative to using Task Scheduler, the batch file can simply be placed i
|
|||
You can follow either or both of the guides below to automatically configure your devices during login or after waking from sleep. The guides are hosted on tonymacx86:
|
||||
|
||||
- [This guide](https://www.tonymacx86.com/threads/gigabyte-z490-vision-d-thunderbolt-3-i5-10400-amd-rx-580.298642/post-2138475) is for controllers that lose their state during sleep (e.g. Gigabyte RGB Fusion 2.0) and need to be reinitialized after wake-from-sleep. This guide uses _Automator_ to initialize supported devices at login, and _sleepwatcher_ to initialize supported devices after wake-from-sleep.
|
||||
- [This guide](https://www.tonymacx86.com/threads/asus-z690-proart-creator-wifi-thunderbolt-4-i7-12700k-amd-rx-6800-xt.318311/post-2306524) is for controllers that do not lose their state during sleep (e.g. Asus Aura LED). This driver uses the _launchctl_ method to initialize supported devices at login.
|
||||
- [This guide](https://www.tonymacx86.com/threads/asus-z690-proart-creator-wifi-thunderbolt-4-i7-12700k-amd-rx-6800-xt.318311/post-2306524) is for controllers that do not lose their state during sleep (e.g. ASUS Aura LED). This driver uses the _launchctl_ method to initialize supported devices at login.
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
# Asus Aura LED (USB-based) controllers
|
||||
# ASUS Aura LED (USB-based) controllers
|
||||
_Driver API and source code available in [`liquidctl.driver.aura_led`](../liquidctl/driver/aura_led.py)._
|
||||
|
||||
__NOTE:__
|
||||
This driver is marked `experimental` because of the need for additional testing and feedback by the community. The API is unstable and may be changed in the future.
|
||||
|
||||
|
||||
This driver supports Asus Aura USB-based lighting controllers that appear in various Asus Z490, Z590, and Z690 motherboards. These controllers operate in either (a) direct mode or (b) effect mode. _Direct_ mode is employed by Aura Crate in Windows. It requires the application to send a continuous stream of commands to the controller in order to modulate lighting effects on each addressable LED. The other mode is _effect_ mode in which the controller itself modulates lighting effects on each addressable LED. Effect mode requires the application to issue a single set of command codes to the controller in order to initiate the given effect. The controller continues to process that effect until the application sends a different command.
|
||||
This driver supports ASUS Aura USB-based lighting controllers that appear in various ASUS Z490, Z590, and Z690 motherboards. These controllers operate in either (a) direct mode or (b) effect mode. _Direct_ mode is employed by Aura Crate in Windows. It requires the application to send a continuous stream of commands to the controller in order to modulate lighting effects on each addressable LED. The other mode is _effect_ mode in which the controller itself modulates lighting effects on each addressable LED. Effect mode requires the application to issue a single set of command codes to the controller in order to initiate the given effect. The controller continues to process that effect until the application sends a different command.
|
||||
|
||||
This driver employs the _effect_ mode (fire and forget). The selected lighting mode remains in effect until it is explicitly changed. This means the selected lighting mode remains in effect (a) on cold boot, (b) on warm boot, (c) after wake-from-sleep.
|
||||
|
||||
|
|
@ -13,16 +13,16 @@ The disadvantage, however, is the inability to set different lighting modes to d
|
|||
|
||||
There are three known variants of the Aura LED USB-based controller:
|
||||
|
||||
- Device `0x19AF`: found in Asus ProArt Z690-Creator WiFi
|
||||
- Device `0x19AF`: found in ASUS ProArt Z690-Creator WiFi
|
||||
- Device `0x1939` [^1]
|
||||
- Device `0x18F3`[^1]: found in Asus ROG Maximus Z690 Formula
|
||||
- Device `0x18F3`[^1]: found in ASUS ROG Maximus Z690 Formula
|
||||
|
||||
[^1]: Support for devices `0x1939` and `0x18F3` may not be sufficiently developed so users are asked to experiment and provide feedback. [Wireshark USB traffic capture](./developer/capturing-usb-traffic.md), in particular, will be very helpful.
|
||||
|
||||
|
||||
## Initialization
|
||||
|
||||
Asus Aura LED controller does not need to be initialized before use. Initialization is optional.
|
||||
ASUS Aura LED controller does not need to be initialized before use. Initialization is optional.
|
||||
|
||||
```
|
||||
# liquidctl -m Aura initialize
|
||||
|
|
@ -34,7 +34,7 @@ AsusTek Aura LED Controller
|
|||
|
||||
The `status` function returns the number of ARGB and RGB channels detected by the controller. If the command is invoked with `--debug` flag, the entire reply from the controller will be displayed in groups of 6 bytes. This information has not been fully decoded, but is provided in the event that someone is able to decipher it.
|
||||
|
||||
On Asus ProArt Z690-Creator WiFi the following is returned:
|
||||
On ASUS ProArt Z690-Creator WiFi the following is returned:
|
||||
```
|
||||
% liquidctl -m Aura status
|
||||
AsusTek Aura LED Controller (experimental)
|
||||
|
|
@ -61,7 +61,7 @@ AsusTek Aura LED Controller (experimental)
|
|||
└── Device Config: 10 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
|
||||
```
|
||||
|
||||
On Asus ROG Strix Z690-i Gaming WiFi (mini-ITX) the following is returned:
|
||||
On ASUS ROG Strix Z690-i Gaming WiFi (mini-ITX) the following is returned:
|
||||
```
|
||||
% liquidctl --debug -m Aura status
|
||||
AsusTek Aura LED Controller (experimental)
|
||||
|
|
@ -79,7 +79,7 @@ AsusTek Aura LED Controller (experimental)
|
|||
└── Device Config: 10 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
|
||||
```
|
||||
|
||||
On some Asus Z490 boards (controller ID 0x18F3) the following is returned:
|
||||
On some ASUS Z490 boards (controller ID 0x18F3) the following is returned:
|
||||
```
|
||||
% liquidctl --debug -m Aura status
|
||||
AsusTek Aura LED Controller (experimental)
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
"""liquidctl driver for Asus Aura LED USB controllers.
|
||||
"""liquidctl driver for ASUS Aura LED USB controllers.
|
||||
|
||||
Supported controllers:
|
||||
|
||||
- AsusTek Aura LED Controller: idVendor=0x0b05, idProduct=0x19af
|
||||
|
||||
This controller is found on Asus ProArt Z690-Creator WiFi and other boards
|
||||
This controller is found on ASUS ProArt Z690-Creator WiFi and other boards
|
||||
|
||||
Additional controllers (requires user testing and feedback):
|
||||
|
||||
|
|
@ -134,7 +134,7 @@ _COLOR_MODES = {
|
|||
|
||||
class AuraLed(UsbHidDriver):
|
||||
"""
|
||||
liquidctl driver for Asus Aura LED USB controllers.
|
||||
liquidctl driver for ASUS Aura LED USB controllers.
|
||||
This driver only supports 'effect' mode, hence no speed/color channels
|
||||
|
||||
Devices 0x1939 and 0x18F3 are not fully supported at this time; users are asked
|
||||
|
|
@ -276,7 +276,7 @@ class AuraLed(UsbHidDriver):
|
|||
full_cmd_seq.append(_FUNCTION_CODE["end_seq2"])
|
||||
|
||||
"""
|
||||
Asus Aura Crate sends command sequence twice, but our tests show
|
||||
ASUS Aura Crate sends command sequence twice, but our tests show
|
||||
that this may be redundant. Nevertheless, let's keep this code here
|
||||
in case we need to send commands twice as well
|
||||
#full_cmd_seq.append(cmd_tuple[0])
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ from collections import deque
|
|||
|
||||
from liquidctl.driver.aura_led import AuraLed
|
||||
|
||||
# Sample data for Aura LED controller from Asus ProArt Z690-Creator WiFi
|
||||
# Sample data for Aura LED controller from ASUS ProArt Z690-Creator WiFi
|
||||
_INIT_19AF_FIRMWARE_DATA = bytes.fromhex(
|
||||
"ec0241554c41332d415233322d30323037000000000000000000000000000000"
|
||||
"000000000000000000000000000000000000000000000000000000000000000000"
|
||||
|
|
|
|||
Loading…
Reference in New Issue