https://github.com/py-smart-gardena/hass-gardena-smart-system
Home Assistant custom component integration for Gardena Smart System
https://github.com/py-smart-gardena/hass-gardena-smart-system
gardena gardena-api gardena-smart-system home-assistant homeassistant
Last synced: 1 day ago
JSON representation
Home Assistant custom component integration for Gardena Smart System
- Host: GitHub
- URL: https://github.com/py-smart-gardena/hass-gardena-smart-system
- Owner: py-smart-gardena
- License: apache-2.0
- Created: 2020-05-30T16:29:43.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-03T18:49:38.000Z (28 days ago)
- Last Synced: 2025-04-03T19:36:49.164Z (28 days ago)
- Topics: gardena, gardena-api, gardena-smart-system, home-assistant, homeassistant
- Language: Python
- Size: 126 KB
- Stars: 222
- Watchers: 29
- Forks: 53
- Open Issues: 84
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/custom-components/hacs)
[](https://github.com/py-smart-gardena/hass-gardena-smart-system)
# Home Assistant integration for Gardena Smart System
Custom component to support Gardena Smart System devices.
**Table of Contents**
- [About](#about)
- [Installation](#installation)
- [Installation through HACS](#installation-through-hacs)
- [Manual installation](#manual-installation)
- [Configuration](#configuration)
- [Home Assistant](#home-assistant)
- [Gardena Application Key / Client ID and Application secret / client secret](#gardena-application-key--client-id-and-application-secret--client-secret)
- [Supported devices](#supported-devices)
- [Services](#services)
- [Smart Irrigation Control services](#smart-irrigation-control-services)
- [Smart Mower services](#smart-mower-services)
- [Smart System general](#smart-system-general)
- [Smart Power Socket services](#smart-power-socket-services)
- [Smart Sensor services](#smart-sensor-services)
- [Smart Water Control services](#smart-water-control-services)
- [Smart Irigation Control services](#smart-irigation-control-services)
- [Recipes](#recipes)
- [Development](#development)
- [Debugging](#debugging)
- [TODO](#todo)
> :warning: **Starting from version 1.0.0b5: You might probably have to uninstall and reinstall the integration as credentials requirements and method has changed. THERE IS A BREAKING CHANGE IN THE CONFIGURATION DUE TO AN UPDATE ON THE GARDENA API**
## About
This component is originally based on
https://github.com/grm/home-assistant/tree/feature/smart_gardena and
https://github.com/grm/py-smart-gardena
The integration / component has been changed quite a lot, mainly to
add support for config flow setup and Home Assistant devices. It has
also been cleaned up and some bugs have been fixed. Gardena devices
are now represented as Home Assistant devices, which have battery
level sensors where applicable.
**This project needs your support.**
Gardena equipments are expensive, and I need to buy them in order to add support.
If you find this library useful and want to help me support more devices (or if you
just want to reward me for my spent time), you are very welcome !
Your help is very much appreciated.
Here are the links if you want to show your support :
## Installation
Requires Home Assistant 0.115.0 or newer.
### Installation through HACS
If you have not yet installed HACS, go get it at https://hacs.xyz/ and walk through the installation and configuration.
Then find the Gardena Smart System integration in HACS and install it.
Restart Home Assistant!
Install the new integration through *Configuration -> Integrations* in HA (see below).
### Manual installation
Copy the sub-path `/hass-gardena-smart-system/custom_components/gardena_smart_system` of this repo into the path `/config/custom_components/gardena_smart_system` of your HA installation.
Alternatively use the following commands within an SSH shell into your HA system.
Do NOT try to execute these commands directly your PC on a mounted HA file system. The resulting symlink would be broken for the HA file system.
```
cd /config
git clone https://github.com/py-smart-gardena/hass-gardena-smart-system.git
# if folder custom_components does not yet exist:
mkdir custom_components
cd custom_components
ln -s ../hass-gardena-smart-system/custom_components/gardena_smart_system
```
## Configuration
### Home Assistant
Setup under Integrations in Home Assistant, search for "Gardena Smart
System". You need to enter your application key / client ID and your applications secret / client secret. See below for how to get your Gardena application key and secret.
After setting up the integration, you can adjust some options on the
integration panel for it.
Even though this integration can be installed and configured via the
Home Assistant GUI (uses config flow), you might have to restart Home
Assistant to get it working.
### Gardena Application Key / Client ID and Application secret / client secret
In order to use this integration you must get a client ID /
Application Key from Gardena/Husqvarna.
1. Go to https://developer.husqvarnagroup.cloud/
2. Create an account if needed, otherwise sign in with your Gardena
account.
3. After signing in you will be automatically redirected to "Your
applications". (Otherwise go to: https://developer.husqvarnagroup.cloud/applications)
4. Create an new application, name it for example "My Home Assistant"
(doesn't matter), leave the other fields empty.
5. Click on "+Connect new API" and connect the Authentication API and
the GARDENA smart system API.
6. Copy your Application Key and Application secret, this is what you need when you add the integration in Home Assistant.
## Supported devices
The following devices are supported :
* Gardena Smart Irrigation Control (as switch)
* Gardena Smart Mower (as lawn_mower)
* Gardena Smart Sensor (as sensor)
* Gardena Smart Water Control (as switch)
* Gardena Smart Power Socket (as switch)
## Services
### Smart Irrigation Control services
> [TODO: document services]
### Smart Mower services
`lawn_mower.start_mowing`
Start the mower using the Gardena API command START_DONT_OVERRIDE.
The mower resumes the schedule.
`lawn_mower.pause`
Stop the mower using the Gardena API command PARK_UNTIL_FURTHER_NOTICE.
The mower cancels the current operation, returns to charging station and ignores schedule.
`lawn_mower.dock`
Stop the mower using Gardena API command PARK_UNTIL_NEXT_TASK.
The mower cancels the current operation and returns to charging station. It will reactivate with the next schedule.
`gardena_smart_system.start_override`
Start the mower using the Gardena API command START_SECONDS_TO_OVERRIDE.
The mower starts immediately for the duration parameter of the action.
### Smart System general
`binary_sensor.gardena_smart_system_connection`
Checks if service is connected or disconnected
### Smart Power Socket services
> [TODO: document services]
### Smart Sensor services
`sensor.sensor_light_intensity`
Read the light intensity of a smart sensor. Only V1 of the Smart Sensor supports this.
`sensor.sensor_soil_humidity`
Read the soil humidity of a smart sensor. This can help automate your Water control / Irrigation Controller.
`sensor.sensor_soil_temperature`
Read the soil tempature.
`sensor.sensor_ambient_temperature`
Read the ambient tempature of a smart sensor.
`sensor.sensor_battery_level`
Read the battery level of a smart sensor.
### Smart Water Control services
> [TODO: document services]
### Smart Irigation Control services
`switch.irrigation_control_valve_X`
Open or close a valve to start watering . Irrigation control can have up to 6 valves and inherits the original name of each valve from the Gardena app. If a valve is not connected, the service for the specific valve is unavailable.
## Recipes
Some recips were made by the community.
You can find them [here](RECIPES.md).
## Development
### Debugging
To enable debug logging for this integration and related libraries you
can control this in your Home Assistant `configuration.yaml`
file. Example:
```
logger:
default: info
logs:
custom_components.gardena_smart_system: debug
custom_components.gardena_smart_system.mower : debug
custom_components.gardena_smart_system.sensor : debug
custom_components.gardena_smart_system.switch : debug
custom_components.gardena_smart_system.config_flow : debug
gardena: debug
gardena.smart_system: debug
websocket: debug
```
After a restart detailed log entries will appear in `/config/home-assistant.log`.
### TODO
* Do we need support for more than one location? Should we make it
possible to configure it?