Linux Arctis Manager

A replacement for SteelSeries GG software, to manage your Arctis device on Linux!

👍 Key points

Enable the Media and Chat audio streams
Configure any device via a simple configuration file
Enable per-device features by adding them in the relative configuration file
D-Bus based communication, to support different clients (alternative clients, Plasma extensions, etc)

🎧 Supported devices table

Device	Channels mix	Advanced features	Product ID(s)
Arctis 1 / Xbox	❌	❌	12b3, 12b6
Arctis 1 Wireless	❌	❌
Arctis 3 Console Edition	❌	❌
Arctis 7 / Gen 2	❌	❌	1260, 12ad
Arctis 7+ / PS5 / Xbox / Destiny	❌	❌	220e, 2212, 2216, 2236
Arctis Nova 3	❌	❌	12ec
Arctis Nova 3P Wireless / 3X Wireless	❌	❌	2269, 226d
Arctis Nova 5	❌	❌	2232, 2253
Arctis Nova 7P	❌	❌	220a
Arctis Nova 7X	❌	❌	12d7
Arctis Nova 9	❌	❌	12c2
Arctis Nova Elite	❌	❌
Arctis Nova Pro Wireless / X	✅	✅	12e0, 12e5
Arctis Nova Pro	❌	❌
Arctis Pro GameDAC	❌	❌	1280
Arctis Pro Wireless	❌	❌	1290
Arctis Pro	❌	❌	1252

*: experimental support, needs test by the community. Open an issue in case of problem(s)

CLI commands

lam-daemon: executed by user-level systemd.
lam-cli: to run utilities like udev rules generation, desktop entries installation etc.
lam-gui: the graphical user interface, to alter settings and see the device's status.

🖥️ Install & setup

From sources

Installation of uv (one-timer, then restart the terminal and ensure that uv is in $PATH)

pip install --upgrade uv

Wheel file creation

rm -rf dist
uv build

Wheel installation

pip install dist/linux_arctis_manager-*.whl

From wheel (released version)

Wheel installation

pip install linux_arctis_manager-....whl

At each update

lam-cli udev write-rules --force --reload (add / update the udev rules file and reload them)
lam-cli desktop write (add the desktop menu entries)

Uninstall / cleanup

