# Table of Contents

- [Table of Contents](#table-of-contents)
  - [Known Issues and Remarks](#known-issues-and-remarks)
  - [Feature Matrix](#feature-matrix)
    - [Keyboard Devices](#keyboard-devices)
    - [Mouse Devices](#mouse-devices)
    - [Miscellaneous Devices](#miscellaneous-devices)
  - [Enabling `experimental` drivers](#enabling-experimental-drivers)
  - [ROCCAT Vulcan 100/12x series keyboard](#roccat-vulcan-10012x-series-keyboard)
    - [Support status](#support-status)
    - [Remarks and known Issues](#remarks-and-known-issues)
  - [ROCCAT Vulcan Pro TKL series keyboard](#roccat-vulcan-pro-tkl-series-keyboard)
    - [Support status](#support-status-1)
    - [Remarks and known Issues](#remarks-and-known-issues-1)
  - [ROCCAT Vulcan TKL series keyboard](#roccat-vulcan-tkl-series-keyboard)
    - [Support status](#support-status-2)
    - [Remarks and known Issues](#remarks-and-known-issues-2)
  - [ROCCAT Vulcan Pro series keyboard](#roccat-vulcan-pro-series-keyboard)
    - [Support status](#support-status-3)
    - [Remarks and known Issues](#remarks-and-known-issues-3)
  - [ROCCAT Magma](#roccat-magma)
    - [Support status](#support-status-4)
    - [Remarks and known Issues](#remarks-and-known-issues-4)
  - [Corsair Strafe Gaming Keyboard](#corsair-strafe-gaming-keyboard)
    - [Support status](#support-status-5)
    - [Remarks and known Issues](#remarks-and-known-issues-5)
  - [Adalight/Custom serial LEDs](#adalightcustom-serial-leds)
  - [Other Devices](#other-devices)

## Known Issues and Remarks

- You may want to set a different profile for each slot (`F1`-`F4`).
- Some keyboards may get into an inconsistent state when Eruption terminates while `Game Mode` is enabled. The state may be fixed manually or by a reboot/device hotplug

## Feature Matrix

### Keyboard Devices

Hardware feature support matrix

| Vendor  | Product                | Status                     | Macro Keys | Easy Shift Key | Switch Profiles via F1-F4 Keys | Special functions via F5-F8 Keys    | Media keys F9-F12 |
| ------- |------------------------| -------------------------- | ---------- | -------------- | ------------------------------ | ----------------------------------- | ----------------- |
| ROCCAT  | Vulcan 100/12x         | 100%                       | Yes        | Yes            | Yes                            | Yes                                 | Yes               |
| ROCCAT  | Vulcan Pro TKL         | 98%                        | No         | Yes            | Yes (*inofficial)              | No, but may be forced (*inofficial) | Yes               |
| ROCCAT  | Vulcan TKL             | work-in-progress, untested | No         | Yes            | Yes (*inofficial)              | No, but may be forced (*inofficial) | Yes               |
| ROCCAT  | Vulcan Pro             | work-in-progress, untested | Yes        | Yes            | Yes                            | Yes                                 | Yes               |
| ROCCAT  | Magma                  | work-in-progress, untested | Yes        | Yes            | Yes (*inofficial)              | Yes                                 | Yes               |
| Corsair | Strafe Gaming Keyboard | 35%, work-in-progress      | No         | No             | No                             | No                                  | No                |

\* This feature is not supported/endorsed by the OEM and may be subject to change.

### Mouse Devices

Hardware feature support matrix

| Vendor | Product              | Status | Profiles | DPI  | Poll Rate | Debounce | Angle snapping | DCU | Macro Keys | Easy Shift Key |
| ------ |----------------------| ------ | -------- | ---- | --------- | -------- | -------------- | --- | ---------- | -------------- |
| ROCCAT | Kone Pure Ultra      | 100%   | Yes      | Yes  | TODO      | Yes      | Yes            | No  | N.a.       | N.a.           |
| ROCCAT | Burst Pro            | 100%   | Yes      | Yes¹ | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kain 100 AIMO        | 80%    | No       | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kain 2xx AIMO        | 80%    | No       | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kone XP              | ??%    | Yes      | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kone Pro             | ??%    | Yes      | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kone Pro Air         | 60%    | No       | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kone Aimo            | 80%    | No       | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kone Aimo Remastered | 80%    | No       | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kova AIMO            | 80%    | No       | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kova 2016            | ??%    | No       | No   | No        | No       | No             | No  | N.a.       | N.a.           |
| ROCCAT | Kone XTD             | N.a    | No       | No   | No        | No       | No             | No  | N.a.       | N.a.           |

\* This feature is not supported/endorsed by the OEM and may be subject to change.

> ¹ Only supported via the profile switching mechanism

> Profiles: Switch between hardware profiles, DPI: Pointer resolution, Debounce: Debouncing of button switches,
> Angle snapping: stabilize pointer movement, DCU: Distance Control Unit settings

### Miscellaneous Devices

Hardware feature support matrix

| Vendor                | Product            | Status | Device Type                 |
| --------------------- | ------------------ | ------ | --------------------------- |
| ROCCAT / Turtle Beach | Elo 7.1 Air        | 50%    | Headset (Wireless)          |
| ROCCAT                | Sense AIMO XXL (Aimo Pad Wide) | 95%    | Misc device (Mousepad)      |
| Adalight / Custom     | Custom serial LEDs | 95%    | LED Strip (variable length) |

\* This feature is not supported/endorsed by the OEM and may be subject to change.

## Enabling `experimental` drivers

Experimental drivers are `disabled` in the default configuration!

To enable support for experimental drivers, please edit `/etc/eruption/eruption.conf` and set
```toml
driver_maturity_level = "experimental"
```

After that, please restart the eruption daemon

```shell
sudo systemctl restart eruption.service
```

## ROCCAT Vulcan 100/12x series keyboard

### Support status

Fully supported

### Remarks and known Issues

- Mute button will stay lit even if audio is muted
- The default `MODIFIER` key is the **`FN`** key. Use it to switch slots (with `F1-F4`) or execute macros (`M1-M6`).
- Use the `FN` key to access special function keys (`F5`-`F8`)
- Use the `FN` key to access media functions (`F9`-`F12`)
- Easy Shift+ may be activated by pressing `FN`+`Scroll Lock/GameMode` and then `CAPS LOCK`.

## ROCCAT Vulcan Pro TKL series keyboard

### Support status

Nearly fully supported, as of `0.1.19`

### Remarks and known Issues

- The default `MODIFIER` key is the **`FN`** key. Use it to switch slots (with `F1-F4`).
- Slots may currently only be switched via `FN` + `F1-F4`, switching via `FN + LEFT` or `FN + RIGHT` causes problems
- Neighbor topology tables are currently not fully correct, this may lead to mis-rendering of some effects
- You can use the `FN` key to access special function keys (`F5`-`F8`) (*inofficial) like on the ROCCAT Vulcan Pro / ROCCAT Vulcan 100/12x
- Use the `FN` key too to access media functions (`F9`-`F12`)
- Easy Shift+ may be activated by pressing `FN`+`Page Down/GameMode` and then `CAPS LOCK`.

## ROCCAT Vulcan TKL series keyboard

### Support status

Work-in-progress, completely untested, as of `0.1.20`.

### Remarks and known Issues

- The default `MODIFIER` key is the **`FN`** key. Use it to switch slots (with `F1-F4`).
- Slots may currently only be switched via `FN` + `F1-F4`, switching via `FN + LEFT` or `FN + RIGHT` causes problems
- Neighbor topology tables are currently not fully correct, this may lead to mis-rendering of some effects
- You can use the `FN` key to access special function keys (`F5`-`F8`) (*inofficial) like on the ROCCAT Vulcan Pro / ROCCAT Vulcan 100/12x
- Use the `FN` key too to access media functions (`F9`-`F12`)
- Easy Shift+ may be activated by pressing `FN`+`Page Down/GameMode` and then `CAPS LOCK`.

## ROCCAT Vulcan Pro series keyboard

### Support status

Work-in-progress, completely untested. Probably not working, as of `0.1.20`

### Remarks and known Issues

- Mute button will stay lit even if audio is muted
- The default `MODIFIER` key is the **`FN`** key. Use it to switch slots (with `F1-F4`) or execute macros (`M1-M6`).
- Use the `FN` key to access special function keys (`F5`-`F8`)
- Use the `FN` key to access media functions (`F9`-`F12`)
- Easy Shift+ may be activated by pressing `FN`+`Scroll Lock/GameMode` and then `CAPS LOCK`.

## ROCCAT Magma

### Support status

Work-in-progress as of `0.1.23`

### Remarks and known Issues

- The default `MODIFIER` key is the **`FN`** key. Use it to switch slots (with `F1-F4`).
- Use the `FN` key to access special function keys (`F5`-`F8`)
- Use the `FN` key to access media functions (`F9`-`F12`)
- Easy Shift+ may be activated by pressing `FN`+`Scroll Lock/GameMode` and then `CAPS LOCK`.

## Corsair Strafe Gaming Keyboard

### Support status

Work-in-progress, as of `0.1.20`.

### Remarks and known Issues

- Support is only preliminary, at best


## Adalight/Custom serial LEDs

Custom firmware for Arduino devices can be found in `support/firmware/arduino/`

## Other Devices

Support for more devices is being worked on! Please open up a feature request on GitHub, if you are willing to assist in getting your hardware supported.