46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# Headset Control
|
|
|
|
Monitor and control [HeadsetControl](https://github.com/Sapd/HeadsetControl)-compatible gaming headsets
|
|
from the Noctalia shell: battery in the bar, a sidetone toggle in the control center, and a full
|
|
control panel for sidetone, equalizer presets, auto-off, noise filter, voice prompts and the volume limiter.
|
|
|
|
Requires `headsetcontrol` (install via your package manager, e.g. `pacman -S headsetcontrol`).
|
|
|
|
## Install
|
|
|
|
```
|
|
mkdir -p ~/.local/share/noctalia/plugins
|
|
ln -s /path/to/this/repo/headsetcontrol ~/.local/share/noctalia/plugins/headsetcontrol
|
|
noctalia msg plugins enable loki/headsetcontrol
|
|
```
|
|
|
|
## Usage
|
|
|
|
- **Bar widget:** shows battery level. Scroll to adjust sidetone, click to open the control panel.
|
|
- **Control center tile:** toggles sidetone on/off.
|
|
- **Control panel:** full device controls. Controls appear only for capabilities the headset reports.
|
|
- **Wake button (panel):** headsets that sleep while idle (e.g. Audeze Maxwell) stop reporting the battery. The panel's Wake button plays a short tone to wake the headset, then refreshes the battery reading. The panel header also shows whether the headset is connected.
|
|
|
|
## Settings
|
|
|
|
| Setting | Default | Meaning |
|
|
|---|---|---|
|
|
| Poll interval | 60 s | How often status is refreshed |
|
|
| Low battery threshold | 20 % | Warn below this level |
|
|
| Default sidetone | 64 | Level used before any manual adjustment |
|
|
| Device (VID:PID) | *(auto)* | Force a device, e.g. `3329:4b19` |
|
|
| Mock device | off | Simulate a headset for development without hardware |
|
|
| Wake-up audio sink | *(default output)* | PulseAudio/PipeWire sink for the wake tone (find names with `pactl list short sinks`) |
|
|
|
|
## Development
|
|
|
|
Edits to `.luau` files hot-reload. Trigger a manual refresh with:
|
|
|
|
```
|
|
noctalia msg plugin loki/headsetcontrol:headset all refresh
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|