Metadata-Version: 2.1
Name: lw-trv-proxy
Version: 0.2
Summary: A Lightwave RF Proxy
Home-page: https://github.com/ColinRobbins/Homeassistant-Lightwave-TRV
Author: Colin Robbins
Author-email: colin.john.robbins@gmail.com
License: UNKNOWN
Description: # Lightwave TRV Integration for HomeAssistant
        
        This adds support for Thermostatic Radiator Valves (TRVs) to the LightwaveRF integration into HomeAssistant.  
        This is for Series 1 Lightwave
        
        ## Getting Started
        
        Lightwave does not provide an interface, via the API, to query the Lightwave Hub for the current TRV status.  Instead the status is broadcast to the LAN.
        Thus this integration comes in two components.  A HomeAssistant custom configurations, and a proxy.
        The proxy captures the TRV broadcast messages, and makes them available to a HomeAssistant polling loop.
        
        ### Installing
        
        * github
        ```
        git clone https://github.com/ColinRobbins/Homeassistant-Lightwave-TRV.git
        ```
        or
        * pip
        ```
        pip3 install lw-trv-proxy
        ```
        
        ### Set up HomeAssistant
        Copy the folder, and all its contents to the HomeAssistant configuration area.
        ```
        cp -r customer_components ~homeassistant/.homeassistant
        ```
        
        
        ## Configuration
        The TRV broadcasts its status with the device serial number as the only identifier.
        This needs to be put into the HA configuration file.
        The file *sample_configuration.yaml* gives an example.
        ```
        lightwave:
          host: 192.168.10.10    	# Lightwave Hub
          trv_proxy_ip: 127.0.0.1       # Proxy address, do not change unless running on a different server
          trv_proxy_port: 7878		# Do not change, unless a port clash
          lights:
            R99D1:
              name: Bedroom Light
          trv:				
            R1Dh:			# The ID of the TRV.  
              name: Bedroom TRV
              serial: E84902		# Serial number of the TRV - found in the Lightwave App, or web site
        ```
        ## lightwave.py
        A modification is required to 
        ```
        lib/python3.7/site-packages/lightwave/lightwave.py
        ```
        to add TRV support.
        To replace the file...
        ```
        sudo cp lightwave/lightwave.py <PATH>/lib/python3.7/site-packages/lightwave/lightwave.py
        ```
        Replace ```<PATH>``` to the appropriate HomeAssistant folder.
        
        ## Run the proxy
        The proxy is (by default) configured to run on the same server as HA.
        No configuration should be needed.   Simply run it...
        ```
        python3 lwproxy.py &
        ```
        You will need to run this as a service to survive reboots etc.  I've created a ```systemctl``` template service description in ```lwproxy.service```.
        ## Test
        Restart hass.  (A restart is required, simply re-reading config is not sufficient)
        
        ## Authors
        
        * **Colin Robbins** - *Initial work* - [ColinRobbins](https://github.com/ColinRobbins)
        
        ## License
        
        This project is licensed under the same term as HomeAssistant - see the [LICENSE.md](LICENSE.md) file for details
        
        ## Acknowledgements
        
        * [GeoffAtHome](https://github.com/GeoffAtHome) for the initial work that started me investigating how to do this!
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
