Metadata-Version: 1.1
Name: rpi_backlight
Version: 1.3.0
Summary: A Python module for controlling power and brightness of the official Raspberry Pi 7" touch display.
Home-page: https://github.com/linusg/rpi-backlight
Author: Linus Groh
Author-email: mail@linusgroh.de
License: MIT
Download-URL: https://pypi.python.org/pypi/rpi_backlight
Description: rpi-backlight
        =============
        
        A Python module for controlling power and brightness of the official Raspberry Pi 7" touch display.
        ---------------------------------------------------------------------------------------------------
        
        **WARNING: This comes with absolutely no warranty, do anything on your own risk!**
        
        The code is very small and simple, but will be extended in the future for new features. Feel free to contribute!
        
        Features:
        ---------
        
        - Change the display brightness **smoothly** or **abrupt**
        - Set the display power on or off
        - Get the current brightness
        - Get the maximum brightness
        - Get the display power state (on/off)
        
        .. image:: https://github.com/linusg/rpi-backlight/blob/master/example.gif
           :alt: Example
        
        Installation
        ------------
        
        - Install from PyPI using ``pip install rpi_backlight``, or
        - clone this repository and ``python setup.py install``.
        
        Usage
        -----
        
        Start from the command line:
        
        - ``rpi-backlight`` for a CLI
        - ``rpi-backlight-gui`` for a GUI (experimental)
        
        Example in a Python shell::
        
            >>> import rpi_backlight as bl
            >>> bl.set_brightness(20)
            >>> bl.set_brightness(255)
            >>> bl.set_brightness(20, smooth=False)
            >>> bl.get_max_brightness()
            255
            >>> bl.get_current_brightness()
            20
            >>> bl.get_power()
            True
            >>> bl.set_power(False)
        
        **NOTE: Code using** ``set_`` **functions of this library has to be run as root, e.g.** ``sudo python file.py`` **!**
        
        Requirements
        ------------
        
        - A **Raspberry Pi** including a correctly assembled **7" touch display v1.1 or higher**
        - Python 2 or 3
        
        Todo
        ----
        
        - Allow to set the brightness fading duration in ``set_brightness(value)``
        - Create a really simple GUI in ``pygobject`` to change the display brightness, maybe just a scale/slider
        
        I would be happy if you can help shortening this todo-list!
        
        License
        -------
        
        The source code and all other files in this repository are licensed under the MIT license, so you can easily use it in your own projects.
        
Keywords: raspberry pi,display,touchscreen,brightness
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: System :: Hardware
Classifier: Topic :: Multimedia
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
