Brightify


NameBrightify JSON
Version 0.1.13 PyPI version JSON
download
home_pageNone
SummaryBrightify 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.
upload_time2024-08-30 15:51:27
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseNone
keywords brightness monitor screen control tool
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <div align="center">
<br>
    <img src="brightify/res/icon_light.ico" alt="" width="150" height="auto"/>
    <h1>Brightify</h1>
    <div>
    <a href="https://www.codefactor.io/repository/github/rerikop/brightify"><img src="https://www.codefactor.io/repository/github/rerikop/brightify/badge" alt="CodeFactor" /></a>    
    </div>
<br>
</div>

This app allows you to set the brightness of your monitor(s). It is essentially a wrapper around
the [DDC/CI](https://en.wikipedia.org/wiki/Display_Data_Channel#DDC/CI) protocol, which is supported by most modern monitors.
It also supports adding custom communication protocols to control the brightness of Monitors connected via USB.
You can find an example implementation for the [Gigabyte M27Q](https://www.gigabyte.com/Monitor/M27Q)
in [here](brightify/src_py/monitors/m27q.py).
The app is designed to be run in the background and can be controlled via a taskbar icon. It also supports a brightness
sensor that can automatically adjust the brightness based on the ambient light.

## Getting started

1. Install brightify by running `pip install Brightify`. This package is regularly uploaded to PyPi. If you want to
   install the latest version, you can clone this repository from
   [GitHub](https://github.com/RerikOp/Brightify) and install it with `pip install -e .` in the root directory.
2. To start the app: `python -m brightify run`. You can exit either by right-clicking the icon in the taskbar and
   selecting "Exit" or by pressing `Ctrl+C` in the terminal.
3. To start the app at startup (or logon) and add a menu icon, run `python -m brightify add all`. To remove the both,
   run
   `python -m brightify remove all`.

### Additional requirements for Linux
As 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).
- First, verify that the group exists by running `getent group i2c`. 
  - 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-*`.
- 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
`groups $USER` and checking if `i2c` is listed. If running `groups` does not show `i2c`, you need restart the system.
- 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-*`.
  - 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"`.
  - After creating the file, you need to reload the udev rules by running `sudo udevadm control --reload-rules && sudo udevadm trigger`.
- To remove the user from the group, run `sudo deluser $USER i2c`.

## Optional arguments

There are several other arguments you can pass to the app, see `python -m brightify --help` for more information.

- To target add/remove only the startup run `python -m brightify add/remove startup`.
    - To add a task to the task scheduler on Windows, pass `--use-scheduler`. It will request elevated permissions.
- To add/remove only the menu icon run `python -m brightify add/remove menu-icon`.
- By default, the terminal will be hidden, but you can change this by passing the `--force-console` argument to the `run` or `add` action.
- To disable animations, pass the `--no-animations` argument to the `run` or `add` action.

## Set up the brightness sensor

- Modify the [SensorComm](brightify/src_py/SensorComm.py) class to match your device and firmware
- Modify the code that is polling from the brightness sensor [Device Firmware](brightify/sensor_firmware/src)
- Modify [platformio.ini](brightify/sensor_firmware/platformio.ini) and enter your board (
  see [supported boards](https://docs.platformio.org/en/latest/boards/index.html))
- Run `pio run -t upload` in the terminal to upload the firmware to the board.
  If everything is working, the *Auto* Checkbox for each supported Monitor should now be clickable

## Remarks

- Currently, only the Windows task bar icon is supported, the main part of this app is OS independent.
- Feel free to create a pull request and add your own USB Monitor
- 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
  the name of your USB Monitor implementation.
  In case a monitor is found but does not send its name, we cannot distinguish between DDC/CI and USB Monitors. In this
  case, both will be added.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "Brightify",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "brightness, monitor, screen, control, tool",
    "author": null,
    "author_email": "\"Robin S.\" <brightify@rs-web.net>",
    "download_url": "https://files.pythonhosted.org/packages/2c/f1/2f3aaa337c7bac97345f53290071328ca42903da7dbe70a780cae9d003e1/brightify-0.1.13.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n<br>\n    <img src=\"brightify/res/icon_light.ico\" alt=\"\" width=\"150\" height=\"auto\"/>\n    <h1>Brightify</h1>\n    <div>\n    <a href=\"https://www.codefactor.io/repository/github/rerikop/brightify\"><img src=\"https://www.codefactor.io/repository/github/rerikop/brightify/badge\" alt=\"CodeFactor\" /></a>    \n    </div>\n<br>\n</div>\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 && 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",
    "bugtrack_url": null,
    "license": null,
    "summary": "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.",
    "version": "0.1.13",
    "project_urls": null,
    "split_keywords": [
        "brightness",
        " monitor",
        " screen",
        " control",
        " tool"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "be71ebb75e0fb089937b36a573c98df8204f2bed05f87a45d9ee27ed07a595c3",
                "md5": "0182bfd8de0dfbcd0d90ce527de91e8b",
                "sha256": "0a6fca82a3202b8ca6c7a1cf62ae39b781a3a38ae580a3d78fac1403317b0642"
            },
            "downloads": -1,
            "filename": "Brightify-0.1.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0182bfd8de0dfbcd0d90ce527de91e8b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 50606,
            "upload_time": "2024-08-30T15:51:27",
            "upload_time_iso_8601": "2024-08-30T15:51:27.060943Z",
            "url": "https://files.pythonhosted.org/packages/be/71/ebb75e0fb089937b36a573c98df8204f2bed05f87a45d9ee27ed07a595c3/Brightify-0.1.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2cf12f3aaa337c7bac97345f53290071328ca42903da7dbe70a780cae9d003e1",
                "md5": "338335ad4be839172bd151401fcf4d81",
                "sha256": "4d2296889bb32e166829582a2984bb073b58173cbb8617362d59f5959cd2282c"
            },
            "downloads": -1,
            "filename": "brightify-0.1.13.tar.gz",
            "has_sig": false,
            "md5_digest": "338335ad4be839172bd151401fcf4d81",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 41021,
            "upload_time": "2024-08-30T15:51:27",
            "upload_time_iso_8601": "2024-08-30T15:51:27.996643Z",
            "url": "https://files.pythonhosted.org/packages/2c/f1/2f3aaa337c7bac97345f53290071328ca42903da7dbe70a780cae9d003e1/brightify-0.1.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-30 15:51:27",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "brightify"
}
None
Elapsed time: 0.42307s