Metadata-Version: 2.1
Name: Homie4
Version: 0.1.8
Summary: Homie 4.0.0 Implementation
Home-page: https://github.com/mjcumming/Homie
Author: Michael Cumming
Author-email: mike@4831.com
License: UNKNOWN
Description: # Homie
        
        Python implementation of Homie 4.0.0
        
        Class based system to easily add Homie 4.0.0 support to devices.
        
        Supports the Meta, Statistics, and Firmware extensions
        
        Install
        
        ~~~~
        pip install Homie4
        ~~~~
        
        Includes ready to use common devices such as switch, dimmer, contact, thermostat, boolean, etc. 
        
        
        EG. To create a dimmer device requires that a set_dimmer method be provided. When creating a device, all that is required is to provide the MQTT settings. All other requirements of the Homie specification are automatically handled.
        
        ~~~~
        import time
        
        from homie.device_dimmer import Device_Dimmer
        
        mqtt_settings = {
            'MQTT_BROKER' : 'QueenMQTT',
            'MQTT_PORT' : 1883,
        }
        
        class My_Dimmer(Device_Dimmer):
        
            def set_dimmer(self,percent):
                print('Received MQTT message to set the dimmer to {}. Must replace this method'.format(percent))
                super().set_dimmer(percent)        
        
        try:
        
            dimmer = My_Dimmer(name = 'Test Dimmer',mqtt_settings=mqtt_settings)
            
            while True:
                dimmer.update_dimmer(0)
                time.sleep(5)
                dimmer.update_dimmer(50)
                time.sleep(5)
                dimmer.update_dimmer(100)
                time.sleep(5)
        
        except (KeyboardInterrupt, SystemExit):
            print("Quitting.")      
        
        
        ~~~~
        
        If creating multiple homie devices, you can specify Homie to only use one MQTT connection. This can be an issue on devices with limited resources. For MQTT_SETTINGS add MQTT_SHARE_CLIENT: True.
        
Keywords: HOMIE,MQTT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
