diff --git a/source/_integrations/toon.markdown b/source/_integrations/toon.markdown index 616344fe3f6..d6da548a240 100644 --- a/source/_integrations/toon.markdown +++ b/source/_integrations/toon.markdown @@ -1,11 +1,12 @@ --- title: Toon -description: Instructions on how to integrate Toon within Home Assistant. +description: Instructions on how to integrate Eneco Toon/Engie Electrabel Boxx/Viesgo within Home Assistant. ha_category: - - Climate - Binary Sensor + - Climate - Energy - Sensor + - Switch ha_release: 0.56 ha_iot_class: Cloud Polling ha_config_flow: true @@ -14,15 +15,29 @@ ha_codeowners: ha_domain: toon --- -The `toon` integration platform can be used to control your Toon thermostat. This integration adds a climate device for your Toon thermostat, sensors for power and gas consumption, sensors for solar production and several binary sensors for things like boiler burner on/off, hot tap water and boiler health status. +The Toon integration platform can be used to control your Quby Toon thermostat, +which is currently being sold as: -For the `toon` integration to work, you'll need an active Toon subscription with Eneco and a Toon API developer account. +- Eneco Toon +- Engie Electrabel Boxx +- Viesgo Toon + +This integration adds a climate device for your Toon thermostat, some switches +allowing you to control the program and holiday mode of the thermostats as well. + +Sensors for energy, power and gas consumption, sensors for solar production and +several binary sensors for things like boiler burner on/off, hot tap water and +boiler health status. + +For the Toon integration to work, you'll need an active Toon subscription +and a Toon API developer account. There is currently support for the following device types within Home Assistant: -- Binary Sensor +- [Binary Sensor](#binary-sensor) - [Climate](#climate) -- Sensor +- [Sensor](#sensor) +- [Switch](#switch) ## Setting up a developer account @@ -32,7 +47,7 @@ In order to be able to use this component, you'll need to sign up for a free Too 2. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page and click on "Add a new App" button on the top right. 3. The "Add App" page shows a form with two fields: - **App Name**: Can be anything you like, for example, "Home Assistant" will just do. - - **Callback URL**: Fill in `localhost` in this field. + - **Callback URL**: `https://homeassistant.local:8123/auth/external/callback` (Please replace the first part of the URL with the internal URL of your Home Assistant frontend). 4. Click on "Create App" to complete the creation process. 5. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page again and click on the app that you've just created. 6. You need the codes now shown: "Consumer Key" and "Consumer Secret". @@ -58,26 +73,69 @@ client_secret: description: Toon API Consumer Secret. required: true type: string -scan_interval: - description: The rate in seconds at which Toon should be polled for new data. - required: false - type: integer - default: 300 {% endconfiguration %} +## Binary Sensor + +The Toon integration provides the following binary sensors: + +- Boiler Burner (only with OpenTherm) +- Boiler Heating* (only with OpenTherm) +- Boiler Module Connection* +- Boiler Preheating* (only with OpenTherm) +- Boiler Status (only with OpenTherm) +- Hot Tap Water (only with OpenTherm) +- OpenTherm Connection* (only with OpenTherm) +- Thermostat Program Override* + +Binary sensors marked with `*` are disabled by default, but can be enabled +from the UI, by clicking on the device and enabling the specific entity. + ## Climate -The `toon` climate platform allows you to interact with your Toon thermostat. +The Toon climate platform allows you to interact with your Toon thermostat. Home Assistant support the four Toon presets: `Comfort`, `Home`, `Away` and `Sleep`. It also supports setting the temperature manually. -## Services +Toon has no option to disable a preset. It will automatically unset +when values of the thermostat are changed. -### Service `update` +## Sensor -Updates ententies from Toon with fresh queried data. +The Toon integration provides the following sensors: -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ------------------------------------------- | -| `display` | Yes | The display you wish to fetch updates from. | +- Average Daily Energy Usage* +- Average Daily Gas Usage* (only with a "smart" gas meter) +- Average Gas Usage (only with a "smart" gas meter) +- Average Power Usage* +- Average Solar Power Production to Grid* (only with solar module) +- Boiler Modulation Level* (only with OpenTherm) +- Current Gas Usage (only with a "smart" gas meter) +- Current Power Usage +- Current Power Usage Covered By Solar (only with solar module) +- Current Solar Power Production (only with solar module) +- Electricity Meter Feed IN Tariff 1* +- Electricity Meter Feed IN Tariff 2* +- Electricity Meter Feed OUT Tariff 1* +- Electricity Meter Feed OUT Tariff 2* +- Energy Cost Today +- Energy Produced To Grid Today* (only with solar module) +- Energy Usage From Grid Today* (only with solar module) +- Energy Usage Today +- Gas Cost Today (only with a "smart" gas meter) +- Gas Meter (only with a "smart" gas meter) +- Gas Usage Today (only with a "smart" gas meter) +- Max Solar Power Production Today (only with solar module) +- Solar Energy Produced Today (only with solar module) +- Solar Power Production to Grid (only with solar module) + +Sensors marked with `*` are disabled by default, but can be enabled +from the UI, by clicking on the device and enabling the specific entity. + +## Switch + +The Toon integration provides the following switches: + +- Thermostat Holiday Mode +- Thermostat Program