lam-cli desktop remove (remove the desktop menu entries)
systemctl --user disable --now arctis-manager (disables and stops arctis-manager service)
rm ~/.config/systemd/user/arctis-manager.service (removes the systemd's user-level arctis-manager service file)
sudo rm /usr/lib/udev/rules.d/91-steelseries-arctis.rules (remove udev rules)

⌨️ Development

Basic commands

Run the daemon: uv run lam-daemon
Run the CLI: uv run lam-cli*
Run the GUI: uv run lam-gui*

*: to be developed

How to add support to a new device

Add a new device configuration file in ~/.config/arctis_manager/devices/, according to the results of the reverse engineering (the temporary configuration file allows for instant device support, waiting for a software's new version to come out)
Update the udev rules by executing (as root / sudo):
- [sudo] lam-cli udev write-rules --force --reload to recreate the udev rules set file. This will save the rules in the system's rules.d/91-steelseries-arctis.rules, overwriting the existing file. Use --force to overwrite the file and --reload to force udev reload its rules.

During the development, new labels will probably be required. In order to add them, you can copy the en.ini in ~/.config/arctis_manager/lang/ and edit the file there.

In case of software limitations for any reason, some coding might be required (for example to support a new status or setting type).

Once the configuration is completed locally, a new ticket can be raised to add both the new device configuration file and the eventual languages file(s) edits. A pull request into the development branch is very welcome, specially if adding new code, too.

Brief Wireshark tutorial

This tutorial should kick start your reverse engineering journey!

Device configuration specs

Device configuration files are in the YAML file format, as follows:

device:
  name: Friendly name # for example: SteelSeries Arctis Nova Pro Wireless
  vendor_id: 0x1038 # Should always be 0x1038, but double check via lsusb
  product_ids: [0x1234] # At least one identifier. Multiple identifiers might apply for different SKUs
  command_padding: # This defines the command's message length and the filler. Typically 64 bytes zero-padded.
    length: 64
    position: end
    filler: 0x00

  command_interface_index: [4, 0] # USB interface number and alternate setting to write commands (status request, device initialization). The former can be analyzed via usb-devices, or by chance. The latter should typically be 0.
  listen_interface_indexes: [4] # USB interface number to listen for the status.

  device_init: # OPTIONAL, the list of commands to initialize the device, for example the GameDAC
    - [0x06, 0x20]
    # ...
    - [0x06, 0xc3, 'settings.wireless_mode']      # Can accept also values from the settings (settings.NAME_OF_THE_SETTING)
    - ['status.request']                          # Can accept the special 'status.request' to send device.status.request's value
  status:
    request: 0x06b0 # Message to be sent to request the device's status
    response_mapping: # A list of objects having
                      # (1) starts_with (the message sent from the device must start with the given sequence)
                      # (2, n) the status' name and its position in the message
      - starts_with: 0x0725 # The whole device's message will be 0x0725NN (where NN is the station_volume)
        station_volume: 0x02

      - starts_with: 0x0745 # Message: 0x0745XXYY
        media_mix: 0x02     # ⚠️ media_mix is a special name for the channels mixer, it is required to use this one and not similar ones!
        chat_mix: 0x03      # ⚠️ chat_mix is a special name for the channels mixer, it is required to use this one and not similar ones!

      - starts_with: 0x06b0 # Message: 0x06b0XXYYZZKK...
        bluetooth_powerup_state: 0x02
        bluetooth_auto_mute: 0x03
        bluetooth_power_status: 0x04
        bluetooth_connection: 0x05
        # ...
    representation:      # Categorization and ordering
      category1:         # Translation in [status] section of language file
        - station_volume # List of settings that apply to the category
        - station_charge # If you want to omiss one or more settings in the representation, it's ok
  
  online_status: # OPTIONAL. Used to detect whether the device is connected AND online (useful for wireless devices). If not defined, it will be considered always online if connected via USB
    status_variable: status_variable_to_check_against     # The settings variable's name
    online_value: status_variable's_mapped_value_to_check # The (mapped) variable's value

  settings: # OPTIONAL section
    microphone:                                # Settings section
      mic_volume:                              # Setting's name
        type: slider                           # Setting's type
        default: 0x0a                          # Setting's default value
        update_sequence: [0x06, 0x37, 'value'] # 'value' is a special token replaced with the setting's value at runtime
        min: 0x01                              # Type-specific parameter
        max: 0x0a                              # Type-specific parameter
        step: 1                                # Type-specific parameter
        min_label: mic_muted                   # Type-specific parameter
        max_label: perc_100                    # Type-specific parameter
    another_section:
      another_setting:
        type: ...

  status_parse:               # Each status found in device.status.response_mapping[n] requires a counterpart in this section
    station_volume:
      type: percentage
      perc_min: -56
      perc_max: 0
    media_mix:
      type: percentage
      perc_min: 0
      perc_max: 100
    # ...

⚠️ As highlighted in the example above, media_mix and chat_mix status entries are key to the mixer management. Please avoid using different names, like game_mix in order to enable proper channels mixing.

⚠️ The status_parse section of media_mix and chat_mix requires the values to be normalized between 0 and 100.

YAML's device.settings.[section].[setting] types

Linux Arctis Manager supports out of the box the following settings. Additional types need to be implemented in the code.

# Linear multi-value setting (for example 1..n)
type: slider
min: int                               # the minimum valid value
max: int                               # the maximum valid valud
step: 1                                # the number each step sums to the next one (ex. min 1, max 5, step 2; values: 1, 3, 5)
min_label: slider_setting_min          # As found in the language ini file
max_label: slider_setting_max          # As found in the language ini file
default: 0x0a                          # The value set if none was before
update_sequence: [0x06, 0x37, 'value'] # The setting's command update sequence
values_mapping:                        # OPTIONAL: if the slider needs different representation of the values
  0: off                               # Labels as found in [settings_values]
  1: low
  2: medium
  3: high

# Boolean values (with custom on/off values and labels)
type: toggle
values:
  off: 0x00                            # Value in the "off" position
  on: 0x01                             # Value in the "on" position
  off_label: high                      # As found in the language ini file
  on_label: low                        # As found in the language ini file
default: 0x01                          # The value set if none was before
update_sequence: [0x06, 0x37, 'value'] # The setting's command update sequence

# Drop-downs
type: select
default: null
options_source: pulse_audio_devices                # pulse_audio_devices only for now
options_mapping: { value: id, label: description } # Depends on options_source. "pulse_audio_devices": id and description only for now
update_sequence: [0x06, 0x37, 'value']             # The setting's command update sequence

YAML's device.status_parse.[status_name] types

Linux Arctis Manager supports out of the box the following status types. Additional types need to be implemented in the code.

To add a new parser, define the function in the status_parser_fn.py file and add the tests in the relative file. New functions will be added to the application automatically.

# Percentage (0-100%)
type: percentage
perc_min: -56    # The absolute value of 0%
perc_max: 0      # The absolute value of 100%

# Togglable (on/off)
type: on_off
off: 0x00       # The value to represent the off status
on: 0x01        # The value to represent the on status

# Value (int) to string (label)
type: int_str_mapping
values:
  0x00: off    # Value: label (label as found in the language ini file)
  0x01: -12db
  0x02: on
  ...

# Value (int) to mapped int
type: int_int_mapping
values:
  0x00: 0 
  0x01: 1
  0x02: 5
  ...

D-Bus messaging

The daemon interacts with the clients (CLI, UI, etc) via D-Bus.

Bus name: "name.giacomofurlan.ArctisManager.Next"

name.giacomofurlan.ArctisManager.Next.Settings

Interface Path: /name/giacomofurlan/ArctisManager/Next/Settings

Method: GetListOptions

Parameters: list_name (string)
Response format: JSON
Specs:

The response varies depending on the list, but it will always return a list of objects.

List name: pulse_audio_devices:

[{ "id": "string", "name": "string" }]

Method: GetSettings

Parameters: (none)
Response format: JSON
Specs:

The response has three sections:

general: for general (cross-device) settings.
device: for device-specific settings. Will be an empty object if no device is connected.
settings_config: the definition for each setting, defining type, default_value and other arguments depending on the type. See YAML's device.settings.[section].[setting] types.

The clients shouldn't hard-core the settings, but read them and parse them depending on the settings_config section.

{
    "general": {
        "toggle_setting": 0,
        "select_setting": null,
        "slider_setting": 10
    },
    "device": {
        "setting_a": 10,
        "setting_b": 0,
        "setting_c": 10
    },
    "settings_config": {
        "toggle_setting": {
            "type": "toggle",
            "default_value": false,
            "values": {
                "on": true,
                "off": false,
                "off_label": "off",
                "on_label": "on"
            }
        },
        "select_setting": {
            "type": "select",
            "default_value": null,
            "options_source": "pulse_audio_devices",
            "options_mapping": {
                "value": "id",
                "label": "description"
            }
        },
        "slider_setting": {
            "type": "slider",
            "default_value": 10,
            "min": 1,
            "max": 10,
            "step": 1,
            "min_label": "mic_muted",
            "max_label": "perc_100"
        },
        "setting_a": ...,
        "setting_b": ...,
        "setting_c": ...
    }
}

Method: SetSettings

Parameters: setting: string, value: string (JSON format)
Response format: JSON
Specs:

Writes the setting. Searches the setting first in the general settings and then, if not found, in the device's.

Returns boolean (true: setting saved, false: setting not found / not saved)

name.giacomofurlan.ArctisManager.Next.Status

Interface Path: /name/giacomofurlan/ArctisManager/Next/Status

Method: GetStatus

Parameters: (none)
Response format: JSON
Specs:

Returns an object with the series of configured status values, in the mapped values as defined in YAML's device.status_parse.[status_name] types and categorized in YAML's device.status.representation.

If no device is connected, an empty object will return.

Each setting has two attributes:

value: the (parsed, but not translated) value
type: "label" in case of string, or the relative type, as defined in device.status_parse.[status].type

{
    "headset": {
        "headset_power_status": {
            "value": "online",
            "type": "label"
        },
        "headset_battery_charge": {
            "value": 87,
            "type": "percentage"
        },
        "noise_cancelling": {
            "value": "off",
            "type": "label"
        },
        "transparent_noise_cancelling_level": {
            "value": 100,
            "type": "percentage"
        },
        "auto_off_time_minutes": {
            "value": 30,
            "type": "int_int_mapping"
        }
    },
    ...
}

name.giacomofurlan.ArctisManager.Next.Config

Interface Path: /name/giacomofurlan/ArctisManager/Next/Config

Method: ReloadConfigs

Parameters: (none)
Response format: JSON
Specs:

Reload the configuration files, useful to test new devices support during the development phase. Return boolean (success / failure).

Name		Name	Last commit message	Last commit date
Latest commit History 84 Commits
.vscode		.vscode
docs/images		docs/images
src/linux_arctis_manager		src/linux_arctis_manager
tests		tests
.gitignore		.gitignore
.python-version		.python-version
LICENSE		LICENSE
README.md		README.md
TODO.md		TODO.md
pyproject.toml		pyproject.toml
uv.lock		uv.lock

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Linux Arctis Manager

👍 Key points

🎧 Supported devices table

CLI commands

🖥️ Install & setup

From sources

From wheel (released version)

At each update

Uninstall / cleanup

⌨️ Development

Basic commands

How to add support to a new device

Brief Wireshark tutorial

Device configuration specs

YAML's device.settings.[section].[setting] types

YAML's device.status_parse.[status_name] types

D-Bus messaging

name.giacomofurlan.ArctisManager.Next.Settings

Method: GetListOptions

Method: GetSettings

Method: SetSettings

name.giacomofurlan.ArctisManager.Next.Status

Method: GetStatus

name.giacomofurlan.ArctisManager.Next.Config

Method: ReloadConfigs

About

Uh oh!

Releases

Packages

Languages

License

elegos/Linux-Arctis-Manager

Folders and files

Latest commit

History

Repository files navigation

Linux Arctis Manager

👍 Key points

🎧 Supported devices table

CLI commands

🖥️ Install & setup

From sources

From wheel (released version)

At each update

Uninstall / cleanup

⌨️ Development

Basic commands

How to add support to a new device

Brief Wireshark tutorial

Device configuration specs

YAML's device.settings.[section].[setting] types

YAML's device.status_parse.[status_name] types

D-Bus messaging

name.giacomofurlan.ArctisManager.Next.Settings

Method: GetListOptions

Method: GetSettings

Method: SetSettings

name.giacomofurlan.ArctisManager.Next.Status

Method: GetStatus

name.giacomofurlan.ArctisManager.Next.Config

Method: ReloadConfigs

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages