Metadata-Version: 2.5
Name: ulanzi-studio-niri
Version: 2.2.0
Summary: Driver and Niri integration for the Ulanzi Stream Controller D200X
Project-URL: Homepage, https://github.com/doitian/ulanzi-studio-niri
Project-URL: Issues, https://github.com/doitian/ulanzi-studio-niri/issues
Author: ulanzi-studio-niri contributors
License: MIT License
        
        Copyright (c) 2026 ulanzi-studio-niri contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: d200x,niri,stream-deck,ulanzi,wayland
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Desktop Environment :: Window Managers
Requires-Python: >=3.11
Requires-Dist: cairosvg>=2.7
Requires-Dist: construct~=2.10
Requires-Dist: deepdiff>=7
Requires-Dist: nvidia-ml-py>=11
Requires-Dist: pillow>=10
Requires-Dist: psutil>=5.9
Requires-Dist: pydantic>=2
Requires-Dist: watchfiles>=0.21
Description-Content-Type: text/markdown

# ulanzi-studio-niri

[![PyPI version](https://img.shields.io/pypi/v/ulanzi-studio-niri)](https://pypi.org/project/ulanzi-studio-niri/)

Linux daemon for the **Ulanzi Stream Controller D200X**, with
[Niri](https://github.com/YaLTeR/niri) integration.

Bind buttons and encoders to desktop actions, commands, media controls, keystrokes,
and pages. Display clocks, system stats, AI usage, and coding-agent session counts.

## Quick start

Requires Python 3.11+. Install with [uv](https://docs.astral.sh/uv/):

```sh
uv tool install ulanzi-studio-niri
ulanzi-niri setup
sudo ~/.local/bin/ulanzi-niri admin-setup
```

`setup` creates the example config and starts a systemd user service, preserving
existing config. `admin-setup` installs USB permissions; adjust the executable
path if needed and replug the device afterward. Without systemd, run
`ulanzi-niri run` manually. See [installation details](docs/guide.md#installation)
for pip installation and setup options.

Edit `~/.config/ulanzi-niri/config.toml` using the
[example config](src/ulanzi_niri/data/config.toml). Install the external tools used
by your actions (such as `niri`, `playerctl`, or `wtype`); icons are not bundled.

```sh
ulanzi-niri doctor                 # check your environment
ulanzi-niri control next-page      # control the running daemon
ulanzi-niri ai-usage --json         # read cached usage
ulanzi-niri agent-status --json     # read cached agent counts
```

## Documentation

- [Configuration, pages, and icons](docs/guide.md#configuration)
- [AI usage widgets](docs/guide.md#ai-usage-widgets) · [Agent status](docs/guide.md#agent-status)
- [Keyboard control](docs/guide.md#keyboard-control)
- [D200X inputs](docs/guide.md#hardware) · [AU05 keepalive](docs/guide.md#au05-keepalive)
- [Releases](docs/guide.md#releases) · [Changelog](CHANGELOG.md)

## Development

```sh
uv sync
uv run pytest
uv run ruff check .
```

See the [development guide](docs/guide.md#development) for local installation and
hardware diagnostics.

Protocol details adapted from [redphx/strmdck](https://github.com/redphx/strmdck).
