plugwise / python-plugwise-usb

Plugwise USB python module for USB-stick

Plugwise USB python module

This module is the USB backend for the upcoming plugwise_usb component which we will maintain as co-code owners Home Assistant Core.

Our main usage for this module is supporting Home Assistant / home-assistant

Integration

Home-Assistant Integration

(maintained through Home-Assistant)

Home-Assistant custom_component (beta)

We do (also) maintain a custom_component, please note this is only intended for users helping us test new features (use at your own risk)

You can add our custom_component repository to HACS, do note that we do not intent for our beta custom_component to be included in the HACS repository.

See the plugwise_usb-beta repository for more info.

Development/patches

Like Home Assistant Core we use pre-commit and additionally run pre-commit.ci to automatically validate your commits and PRs.

If you want to create a PR please make sure you at least run scripts/setup.sh. This will ensure your environment is set up correctly before attempting to git commit. We sincerely and highly recommended also setting up local testing, see tests/README.md for more information and run scripts/setup_test.sh to prepare your environment.

Project support status

Notice at this time we are refactoring the module code to move towards a supporting way for the integration to become multiple components under an umbrella plugwise integration featuring multiple components.

Module providing interfacing with the Plugwise devices:

USB

• Stick

  • Circle+ / Stealth+
  • Circle / Stealth
  • Scan The devices listed below have NOT been tested and are therefore unknown for their correct operation
    • Sense
    • Switch

• Home-Assistant via

  • Native support for USB Plugwise products in HA Core (in progress)
  • HACS and custom_component Plugwise USB Beta (supporting all devices above)

License, origins and contributors

As per the origins we have retained the appropriate licensing and including the MIT-license for this project.

Origins (from newest to oldest):

• USB module and integration is supported by @brefra (Frank), ssupported and helped by @bouwew (Bouwe) and @CoMPaTech (Tom) where possible.
• 'All' available Plugwise support by @bouwew (Bouwe), @brefra (Frank) and @CoMPaTech (Tom)
• Upstreamed haanna/HA-core Anna, including all later products - 'Plugwise-Smile/Plugwise-HA/plugwise-beta` by @bouwew (Bouwe) & @CoMPaTech (Tom)
• Networked Plugwise Anna module with custom_module - haanna/anna-ha via https://github.com/laetificat (Kevin)
• USB-based stick module with custom_module - plugwise-stick/plugwise by @brefra (Frank)
• USB-plugwise module - plugwise by https://github.com/cyberjunky/python-plugwise (Ron) originally by https://github.com/aequitas/python-plugwise (Johan) (with reference only in license to Sven)
• Sensor for Plugwise Smile P1 integration - home-assistant-sensor-plugwise-smile-p1 by https://bitbucket.org/jvdschoot/home-assistant-sensor-plugwise-smile-p1 (Jeroen van der Schoot)

Thanks

On behalf all of us, big thanks to Plugwise and community members @riemers and @tane from HAshop for their support and obviously all our users and testers who dealt with our typos and challenges. Disclaimer, while we are communicating with Plugwise and they expressed their gratitude through their newsletter, we are not part of Plugwise as a company. We are just a bunch of guys anxious to get our (and your) Plugwise products working with Home Assistant.