{"id":26295673,"url":"https://github.com/rerikop/brightify","last_synced_at":"2025-09-15T08:07:25.656Z","repository":{"id":187851227,"uuid":"677576954","full_name":"RerikOp/Brightify","owner":"RerikOp","description":"Brightify is an OS-independent application that adjusts monitor brightness using the DDC/CI protocol and custom protocols for USB monitors, featuring a brightness sensor for automatic adjustments based on ambient light, and can be controlled via a taskbar icon.","archived":false,"fork":false,"pushed_at":"2024-12-13T20:53:54.000Z","size":317,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-09T00:49:58.508Z","etag":null,"topics":["cross-platform","ddcci","linux","monitor-brightness","pyqt","sensor","windows"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RerikOp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-08-12T00:22:54.000Z","updated_at":"2025-02-27T11:24:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"8d26b0b1-92b4-48e2-bbe7-9b0afa61dbe6","html_url":"https://github.com/RerikOp/Brightify","commit_stats":null,"previous_names":["rerikop/brightify"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/RerikOp/Brightify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RerikOp%2FBrightify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RerikOp%2FBrightify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RerikOp%2FBrightify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RerikOp%2FBrightify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RerikOp","download_url":"https://codeload.github.com/RerikOp/Brightify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RerikOp%2FBrightify/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275225879,"owners_count":25427009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cross-platform","ddcci","linux","monitor-brightness","pyqt","sensor","windows"],"created_at":"2025-03-15T04:14:48.237Z","updated_at":"2025-09-15T08:07:25.634Z","avatar_url":"https://github.com/RerikOp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003cbr\u003e\n    \u003cimg src=\"brightify/res/icon_light.ico\" alt=\"\" width=\"150\" height=\"auto\"/\u003e\n    \u003ch1\u003eBrightify\u003c/h1\u003e\n    \u003cdiv\u003e\n    \u003ca href=\"https://www.codefactor.io/repository/github/rerikop/brightify\"\u003e\u003cimg src=\"https://www.codefactor.io/repository/github/rerikop/brightify/badge\" alt=\"CodeFactor\" /\u003e\u003c/a\u003e    \n    \u003c/div\u003e\n\u003cbr\u003e\n\u003c/div\u003e\n\nThis app allows you to set the brightness of your monitor(s). It is essentially a wrapper around\nthe [DDC/CI](https://en.wikipedia.org/wiki/Display_Data_Channel#DDC/CI) protocol, which is supported by most modern monitors.\nIt also supports adding custom communication protocols to control the brightness of Monitors connected via USB.\nYou can find an example implementation for the [Gigabyte M27Q](https://www.gigabyte.com/Monitor/M27Q)\nin [here](brightify/src_py/monitors/m27q.py).\nThe app is designed to be run in the background and can be controlled via a taskbar icon. It also supports a brightness\nsensor that can automatically adjust the brightness based on the ambient light.\n\n## Getting started\n\n1. Install brightify by running `pip install Brightify`. This package is regularly uploaded to PyPi. If you want to\n   install the latest version, you can clone this repository from\n   [GitHub](https://github.com/RerikOp/Brightify) and install it with `pip install -e .` in the root directory.\n2. To start the app: `python -m brightify run`. You can exit either by right-clicking the icon in the taskbar and\n   selecting \"Exit\" or by pressing `Ctrl+C` in the terminal.\n3. To start the app at startup (or logon) and add a menu icon, run `python -m brightify add all`. To remove the both,\n   run\n   `python -m brightify remove all`.\n\n### Additional requirements for Linux\nAs the DDC/CI protocol requires write access to the `/dev/i2c-*` devices, you need to add your user to the `i2c` group (or run the script as the root user).\n- First, verify that the group exists by running `getent group i2c`. \n  - If it does not exist, you need to create it by running `sudo groupadd i2c` and also assign the `i2c` devices to the group by running `sudo chown root:i2c /dev/i2c-*`.\n- Now you can add your user to the group by running `sudo usermod -aG i2c $USER`. Verify that the user is in the group by running\n`groups $USER` and checking if `i2c` is listed. If running `groups` does not show `i2c`, you need restart the system.\n- Finally, you might need to change the permissions of the `/dev/i2c-*` so that the group has read/write access. You can do this by running `sudo chmod g+rw /dev/i2c-*`.\n  - If this change is not permanent you can create a udev rule by creating a file in `/etc/udev/rules.d/` with the content `KERNEL==\"i2c-[0-9]*\", GROUP=\"i2c\", MODE=\"0660\"`.\n  - After creating the file, you need to reload the udev rules by running `sudo udevadm control --reload-rules \u0026\u0026 sudo udevadm trigger`.\n- To remove the user from the group, run `sudo deluser $USER i2c`.\n\n## Optional arguments\n\nThere are several other arguments you can pass to the app, see `python -m brightify --help` for more information.\n\n- To target add/remove only the startup run `python -m brightify add/remove startup`.\n    - To add a task to the task scheduler on Windows, pass `--use-scheduler`. It will request elevated permissions.\n- To add/remove only the menu icon run `python -m brightify add/remove menu-icon`.\n- By default, the terminal will be hidden, but you can change this by passing the `--force-console` argument to the `run` or `add` action.\n- To disable animations, pass the `--no-animations` argument to the `run` or `add` action.\n\n## Set up the brightness sensor\n\n- Modify the [SensorComm](brightify/src_py/SensorComm.py) class to match your device and firmware\n- Modify the code that is polling from the brightness sensor [Device Firmware](brightify/sensor_firmware/src)\n- Modify [platformio.ini](brightify/sensor_firmware/platformio.ini) and enter your board (\n  see [supported boards](https://docs.platformio.org/en/latest/boards/index.html))\n- Run `pio run -t upload` in the terminal to upload the firmware to the board.\n  If everything is working, the *Auto* Checkbox for each supported Monitor should now be clickable\n\n## Remarks\n\n- Currently, only the Windows task bar icon is supported, the main part of this app is OS independent.\n- Feel free to create a pull request and add your own USB Monitor\n- Note that a USB Monitor will replace a DDC/CI Monitor with the same name. If you want to use both, you need to change\n  the name of your USB Monitor implementation.\n  In case a monitor is found but does not send its name, we cannot distinguish between DDC/CI and USB Monitors. In this\n  case, both will be added.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frerikop%2Fbrightify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frerikop%2Fbrightify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frerikop%2Fbrightify/lists"}