Package: devolo-home-control-api
devolo Home Control APIThis project implements parts of the devolo Home Control API in Python. It is based on reverse engineering and therefore may fail with any new devolo update. If you discover a breakage, please feel free toreport an issue.System requirementsDefining the system requirements with exact versions typically is difficult. But there is a tested environment:LinuxPython 3.7.12pip 22.0.1requests 2.27.1websocket_client 1.3.1zeroconf 0.38.4Other versions and even other operating systems might work. Feel free to tell us about your experience. If you want to run our unit tests, you also need:pytest 7.0.1pytest-mock 3.7.0VersioningIn our versioning we followSemantic Versioning.Installing for usageThe Python Package Index takes care for you. Just use pip.pipinstalldevolo-home-control-apiInstalling for developmentFirst, you need to get the sources.gitclonegit@github.com:2Fake/devolo_home_control_api.gitThen you need to take care of the requirements.cddevolo_home_control_api
pythonsetup.pyinstallIf you want to run out tests, install the extra requirements and start pytest.pipinstall-e.[test]pytestQuick startTo see that basic functionality, please look at oursmall example. For this example, a working Home Control Central Unit must be attached to your my devolo account. After entering your my devolo username and password, simply run it:python3example.pyYou will see changes to any BinarySwitch device (e.g. state or consumption) reported to your console. If the executing device is in the same LAN as the Home Control Central Unit, it will be discovered via Zeroconf. In this case, data will be collected from the Central Unit directly; otherwise data will be collected via cloud from my devolo.Connecting to my devoloIf you do not know your gateway ID, you can ask my devolo. For now, no other functionality is implemented, that you would need to access directly. If you discover other use cases, feel free to file a feature request.mydevolo=Mydevolo.get_instance()mydevolo.user="username"mydevolo.password="password"forgateway_idinmydevolo.get_gateway_ids():print(gateway_id)Collecting Home Control dataThere are two ways of getting data:Let the websocket push data into your object, but still poll the objectSubscribe to the publisher and let it push (preferred)Using websocketsWhen using websocket events, messages will keep the object up to date. Nevertheless, no further action is triggered. So you have to ask yourself. The following example will list the current state of all binary switches. If the state changes, you will not notice unless you ask again.homecontrol=HomeControl(gateway_id=gateway_id,mydevolo_instance=mydevolo)forbinary_switchinmprm.binary_switch_devices:forstateinbinary_switch.binary_switch_property:print(f"State of{binary_switch.name}({binary_switch.binary_switch_property[state].element_uid}):{binary_switch.binary_switch_property[state].state}")To execute this example, you again need a configured instance of Mydevolo.Using subscriberThis preferred usage is shown in oursmall example. On every websocket event,update()will be called. That way you can react to changes right away.Further usageYou will find snippets discribing other use cases in ourwiki.