Metadata-Version: 2.1
Name: pyvlx
Version: 0.2.20
Summary: PyVLX is a wrapper for the Velux KLF 200 API. PyVLX enables you to run scenes and or open and close velux windows.
Home-page: https://github.com/Julius2342/pyvlx
Author: Julius Mittenzwei
Author-email: julius@mittenzwei.com
License: LGPL
Download-URL: https://github.com/Julius2342/pyvlx/archive/0.2.20.zip
Description: PyVLX - controling VELUX windows with Python
        ============================================
        
        [![CI](https://github.com/Julius2342/pyvlx/actions/workflows/ci.yml/badge.svg)](https://github.com/Julius2342/pyvlx/actions/workflows/ci.yml)
        
        PyVLX uses the Velux KLF 200 interface to control io-Homecontrol devices, e.g. Velux Windows.
        
        Installation
        ------------
        
        PyVLX can be installed via:
        
        ```bash
        pip3 install pyvlx
        ```
        
        Home Assistant Plugin
        ---------------------
        
        PyVLX is used within [Home Assistant](https://www.home-assistant.io/components/velux/). To enable it add the following lines to your ~/.homeassistant/configuration.yml:
        
        ```yaml
        velux:
            host: "192.168.0.0"
            password: "1ADwl48dka"
        ```
        
        *Please note that this uses the WiFi password, not the web login.*
        
        For debugging frames add:
        
        ```yaml
        logger:
          default: warning
          logs:
            homeassistant.components.velux: debug
            pyvlx: debug
        ```
        
        
        Basic Operations
        ----------------
        
        ```python
        """Just a demo of the new PyVLX module."""
        import asyncio
        from pyvlx import PyVLX, Position
        
        
        async def main(loop):
            """Demonstrate functionality of PyVLX."""
            pyvlx = PyVLX('pyvlx.yaml', loop=loop)
            # Alternative:
            # pyvlx = PyVLX(host="192.168.2.127", password="velux123", loop=loop)
        
            # Runing scenes:
            await pyvlx.load_scenes()
            await pyvlx.scenes["All Windows Closed"].run()
        
            # Changing position of windows:
            await pyvlx.load_nodes()
            await pyvlx.nodes['Bath'].open()
            await pyvlx.nodes['Bath'].close()
            await pyvlx.nodes['Bath'].set_position(Position(position_percent=45))
        
            # Read limits of windows
            # limit = await pyvlx.nodes['Bath'].get_limitation()
            # limit.min_value
            # limit.max_value
            
            # Changing of on-off switches:
            # await pyvlx.nodes['CoffeeMaker'].set_on()
            # await pyvlx.nodes['CoffeeMaker'].set_off()
        
            # You can easily rename nodes:
            # await pyvlx.nodes["Window 10"].rename("Window 11")
                
            await pyvlx.disconnect()
        
        if __name__ == '__main__':
            # pylint: disable=invalid-name
            LOOP = asyncio.get_event_loop()
            LOOP.run_until_complete(main(LOOP))
            # LOOP.run_forever()
            LOOP.close()
        ```
        
Keywords: velux KLF 200 home automation
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/markdown
