MislavMandaric / home-assistant-vaillant-vsmart

Home Assistant custom component for Vaillant vSMART.
MIT License
61 stars 12 forks source link
home-assistant-component python vaillant

Vaillant vSMART

GitHub Release GitHub Activity License

pre-commit Black

hacs Project Maintenance

Community Forum

This component will set up the following platforms.

Platform Description
climate
  • Management of Vaillant thermostat
  • select
  • Selector showing currently selected schedule
  • sensor
  • Battery sensor for the thermostat
  • Boiler energy sensors
  • switch
  • On/off switch for schedules
  • On/off switch for HWB
  • water_heater
  • Management of Vaillant boiler
  • Installation

    HACS (recommended)

    1. Open HACS
    2. Search for "Vaillant vSMART"
      1. If it doesn't exist yet, you first need to add https://github.com/MislavMandaric/home-assistant-vaillant-vsmart as custom repository
    3. Click "Install this repository in HACS"
    4. Restart Home Assistant
    5. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Vaillant vSMART"

    Manual

    1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml)
    2. If you do not have a custom_components directory (folder) there, you need to create it
    3. In the custom_components directory (folder) create a new folder called vaillant_vsmart
    4. Download all the files from the custom_components/vaillant_vsmart/ directory (folder) in this repository
    5. Place the files you downloaded in the new directory (folder) you created
    6. Restart Home Assistant
    7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Vaillant vSMART"

    Configuration is done in the UI

    Check out the community page. You can find out how to extract client ID and client secret there.

    For Vaillant Vsmart

    For MiGo

    Contributions are welcome!

    If you want to contribute to this please read the Contribution guidelines

    Credits

    This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

    Code template was mainly taken from @Ludeeus's integration_blueprint template

    This integration is a complete rewrite of @pjmaenh's original Vaillant integration.

    Thanks to @philippelt, @jabesq, @samueldumont, @jabesq, @pjmaenh and @superbunika for providing many details of the underlying API, which this component uses.