Skip to main content

devolo PLC devices in Python

Project description

devolo PLC API

GitHub Workflow Status Code Climate maintainability Coverage Status

This project implements parts of the devolo PLC devices API in Python. Communication to the devices is formatted in protobuf and the IDLs were kindly provided by devolo. Nevertheless, we might miss updates to the IDLs. If you discover a breakage, please feel free to report an issue.

System requirements

Defining the system requirements with exact versions typically is difficult. But there is a tested environment:

  • Linux
  • Python 3.7.8
  • pip 20.0.2
  • httpx 0.14.2
  • protobuf 3.11.4
  • zeroconf 0.27.0

Other 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 5.4.3
  • pytest-asyncio 0.14.0
  • pytest-mock 3.2.0
  • asynctest 0.13.0

Versioning

In our versioning we follow Semantic Versioning.

Installing for usage

The Python Package Index takes care for you. Just use pip.

pip install devolo-plc-api

Installing for development

First, you need to get the sources.

git clone git@github.com:2Fake/devolo_plc_api.git

Then you need to take care of the requirements.

cd devolo_plc_api
python setup.py install

If you want to run out tests, change to the tests directory and start pytest via setup.py.

python setup.py test

Usage

All features we currently support are shown in our example.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

devolo_plc_api-0.1.0.tar.gz (16.3 kB view hashes)

Uploaded Source

Built Distribution

devolo_plc_api-0.1.0-py3-none-any.whl (35.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page