pymidi-controller 0.1.0__tar.gz

pymidi_controller-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alex Sandilands
+
+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.

pymidi_controller-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+# MANIFEST.in
+include README.md LICENSE
+recursive-include pymidi_controller/data *

pymidi_controller-0.1.0/PKG-INFO

@@ -0,0 +1,240 @@
+Metadata-Version: 2.4
+Name: pymidi-controller
+Version: 0.1.0
+Summary: Daemon that maps MIDI events to system actions (Elgato, Hue, etc.)
+Author-email: Alex Sandilands <sandilands.alex@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/AlexSandilands/pymidi-controller
+Project-URL: Bug Tracker, https://github.com/AlexSandilands/pymidi-controller/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Multimedia :: Sound/Audio :: MIDI
+Classifier: Topic :: Home Automation
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Classifier: Topic :: Utilities
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mido>=1.2.10
+Requires-Dist: python-rtmidi>=1.4.10
+Requires-Dist: requests>=2.0
+Requires-Dist: zeroconf>=0.40
+Requires-Dist: PyYAML>=6.0
+Dynamic: license-file
+
+# 🎹 PyMIDI Controller
+
+[![Python](https://img.shields.io/badge/python-3.7%2B-blue)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/github/license/AlexSandilands/pymidi-controller)](https://github.com/AlexSandilands/pymidi-controller/blob/main/LICENSE)
+[![Last Commit](https://img.shields.io/github/last-commit/AlexSandilands/pymidi-controller)](https://github.com/AlexSandilands/pymidi-controller/commits/main)
+
+A lightweight Python CLI and background MIDI listener for controlling Philips Hue and Elgato Ring Lights via a MIDI device.
+
+---
+
+## 📚 Table of Contents
+
+- [🚀 Installation](#-installation)
+- [⚡ Quickstart](#-quickstart)
+- [⚙️ Configuration](#️-configuration)
+- [🎛️ Commands](#️-commands)
+  - [Global](#global)
+  - [Service](#service)
+  - [Hue Commands](#hue-commands)
+  - [Elgato Commands](#elgato-commands)
+  - [MIDI Commands](#midi-commands)
+- [🎹 MIDI Binding Guide](#-midi-binding-guide)
+- [⚙️ Service (Optional)](#️-service-optional)
+
+## 🚀 Installation
+
+**Requirements:**
+
+- Python 3.7 or higher
+- A modern Linux distro (systemd)
+
+### Via pip
+
+```bash
+pip install pymidi-controller
+```
+
+### Via pipx (isolated install)
+
+```bash
+pipx install pymidi-controller
+```
+
+> If you use `pipx`, make sure `~/.local/bin` is on your `PATH` (`pipx ensurepath`).
+
+---
+
+## ⚡ Quickstart
+
+1. **Initialize your config** (creates `~/.config/pymidi-controller/config.yaml`):
+   ```bash
+   pymidi init
+   ```
+2. **Discover your Hue Bridge** (press the link button when prompted):
+   ```bash
+   pymidi hue discover
+   ```
+3. **Discover your Elgato Ring Light**:
+   ```bash
+   pymidi elgato discover
+   ```
+4. **Map MIDI inputs** (listen to your controller to grab event keys):
+   ```bash
+   pymidi midi listen
+   ```
+   Press buttons/knobs to print strings like `control_change:0:12:127` for use in your config.
+5. **Edit your config** (see [Configuration](#️-configuration)) to add your device IPs, API keys, MIDI bindings, and color cycles.
+6. **Start the listener to test configuration**:
+   ```bash
+   pymidi run --mode blocking
+   ```
+7. **(Optional) Background Service**:
+  You can also install as a background service: see [Service](#️-service-optional).
+
+---
+
+## ⚙️ Configuration
+
+All settings live in a single YAML file:
+
+```
+~/.config/pymidi-controller/config.yaml
+```
+
+This file will contain potentially sensitive data like your Hue API key or your IP address,
+so it will be flagged as senstive and set so only your user can read it.
+
+### Example `config.yaml`
+
+```yaml
+hue:
+  bridge_ip: 192.168.1.42      # your Hue Bridge address
+  api_key: YOUR_HUE_API_KEY    # obtained via `pymidi hue discover`
+
+elgato:
+  host: 192.168.1.43           # your Elgato Ring Light address
+
+midi:
+  devices:
+    - "Streamer X"
+    - "nanoPAD"
+
+  # Map MIDI event keys → pymidi commands
+  bindings:
+    control_change:0:12:127:
+      - hue
+      - toggle-group
+      - "Living Room"
+    control_change:0:14:127:
+      - elgato
+      - toggle
+
+  # Optional: define color cycles per group
+  color_cycles:
+    Living Room:
+      - red
+      - blue
+      - green
+```
+---
+
+## 🎛️ Commands
+
+Use `pymidi <group> --help` for details on each context.
+
+### Global
+
+| Command       | Description                                 |
+| ------------- | ------------------------------------------- |
+| `pymidi init` | Create default config file                  |
+| `pymidi run`  | Start the MIDI listener (`--mode blocking`) |
+
+### Service
+
+| Command                             | Description                         |
+| ----------------------------------- | ----------------------------------- |
+| `pymidi service install --user`     | Install & start as a user service   |
+| `pymidi service install --system`   | Install & start system-wide service |
+| `pymidi service uninstall --user`   | Stop & remove user service          |
+| `pymidi service uninstall --system` | Stop & remove system service        |
+| `pymidi service stop`               | Stop the running service            |
+| `pymidi service enable`             | Enable service (user scope)         |
+| `pymidi service log`                | Tail service logs                   |
+
+### Hue Commands
+
+| Command                                                    | Description                              |
+| ---------------------------------------------------------- | ---------------------------------------- |
+| `pymidi hue discover`                                      | Find bridge & generate API key           |
+| `pymidi hue list-groups`                                   | List all groups and on/off states        |
+| `pymidi hue list-lights`                                   | List all lights and their state/effect   |
+| `pymidi hue list-schedules`                                | List all schedules                       |
+| `pymidi hue toggle-group <group>`                          | Toggle a group on/off                    |
+| `pymidi hue set-color <group> <color> [--sat N] [--bri N]` | Set group color                          |
+| `pymidi hue toggle-schedule <name>`                        | Enable/disable a schedule                |
+| `pymidi hue loop [--effect colorloop \| none]`             | Toggle colorloop effect                  |
+| `pymidi hue cycle-color <group>`                           | Cycle group color through `color_cycles` |
+
+### Elgato Commands
+
+| Command                  | Description                    |
+| ------------------------ | ------------------------------ |
+| `pymidi elgato discover` | Discover Ring Light via mDNS   |
+| `pymidi elgato toggle`   | Toggle Ring Light on/off       |
+| `pymidi elgato info`     | Show current Ring Light status |
+
+### MIDI Commands
+
+| Command              | Description                                |
+| -------------------- | ------------------------------------------ |
+| `pymidi midi listen` | Print incoming MIDI event keys for mapping |
+
+---
+
+## 🎹 MIDI Binding Guide
+
+1. Run:
+   ```bash
+   pymidi midi listen
+   ```
+2. Press a control (button/knob) to see its event key, e.g. `control_change:0:12:127`.
+3. Open `~/.config/pymidi-controller/config.yaml` and under `midi.bindings`, add:
+   ```yaml
+   bindings:
+     control_change:0:12:127:
+       - hue
+       - toggle-group
+       - "Living Room"
+   ```
+   Each value under the event key should be one part in order of the [Commands](#️-commands)
+4. Save and test:
+   ```bash
+   pymidi run --mode interactive
+   ```
+
+---
+
+## ⚙️ Service (Optional)
+
+To run automatically at login:
+
+```bash
+pymidi service install --user
+```
+
+Logs:
+
+```bash
+pymidi service log
+```
+
+---
+
+## 📜 License
+
+MIT © Alex Sandilands

pymidi_controller-0.1.0/README.md

@@ -0,0 +1,216 @@
+# 🎹 PyMIDI Controller
+
+[![Python](https://img.shields.io/badge/python-3.7%2B-blue)](https://www.python.org/downloads/)
+[![License](https://img.shields.io/github/license/AlexSandilands/pymidi-controller)](https://github.com/AlexSandilands/pymidi-controller/blob/main/LICENSE)
+[![Last Commit](https://img.shields.io/github/last-commit/AlexSandilands/pymidi-controller)](https://github.com/AlexSandilands/pymidi-controller/commits/main)
+
+A lightweight Python CLI and background MIDI listener for controlling Philips Hue and Elgato Ring Lights via a MIDI device.
+
+---
+
+## 📚 Table of Contents
+
+- [🚀 Installation](#-installation)
+- [⚡ Quickstart](#-quickstart)
+- [⚙️ Configuration](#️-configuration)
+- [🎛️ Commands](#️-commands)
+  - [Global](#global)
+  - [Service](#service)
+  - [Hue Commands](#hue-commands)
+  - [Elgato Commands](#elgato-commands)
+  - [MIDI Commands](#midi-commands)
+- [🎹 MIDI Binding Guide](#-midi-binding-guide)
+- [⚙️ Service (Optional)](#️-service-optional)
+
+## 🚀 Installation
+
+**Requirements:**
+
+- Python 3.7 or higher
+- A modern Linux distro (systemd)
+
+### Via pip
+
+```bash
+pip install pymidi-controller
+```
+
+### Via pipx (isolated install)
+
+```bash
+pipx install pymidi-controller
+```
+
+> If you use `pipx`, make sure `~/.local/bin` is on your `PATH` (`pipx ensurepath`).
+
+---
+
+## ⚡ Quickstart
+
+1. **Initialize your config** (creates `~/.config/pymidi-controller/config.yaml`):
+   ```bash
+   pymidi init
+   ```
+2. **Discover your Hue Bridge** (press the link button when prompted):
+   ```bash
+   pymidi hue discover
+   ```
+3. **Discover your Elgato Ring Light**:
+   ```bash
+   pymidi elgato discover
+   ```
+4. **Map MIDI inputs** (listen to your controller to grab event keys):
+   ```bash
+   pymidi midi listen
+   ```
+   Press buttons/knobs to print strings like `control_change:0:12:127` for use in your config.
+5. **Edit your config** (see [Configuration](#️-configuration)) to add your device IPs, API keys, MIDI bindings, and color cycles.
+6. **Start the listener to test configuration**:
+   ```bash
+   pymidi run --mode blocking
+   ```
+7. **(Optional) Background Service**:
+  You can also install as a background service: see [Service](#️-service-optional).
+
+---
+
+## ⚙️ Configuration
+
+All settings live in a single YAML file:
+
+```
+~/.config/pymidi-controller/config.yaml
+```
+
+This file will contain potentially sensitive data like your Hue API key or your IP address,
+so it will be flagged as senstive and set so only your user can read it.
+
+### Example `config.yaml`
+
+```yaml
+hue:
+  bridge_ip: 192.168.1.42      # your Hue Bridge address
+  api_key: YOUR_HUE_API_KEY    # obtained via `pymidi hue discover`
+
+elgato:
+  host: 192.168.1.43           # your Elgato Ring Light address
+
+midi:
+  devices:
+    - "Streamer X"
+    - "nanoPAD"
+
+  # Map MIDI event keys → pymidi commands
+  bindings:
+    control_change:0:12:127:
+      - hue
+      - toggle-group
+      - "Living Room"
+    control_change:0:14:127:
+      - elgato
+      - toggle
+
+  # Optional: define color cycles per group
+  color_cycles:
+    Living Room:
+      - red
+      - blue
+      - green
+```
+---
+
+## 🎛️ Commands
+
+Use `pymidi <group> --help` for details on each context.
+
+### Global
+
+| Command       | Description                                 |
+| ------------- | ------------------------------------------- |
+| `pymidi init` | Create default config file                  |
+| `pymidi run`  | Start the MIDI listener (`--mode blocking`) |
+
+### Service
+
+| Command                             | Description                         |
+| ----------------------------------- | ----------------------------------- |
+| `pymidi service install --user`     | Install & start as a user service   |
+| `pymidi service install --system`   | Install & start system-wide service |
+| `pymidi service uninstall --user`   | Stop & remove user service          |
+| `pymidi service uninstall --system` | Stop & remove system service        |
+| `pymidi service stop`               | Stop the running service            |
+| `pymidi service enable`             | Enable service (user scope)         |
+| `pymidi service log`                | Tail service logs                   |
+
+### Hue Commands
+
+| Command                                                    | Description                              |
+| ---------------------------------------------------------- | ---------------------------------------- |
+| `pymidi hue discover`                                      | Find bridge & generate API key           |
+| `pymidi hue list-groups`                                   | List all groups and on/off states        |
+| `pymidi hue list-lights`                                   | List all lights and their state/effect   |
+| `pymidi hue list-schedules`                                | List all schedules                       |
+| `pymidi hue toggle-group <group>`                          | Toggle a group on/off                    |
+| `pymidi hue set-color <group> <color> [--sat N] [--bri N]` | Set group color                          |
+| `pymidi hue toggle-schedule <name>`                        | Enable/disable a schedule                |
+| `pymidi hue loop [--effect colorloop \| none]`             | Toggle colorloop effect                  |
+| `pymidi hue cycle-color <group>`                           | Cycle group color through `color_cycles` |
+
+### Elgato Commands
+
+| Command                  | Description                    |
+| ------------------------ | ------------------------------ |
+| `pymidi elgato discover` | Discover Ring Light via mDNS   |
+| `pymidi elgato toggle`   | Toggle Ring Light on/off       |
+| `pymidi elgato info`     | Show current Ring Light status |
+
+### MIDI Commands
+
+| Command              | Description                                |
+| -------------------- | ------------------------------------------ |
+| `pymidi midi listen` | Print incoming MIDI event keys for mapping |
+
+---
+
+## 🎹 MIDI Binding Guide
+
+1. Run:
+   ```bash
+   pymidi midi listen
+   ```
+2. Press a control (button/knob) to see its event key, e.g. `control_change:0:12:127`.
+3. Open `~/.config/pymidi-controller/config.yaml` and under `midi.bindings`, add:
+   ```yaml
+   bindings:
+     control_change:0:12:127:
+       - hue
+       - toggle-group
+       - "Living Room"
+   ```
+   Each value under the event key should be one part in order of the [Commands](#️-commands)
+4. Save and test:
+   ```bash
+   pymidi run --mode interactive
+   ```
+
+---
+
+## ⚙️ Service (Optional)
+
+To run automatically at login:
+
+```bash
+pymidi service install --user
+```
+
+Logs:
+
+```bash
+pymidi service log
+```
+
+---
+
+## 📜 License
+
+MIT © Alex Sandilands

pymidi_controller-0.1.0/pymidi_controller/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"

pymidi_controller-0.1.0/pymidi_controller/actions/elgato.py

@@ -0,0 +1,55 @@
+import requests
+from pymidi_controller.config import ELGATO_LIGHT_IP
+
+# -------------------------------------------------------------------
+# 💡 Elgato Ring Light Controls
+# -------------------------------------------------------------------
+
+def get_ring_info():
+    """
+    Fetch and display full status info for the Elgato Ring Light.
+    Includes power state, brightness, and temperature.
+    """
+    url = f"http://{ELGATO_LIGHT_IP}:9123/elgato/lights"
+    try:
+        response = requests.get(url, timeout=2)
+        response.raise_for_status()
+        data = response.json()
+        light = data["lights"][0]
+
+        print("Elgato Ring Light Info:")
+        print(f"  Power:       {'ON' if light['on'] else 'OFF'}")
+        print(f"  Brightness:  {light['brightness']}%")
+        print(f"  Temperature: {light['temperature']}K")
+        return light
+
+    except Exception as e:
+        print(f"❌ Failed to reach Elgato light at {ELGATO_LIGHT_IP}: {e}")
+
+
+def get_light_state():
+    """
+    Return the current power state of the Elgato Ring Light (on/off).
+    """
+    url = f"http://{ELGATO_LIGHT_IP}:9123/elgato/lights"
+    response = requests.get(url).json()
+    light = response.get("lights", [{}])[0]
+    on = light.get("on", 0)
+    print(f"Elgato light is {'ON' if on else 'OFF'}")
+    return on
+
+
+def toggle_light():
+    """
+    Toggle the Elgato Ring Light on/off based on current power state.
+    """
+    current = get_light_state()
+    new_state = 0 if current else 1
+
+    url = f"http://{ELGATO_LIGHT_IP}:9123/elgato/lights"
+    response = requests.put(url, json={
+        "lights": [{"on": new_state}]
+    })
+
+    print(f"Set Elgato light to {'ON' if new_state else 'OFF'}")
+    return response.status_code

pymidi_controller-0.1.0/pymidi_controller/actions/elgato_discovery.py

@@ -0,0 +1,50 @@
+from zeroconf import Zeroconf, ServiceBrowser, ServiceListener
+from pymidi_controller.utils.config_manager import load_config, save_config
+import time
+
+# -------------------------------------------------------------------
+# 🔎 Elgato Device Discovery via mDNS
+# -------------------------------------------------------------------
+
+class ElgatoListener(ServiceListener):
+    """
+    Zeroconf listener that prints and optionally saves discovered Elgato devices.
+    """
+    def add_service(self, zeroconf, type_, name):
+        info = zeroconf.get_service_info(type_, name)
+        if info:
+            ip = ".".join(str(b) for b in info.addresses[0])
+            model = info.properties.get(b'md').decode("utf-8") if b'md' in info.properties else "Unknown"
+
+            print(f"Found Elgato Device: {model} @ {ip}")
+
+            save = input("💾 Save this IP to config as elgato ip? [y/N] ").strip().lower()
+            if save == "y":
+                config = load_config()
+                config.setdefault("elgato", {})
+                config["elgato"]["ip"] = ip
+                save_config(config)
+                print(f"✅ Saved elgato ip={ip} to config")
+            else:
+                print("⚠️ Skipped saving IP to config")
+
+
+def main(timeout=5):
+    """
+    Discover Elgato devices via Zeroconf (Bonjour/mDNS) and optionally save IP.
+    """
+    print("🔍 Searching for Elgato lights on the network...")
+
+    zeroconf = Zeroconf()
+    listener = ElgatoListener()
+
+    # Some devices use _elgato._tcp.local., others use _elg._tcp.local.
+    browser1 = ServiceBrowser(zeroconf, "_elgato._tcp.local.", listener)
+    browser2 = ServiceBrowser(zeroconf, "_elg._tcp.local.", listener)
+
+    time.sleep(timeout)
+    zeroconf.close()
+
+
+if __name__ == "__main__":
+    main()