brightctrl 0.0.0 → 0.0.2

package/README.md

@@ -0,0 +1,85 @@
+# BrightCtrl
+
+A lightweight DDC/CI monitor brightness controller for Linux — now a terminal UI built with [React](https://react.dev) / [Ink](https://github.com/vadimdemedes/ink) on [Bun](https://bun.sh).
+
+![Platform](https://img.shields.io/badge/platform-Linux-lightgrey)
+
+## Features
+
+- Auto-detects all DDC/CI-capable monitors
+- Per-monitor brightness bars with live percentage
+- Arrow key / vim (`h`/`l`) brightness adjustment (5% steps)
+- **Sync mode** (`s`) — control all monitors at once
+- Direct input dialog (`i`) — type a specific brightness value
+- 500ms debounce on DDC writes (no flooding the i2c bus)
+- Brightness-dependent color coding (red ≤20%, cyan 21-89%, yellow ≥90%)
+
+## Requirements
+
+### System
+
+| Distro | Command |
+|---|---|
+| Arch / Manjaro | `sudo pacman -S ddcutil` |
+| Debian / Ubuntu | `sudo apt install ddcutil` |
+| Fedora / RHEL | `sudo dnf install ddcutil` |
+
+Then set up the i2c kernel module and add yourself to the i2c group:
+
+```bash
+sudo usermod -aG i2c $USER
+sudo modprobe i2c-dev
+
+# Persist across reboots:
+echo 'i2c-dev' | sudo tee /etc/modules-load.d/i2c.conf
+
+# Log out and back in for the group change to take effect.
+```
+
+Verify everything works:
+
+```bash
+ddcutil detect
+```
+
+### Runtime
+
+- [Node.js](https://nodejs.org) >= 18
+- Or [Bun](https://bun.sh) 1.x (for development)
+
+## Install & Run
+
+### Quick — no install needed
+
+```bash
+npx brightctrl
+```
+
+### Global install
+
+```bash
+npm install -g brightctrl
+brightctrl
+```
+
+### From source
+
+```bash
+git clone https://github.com/shahriyardx/brightctrl.git
+cd brightctrl
+bun install
+bun src/index.tsx
+```
+
+### Controls
+
+| Key | Action |
+|---|---|
+| `↑` / `↓` | Select monitor |
+| `←` / `h` | Decrease brightness 5% |
+| `→` / `l` | Increase brightness 5% |
+| `i` | Open input dialog (type 0–100, Enter to confirm) |
+| `s` | Toggle sync mode (all monitors) |
+| `r` | Refresh monitor detection |
+| `q` | Quit |
+

package/dist/index.js

@@ -0,0 +1,535 @@
+#!/usr/bin/env node
+// @bun
+
+// src/index.tsx
+import { render } from "ink";
+
+// src/app.tsx
+import { Box, Text, useApp, useInput } from "ink";
+import { useCallback, useEffect, useRef, useState } from "react";
+
+// src/ddcutil.ts
+import { execFile } from "node:child_process";
+import { promisify } from "node:util";
+var execFileAsync = promisify(execFile);
+var isWindows = process.platform === "win32";
+var isMac = process.platform === "darwin";
+function ddcutil(args, timeout = 8000) {
+  return execFileAsync("ddcutil", args, {
+    timeout,
+    encoding: "utf-8"
+  }).then((r) => r.stdout);
+}
+function powerShell(script, timeout = 8000) {
+  return execFileAsync("powershell.exe", ["-NoProfile", "-NonInteractive", "-Command", script], { timeout, encoding: "utf-8" }).then((r) => r.stdout.trim());
+}
+async function checkDdcutil() {
+  if (isWindows) {
+    try {
+      const out = await powerShell("Get-CimInstance -Namespace root/WMI -ClassName WmiMonitorBrightness | ConvertTo-Json -Depth 3", 5000);
+      return out.length > 0 && out !== "null";
+    } catch {
+      return false;
+    }
+  }
+  if (isMac)
+    return false;
+  try {
+    await execFileAsync("which", ["ddcutil"]);
+    return true;
+  } catch {
+    return false;
+  }
+}
+async function detectMonitorsLinux() {
+  const stdout = await ddcutil(["detect", "--brief"], 15000);
+  const monitors = [];
+  let current = null;
+  for (const line of stdout.split(`
+`)) {
+    const t = line.trim();
+    if (t.startsWith("Display ")) {
+      if (current?.index != null)
+        monitors.push(current);
+      const m = t.match(/Display\s+(\d+)/);
+      const idxStr = m?.[1];
+      current = {
+        index: idxStr ? Number.parseInt(idxStr, 10) : monitors.length + 1,
+        name: "Unknown Monitor",
+        bus: ""
+      };
+    } else if (t.includes("I2C bus:")) {
+      if (current)
+        current.bus = t.replace("I2C bus:", "").trim();
+    } else if (t.startsWith("Monitor:")) {
+      if (current) {
+        const p = t.replace("Monitor:", "").trim();
+        current.name = p.replace(/\s+unspecified/i, "").trim() || "Monitor";
+      }
+    }
+  }
+  if (current?.index != null)
+    monitors.push(current);
+  return monitors;
+}
+async function detectMonitorsWindows() {
+  const ps = `$b=Get-CimInstance -Namespace root/WMI -ClassName WmiMonitorBrightness; $r=@(); $i=0; foreach($m in $b){$i++; $r+=[PSCustomObject]@{index=$i;name=[string]($m.InstanceName -replace '.*\\\\([^\\\\]+)\\\\.*','$1');bus=$m.InstanceName}}; $r | ConvertTo-Json -Depth 3`;
+  const stdout = await powerShell(ps, 1e4);
+  if (!stdout || stdout === "null")
+    return [];
+  const data = JSON.parse(stdout);
+  const arr = Array.isArray(data) ? data : [data];
+  return arr.map((d, i) => ({
+    index: i + 1,
+    name: typeof d.name === "string" && d.name ? d.name : "Monitor",
+    bus: typeof d.bus === "string" ? d.bus : ""
+  }));
+}
+async function detectMonitorsMac() {
+  return [];
+}
+async function getBrightnessMac(_displayIndex) {
+  return null;
+}
+async function setBrightnessMac(_displayIndex, _value) {
+  return false;
+}
+async function detectMonitors() {
+  if (isWindows)
+    return detectMonitorsWindows();
+  if (isMac)
+    return detectMonitorsMac();
+  return detectMonitorsLinux();
+}
+async function getBrightnessLinux(displayIndex) {
+  try {
+    const stdout = await ddcutil(["getvcp", "10", `--display=${displayIndex}`], 5000);
+    const m = stdout.match(/current value\s*=\s*(\d+)/);
+    const val = m?.[1];
+    return val ? Number.parseInt(val, 10) : null;
+  } catch {
+    return null;
+  }
+}
+async function getBrightnessWindows(displayIndex) {
+  try {
+    const idx = Math.max(0, displayIndex - 1);
+    const ps = `$b=Get-CimInstance -Namespace root/WMI -ClassName WmiMonitorBrightness; if($b -and $b.Count -ge ${idx + 1}){$b[${idx}].CurrentBrightness}else{-1}`;
+    const stdout = await powerShell(ps, 5000);
+    const v = Number.parseInt(stdout, 10);
+    return Number.isNaN(v) || v < 0 ? null : v;
+  } catch {
+    return null;
+  }
+}
+async function getBrightness(displayIndex) {
+  if (isWindows)
+    return getBrightnessWindows(displayIndex);
+  if (isMac)
+    return getBrightnessMac(displayIndex);
+  return getBrightnessLinux(displayIndex);
+}
+async function setBrightnessLinux(displayIndex, value) {
+  try {
+    await ddcutil(["setvcp", "10", String(Math.round(value)), `--display=${displayIndex}`], 5000);
+    return true;
+  } catch {
+    return false;
+  }
+}
+async function setBrightnessWindows(displayIndex, value) {
+  try {
+    const idx = Math.max(0, displayIndex - 1);
+    const ps = `$m=Get-CimInstance -Namespace root/WMI -ClassName WmiMonitorBrightnessMethods; if($m -and $m.Count -ge ${idx + 1}){$m[${idx}].WmiSetBrightness(1,${Math.round(value)})}`;
+    await powerShell(ps, 5000);
+    return true;
+  } catch {
+    return false;
+  }
+}
+async function setBrightness(displayIndex, value) {
+  if (isWindows)
+    return setBrightnessWindows(displayIndex, value);
+  if (isMac)
+    return setBrightnessMac(displayIndex, value);
+  return setBrightnessLinux(displayIndex, value);
+}
+
+// src/app.tsx
+import { jsxDEV, Fragment } from "react/jsx-dev-runtime";
+function BrightnessBar({
+  value,
+  width = 25
+}) {
+  const filled = Math.round(value / 100 * width);
+  const empty = width - filled;
+  const color = value <= 20 ? "red" : value >= 90 ? "yellow" : "cyan";
+  return /* @__PURE__ */ jsxDEV(Box, {
+    children: [
+      /* @__PURE__ */ jsxDEV(Text, {
+        color,
+        children: filled > 0 ? "█".repeat(filled) : ""
+      }, undefined, false, undefined, this),
+      /* @__PURE__ */ jsxDEV(Text, {
+        color: "#444",
+        children: empty > 0 ? "░".repeat(empty) : ""
+      }, undefined, false, undefined, this),
+      /* @__PURE__ */ jsxDEV(Text, {
+        children: " "
+      }, undefined, false, undefined, this),
+      /* @__PURE__ */ jsxDEV(Text, {
+        color,
+        bold: true,
+        children: [
+          Math.round(value),
+          "%"
+        ]
+      }, undefined, true, undefined, this)
+    ]
+  }, undefined, true, undefined, this);
+}
+function MonitorCard({
+  monitor,
+  selected
+}) {
+  return /* @__PURE__ */ jsxDEV(Box, {
+    borderStyle: selected ? "round" : "single",
+    borderColor: selected ? "cyan" : "gray",
+    flexDirection: "column",
+    paddingX: 1,
+    paddingY: 0,
+    children: [
+      /* @__PURE__ */ jsxDEV(Box, {
+        gap: 1,
+        children: [
+          /* @__PURE__ */ jsxDEV(Text, {
+            bold: true,
+            color: selected ? "cyan" : "white",
+            children: [
+              "Display ",
+              monitor.index
+            ]
+          }, undefined, true, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "white",
+            children: monitor.name
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: monitor.bus
+          }, undefined, false, undefined, this),
+          selected ? /* @__PURE__ */ jsxDEV(Text, {
+            color: "cyan",
+            children: "◄"
+          }, undefined, false, undefined, this) : null
+        ]
+      }, undefined, true, undefined, this),
+      /* @__PURE__ */ jsxDEV(Box, {
+        children: /* @__PURE__ */ jsxDEV(BrightnessBar, {
+          value: monitor.brightness
+        }, undefined, false, undefined, this)
+      }, undefined, false, undefined, this)
+    ]
+  }, undefined, true, undefined, this);
+}
+function ErrorPanel() {
+  const plat = process.platform;
+  if (plat === "darwin")
+    return null;
+  return /* @__PURE__ */ jsxDEV(Box, {
+    flexDirection: "column",
+    marginTop: 1,
+    children: [
+      /* @__PURE__ */ jsxDEV(Text, {
+        color: "yellow",
+        children: "Troubleshooting:"
+      }, undefined, false, undefined, this),
+      plat === "win32" ? /* @__PURE__ */ jsxDEV(Fragment, {
+        children: [
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: "Some GPUs/monitors don't expose brightness via WMI."
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: "Try installing MonitorController from Windows Store."
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this) : /* @__PURE__ */ jsxDEV(Fragment, {
+        children: [
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: " sudo pacman -S ddcutil"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: " sudo usermod -aG i2c $USER"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: " sudo modprobe i2c-dev"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: "echo 'i2c-dev' | sudo tee /etc/modules-load.d/i2c.conf"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: " (log out and in for group change)"
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this)
+    ]
+  }, undefined, true, undefined, this);
+}
+function App() {
+  const { exit } = useApp();
+  const [monitors, setMonitors] = useState([]);
+  const [selected, setSelected] = useState(0);
+  const [syncMode, setSyncMode] = useState(false);
+  const [status, setStatus] = useState("Starting...");
+  const [error, setError] = useState(null);
+  const [loading, setLoading] = useState(true);
+  const [typing, setTyping] = useState(false);
+  const [typed, setTyped] = useState("");
+  const debounceTimer = useRef(null);
+  const pendingRef = useRef(new Map);
+  function scheduleBrightness(index, value) {
+    pendingRef.current.set(index, value);
+    if (debounceTimer.current)
+      clearTimeout(debounceTimer.current);
+    debounceTimer.current = setTimeout(() => {
+      const vals = new Map(pendingRef.current);
+      pendingRef.current.clear();
+      for (const [idx, v] of vals) {
+        setBrightness(idx, v);
+      }
+    }, 500);
+  }
+  const load = useCallback(async () => {
+    setLoading(true);
+    setError(null);
+    setStatus("Checking ddcutil...");
+    const hasBackend = await checkDdcutil();
+    if (!hasBackend) {
+      if (process.platform === "win32") {
+        setError("No monitors with WMI brightness control found");
+      } else if (process.platform === "darwin") {
+        setError("macOS is not supported at this moment");
+      } else {
+        setError("ddcutil not found. Install: sudo pacman -S ddcutil");
+      }
+      setStatus("backend unavailable");
+      setLoading(false);
+      return;
+    }
+    setStatus("Detecting monitors...");
+    const infoList = await detectMonitors();
+    if (infoList.length === 0) {
+      setError("No DDC/CI monitors detected");
+      setStatus("No monitors found");
+      setLoading(false);
+      return;
+    }
+    setStatus(`Reading brightness for ${infoList.length} monitor(s)...`);
+    const loaded = [];
+    for (const info of infoList) {
+      const b = await getBrightness(info.index);
+      loaded.push({ ...info, brightness: b ?? 50 });
+    }
+    setMonitors(loaded);
+    setSelected((s) => Math.min(s, loaded.length - 1));
+    setStatus(`${loaded.length} monitor(s) — DDC/CI via ddcutil`);
+    setLoading(false);
+  }, []);
+  useEffect(() => {
+    load();
+  }, [load]);
+  function adjustBrightness(delta) {
+    if (monitors.length === 0)
+      return;
+    const idx = selected;
+    setMonitors((prev) => prev.map((m, i) => {
+      if (!syncMode && i !== idx)
+        return m;
+      const v = Math.max(0, Math.min(100, m.brightness + delta));
+      scheduleBrightness(m.index, v);
+      return { ...m, brightness: v };
+    }));
+  }
+  useInput((input, key) => {
+    if (typing) {
+      if (key.escape) {
+        setTyping(false);
+        setTyped("");
+      } else if (key.return) {
+        const v = Number.parseInt(typed, 10);
+        if (!Number.isNaN(v) && v >= 0 && v <= 100) {
+          setMonitors((prev) => prev.map((m, i) => {
+            if (!syncMode && i !== selected)
+              return m;
+            scheduleBrightness(m.index, v);
+            return { ...m, brightness: v };
+          }));
+        }
+        setTyping(false);
+        setTyped("");
+      } else if (key.backspace) {
+        setTyped((p) => p.slice(0, -1));
+      } else if (/^[0-9]$/.test(input)) {
+        setTyped((p) => (p + input).slice(0, 3));
+      }
+      return;
+    }
+    if (input === "q")
+      exit();
+    if (key.upArrow) {
+      setSelected((s) => Math.max(0, s - 1));
+    } else if (key.downArrow) {
+      setSelected((s) => Math.min(monitors.length - 1, s + 1));
+    } else if (input === "h" || key.leftArrow) {
+      adjustBrightness(-5);
+    } else if (input === "l" || key.rightArrow) {
+      adjustBrightness(5);
+    } else if (input === "s") {
+      setSyncMode((s) => !s);
+    } else if (input === "r") {
+      load();
+    } else if (input === "i") {
+      setTyping(true);
+      setTyped("");
+    }
+  });
+  return /* @__PURE__ */ jsxDEV(Box, {
+    flexDirection: "column",
+    padding: 1,
+    children: [
+      /* @__PURE__ */ jsxDEV(Box, {
+        gap: 2,
+        children: [
+          /* @__PURE__ */ jsxDEV(Text, {
+            bold: true,
+            color: "cyan",
+            children: "BrightCtrl"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: "gray",
+            children: "DDC/CI Brightness Controller"
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this),
+      /* @__PURE__ */ jsxDEV(Text, {
+        color: "#333",
+        children: "─".repeat(56)
+      }, undefined, false, undefined, this),
+      /* @__PURE__ */ jsxDEV(Box, {
+        marginBottom: 1,
+        gap: 3,
+        children: [
+          /* @__PURE__ */ jsxDEV(Text, {
+            color: syncMode ? "green" : "gray",
+            children: [
+              "[",
+              syncMode ? "✓" : " ",
+              "] Sync All ",
+              /* @__PURE__ */ jsxDEV(Text, {
+                color: "gray",
+                children: "(s)"
+              }, undefined, false, undefined, this)
+            ]
+          }, undefined, true, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            children: [
+              "⟳ Refresh ",
+              /* @__PURE__ */ jsxDEV(Text, {
+                color: "gray",
+                children: "(r)"
+              }, undefined, false, undefined, this)
+            ]
+          }, undefined, true, undefined, this),
+          /* @__PURE__ */ jsxDEV(Text, {
+            children: [
+              "✕ Quit ",
+              /* @__PURE__ */ jsxDEV(Text, {
+                color: "gray",
+                children: "(q)"
+              }, undefined, false, undefined, this)
+            ]
+          }, undefined, true, undefined, this)
+        ]
+      }, undefined, true, undefined, this),
+      /* @__PURE__ */ jsxDEV(Box, {
+        marginBottom: 1,
+        children: loading ? /* @__PURE__ */ jsxDEV(Text, {
+          color: "gray",
+          children: [
+            status,
+            "..."
+          ]
+        }, undefined, true, undefined, this) : error ? /* @__PURE__ */ jsxDEV(Text, {
+          color: "red",
+          children: error
+        }, undefined, false, undefined, this) : /* @__PURE__ */ jsxDEV(Text, {
+          color: "gray",
+          children: status
+        }, undefined, false, undefined, this)
+      }, undefined, false, undefined, this),
+      !loading && !error && monitors.length > 0 ? /* @__PURE__ */ jsxDEV(Box, {
+        flexDirection: "column",
+        gap: 0,
+        children: monitors.map((m, i) => /* @__PURE__ */ jsxDEV(MonitorCard, {
+          monitor: m,
+          selected: i === selected
+        }, m.index, false, undefined, this))
+      }, undefined, false, undefined, this) : null,
+      !loading && error ? /* @__PURE__ */ jsxDEV(ErrorPanel, {}, undefined, false, undefined, this) : null,
+      typing ? /* @__PURE__ */ jsxDEV(Box, {
+        flexDirection: "column",
+        marginTop: 1,
+        marginBottom: 1,
+        children: /* @__PURE__ */ jsxDEV(Box, {
+          borderStyle: "round",
+          borderColor: "cyan",
+          paddingX: 1,
+          flexDirection: "column",
+          children: [
+            /* @__PURE__ */ jsxDEV(Box, {
+              gap: 1,
+              children: [
+                /* @__PURE__ */ jsxDEV(Text, {
+                  bold: true,
+                  color: "cyan",
+                  children: "Brightness:"
+                }, undefined, false, undefined, this),
+                /* @__PURE__ */ jsxDEV(Text, {
+                  bold: true,
+                  color: "white",
+                  children: [
+                    typed || "0",
+                    "_"
+                  ]
+                }, undefined, true, undefined, this)
+              ]
+            }, undefined, true, undefined, this),
+            /* @__PURE__ */ jsxDEV(Text, {
+              color: "gray",
+              children: "Enter 0-100 ↵ confirm ⎋ cancel"
+            }, undefined, false, undefined, this)
+          ]
+        }, undefined, true, undefined, this)
+      }, undefined, false, undefined, this) : null,
+      !loading ? /* @__PURE__ */ jsxDEV(Box, {
+        marginTop: 1,
+        children: error ? null : /* @__PURE__ */ jsxDEV(Text, {
+          color: "gray",
+          children: "↑↓ select h/l ←→ brightness i input s sync r refresh q quit"
+        }, undefined, false, undefined, this)
+      }, undefined, false, undefined, this) : null
+    ]
+  }, undefined, true, undefined, this);
+}
+
+// src/index.tsx
+import { jsxDEV as jsxDEV2 } from "react/jsx-dev-runtime";
+var { waitUntilExit } = render(/* @__PURE__ */ jsxDEV2(App, {}, undefined, false, undefined, this));
+await waitUntilExit();

package/package.json

@@ -1,11 +1,47 @@
 {
   "name": "brightctrl",
-  "version": "0.0.0",
-  "description": "Placeholder for brightctrl",
-  "main": "index.js",
-  "scripts": {},
-  "keywords": [],
-  "author": "shahriyardx (https://www.npmjs.com/~shahriyardx)",
-  "license": "UNLICENSED",
-  "private": false
-}
+  "version": "0.0.2",
+  "description": "Terminal UI for DDC/CI monitor brightness control",
+  "type": "module",
+  "bin": {
+    "brightctrl": "dist/index.js"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "bun build src/index.tsx --outdir dist --target node --format esm --external ink --external react --external react-reconciler --external scheduler --external '@types/react' && sed -i 's_^#!/usr/bin/env bun_#!/usr/bin/env node_' dist/index.js",
+    "prepublishOnly": "bun run build",
+    "lint": "biome check src/",
+    "format": "biome check --write src/",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "ink": "^5.2.0",
+    "react": "^18.3.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.15",
+    "@types/react": "^18.3.0",
+    "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shahriyardx/brightctrl.git"
+  },
+  "homepage": "https://github.com/shahriyardx/brightctrl",
+  "keywords": [
+    "brightness",
+    "ddc-ci",
+    "ddcutil",
+    "monitor",
+    "tui",
+    "ink",
+    "waybar"
+  ],
+  "license": "MIT"
+}

package/index.js

@@ -1 +0,0 @@
-// Placeholder