%global _empty_manifest_terminate_build 0
Name: python-py-smart-gardena
Version: 1.3.7
Release: 1
Summary: This library aims to provide python way to communicate with gardena smart gateway and all smart gardena systems.
License: MIT
URL: https://github.com/grm/py-smart-gardena
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/58/56/abb3f0602748ff3f4d33d16ed0ae5ef76d0badd30fd83aaaa2c84c208197/py-smart-gardena-1.3.7.tar.gz
BuildArch: noarch
%description
# py-smart-gardena
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/py-smart-gardena)
[](https://travis-ci.org/py-smart-gardena/py-smart-gardena)
[](https://pyup.io/repos/github/py-smart-gardena/py-smart-gardena/)
Feel free to join the discord server : [](https://discord.gg/59sFjykS)
## Description
The **py-smart-gardena** library aims to provide python way to communicate with gardena smart systems and
all gardena smart equipment. Configuration of the equipement and inclusion has still
to be done using the Gardena application or website.
## Support
**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 :
Thx for your support !
## Requirements
* **Python 3.8+**
## Supported devices
For now, only few devices are supported. I may add new ones in the future :
* Gateway
* Smart Mower
* Smart water control
* Smart sensor
* Power plugs
* Smart Irrigation control
## Account creation in order to have access to Gardena API
Gardena requires the creation of an account and an application in order to use their API.
You can find how to create such an account and application here : Account and application creation
## Installation
```sh
$ pip install py-smart-gardena
```
## Usage
### Data model
The entrypoint of the library is the the SmartSytem class (in gardena.smart_system
package).
From there, you can get all locations from your account, and for each of these
locations, get the declared devices.
All communications are not done directly with the gateway. This library uses a websocket in order
to communicate with gardena systems in order to avoid throttling. There is only one connection to authenticate,
and two connections to revoke tokens, everything else is done through websockets.
### Authentication
You first need to get a client id (also called application key in the
API documentation) for your personal installation of gardena. To do
so, create an account here : https://developer.husqvarnagroup.cloud/
Then you need to create an application, add APIs (Authentication API
and GARDENA smart system API), and copy the application key as
explained here: https://developer.husqvarnagroup.cloud/docs/getting-started
The library manages the token for you then.
An exception is raised if authentication fails.
```python
from gardena.smart_system import SmartSystem
import pprint
smart_system = SmartSystem(client_id="client_id", client_secret="client_secret")
await smart_system.authenticate()
await smart_system.update_locations()
for location in smart_system.locations.values():
await smart_system.update_devices(location)
pprint.pprint(location)
for device in location.devices.values():
pprint.pprint(device)
await smart_system.start_ws(smart_system.locations['LOCATION_ID'])
```
Once authentication is successful, you need to gather locations and devices for the first time and then, you can create start the websocket in order to get updates automatically.
### Locations
Locations are automatically retrieved the first time from the API, and then the websocket is used to get updates.
Here is the list of the current available fields and methods :
```python
for location in smart_system.locations.values():
print("location : " + location.name + "(" + location.id + ")")
```
### Devices
Devices are automatically retrieved the first time from the API, and then the websocket is used to get updates. They are stored in each locations. Depending on the function type, you can have diffrents fields.
#### Mowers
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("MOWER"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"activity : {device.activity}")
print(f"operating_hours : {device.operating_hours}")
print(f"state : {device.state}")
print(f"last_error_code : {device.last_error_code}")
```
#### Power Socket
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("POWER_SOCKET"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"activity : {device.activity}")
print(f"state : {device.state}")
```
#### Sensor
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("SENSOR"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"ambient_temperature : {device.ambient_temperature}")
print(f"light_intensity : {device.light_intensity}")
print(f"soil_humidity : {device.soil_humidity}")
print(f"soil_temperature : {device.soil_temperature}")
```
#### Smart irrigation control
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("SMART_IRRIGATION_CONTROL"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"valve_set_id : {device.valve_set_id}")
print(f"valve_set_state : {device.valve_set_state}")
print(f"valve_set_last_error_code : {device.valve_set_last_error_code}")
for valve in device.valves.values():
print(f"name : {valve['name']}")
print(f"{valve['name']} - id : {valve['id']}")
print(f"{valve['name']} - activity : {valve['activity']}")
print(f"{valve['name']} - state : {valve['state']}")
print(f"{valve['name']} - last_error_code : {valve['last_error_code']}")
```
#### Smart water control
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("WATER_CONTROL"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"valve_set_id : {device.valve_set_id}")
print(f"valve_name : {device.valve_name}")
print(f"valve_id : {device.valve_id}")
print(f"valve_activity : {device.valve_activity}")
print(f"valve_state : {device.valve_state}")
```
### Using websocket
Once the websocket has been started, everything is managed and the devices are
automatically updated once their state change.
In order for your to be alerted of such a change, you need to add a callback to the
device.
This callback will be called each time the device state changed :
```python
def my_callback(device):
print(f"The device {device.name} has been updated !")
device.add_callback(my_callback)
```
## Development environment
To install the dev environment, you just have to do, in the source code directory :
```sh
$ pip install -e .[dev]
```
%package -n python3-py-smart-gardena
Summary: This library aims to provide python way to communicate with gardena smart gateway and all smart gardena systems.
Provides: python-py-smart-gardena
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-py-smart-gardena
# py-smart-gardena
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/py-smart-gardena)
[](https://travis-ci.org/py-smart-gardena/py-smart-gardena)
[](https://pyup.io/repos/github/py-smart-gardena/py-smart-gardena/)
Feel free to join the discord server : [](https://discord.gg/59sFjykS)
## Description
The **py-smart-gardena** library aims to provide python way to communicate with gardena smart systems and
all gardena smart equipment. Configuration of the equipement and inclusion has still
to be done using the Gardena application or website.
## Support
**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 :
Thx for your support !
## Requirements
* **Python 3.8+**
## Supported devices
For now, only few devices are supported. I may add new ones in the future :
* Gateway
* Smart Mower
* Smart water control
* Smart sensor
* Power plugs
* Smart Irrigation control
## Account creation in order to have access to Gardena API
Gardena requires the creation of an account and an application in order to use their API.
You can find how to create such an account and application here : Account and application creation
## Installation
```sh
$ pip install py-smart-gardena
```
## Usage
### Data model
The entrypoint of the library is the the SmartSytem class (in gardena.smart_system
package).
From there, you can get all locations from your account, and for each of these
locations, get the declared devices.
All communications are not done directly with the gateway. This library uses a websocket in order
to communicate with gardena systems in order to avoid throttling. There is only one connection to authenticate,
and two connections to revoke tokens, everything else is done through websockets.
### Authentication
You first need to get a client id (also called application key in the
API documentation) for your personal installation of gardena. To do
so, create an account here : https://developer.husqvarnagroup.cloud/
Then you need to create an application, add APIs (Authentication API
and GARDENA smart system API), and copy the application key as
explained here: https://developer.husqvarnagroup.cloud/docs/getting-started
The library manages the token for you then.
An exception is raised if authentication fails.
```python
from gardena.smart_system import SmartSystem
import pprint
smart_system = SmartSystem(client_id="client_id", client_secret="client_secret")
await smart_system.authenticate()
await smart_system.update_locations()
for location in smart_system.locations.values():
await smart_system.update_devices(location)
pprint.pprint(location)
for device in location.devices.values():
pprint.pprint(device)
await smart_system.start_ws(smart_system.locations['LOCATION_ID'])
```
Once authentication is successful, you need to gather locations and devices for the first time and then, you can create start the websocket in order to get updates automatically.
### Locations
Locations are automatically retrieved the first time from the API, and then the websocket is used to get updates.
Here is the list of the current available fields and methods :
```python
for location in smart_system.locations.values():
print("location : " + location.name + "(" + location.id + ")")
```
### Devices
Devices are automatically retrieved the first time from the API, and then the websocket is used to get updates. They are stored in each locations. Depending on the function type, you can have diffrents fields.
#### Mowers
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("MOWER"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"activity : {device.activity}")
print(f"operating_hours : {device.operating_hours}")
print(f"state : {device.state}")
print(f"last_error_code : {device.last_error_code}")
```
#### Power Socket
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("POWER_SOCKET"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"activity : {device.activity}")
print(f"state : {device.state}")
```
#### Sensor
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("SENSOR"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"ambient_temperature : {device.ambient_temperature}")
print(f"light_intensity : {device.light_intensity}")
print(f"soil_humidity : {device.soil_humidity}")
print(f"soil_temperature : {device.soil_temperature}")
```
#### Smart irrigation control
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("SMART_IRRIGATION_CONTROL"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"valve_set_id : {device.valve_set_id}")
print(f"valve_set_state : {device.valve_set_state}")
print(f"valve_set_last_error_code : {device.valve_set_last_error_code}")
for valve in device.valves.values():
print(f"name : {valve['name']}")
print(f"{valve['name']} - id : {valve['id']}")
print(f"{valve['name']} - activity : {valve['activity']}")
print(f"{valve['name']} - state : {valve['state']}")
print(f"{valve['name']} - last_error_code : {valve['last_error_code']}")
```
#### Smart water control
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("WATER_CONTROL"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"valve_set_id : {device.valve_set_id}")
print(f"valve_name : {device.valve_name}")
print(f"valve_id : {device.valve_id}")
print(f"valve_activity : {device.valve_activity}")
print(f"valve_state : {device.valve_state}")
```
### Using websocket
Once the websocket has been started, everything is managed and the devices are
automatically updated once their state change.
In order for your to be alerted of such a change, you need to add a callback to the
device.
This callback will be called each time the device state changed :
```python
def my_callback(device):
print(f"The device {device.name} has been updated !")
device.add_callback(my_callback)
```
## Development environment
To install the dev environment, you just have to do, in the source code directory :
```sh
$ pip install -e .[dev]
```
%package help
Summary: Development documents and examples for py-smart-gardena
Provides: python3-py-smart-gardena-doc
%description help
# py-smart-gardena
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/py-smart-gardena)
[](https://travis-ci.org/py-smart-gardena/py-smart-gardena)
[](https://pyup.io/repos/github/py-smart-gardena/py-smart-gardena/)
Feel free to join the discord server : [](https://discord.gg/59sFjykS)
## Description
The **py-smart-gardena** library aims to provide python way to communicate with gardena smart systems and
all gardena smart equipment. Configuration of the equipement and inclusion has still
to be done using the Gardena application or website.
## Support
**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 :
Thx for your support !
## Requirements
* **Python 3.8+**
## Supported devices
For now, only few devices are supported. I may add new ones in the future :
* Gateway
* Smart Mower
* Smart water control
* Smart sensor
* Power plugs
* Smart Irrigation control
## Account creation in order to have access to Gardena API
Gardena requires the creation of an account and an application in order to use their API.
You can find how to create such an account and application here : Account and application creation
## Installation
```sh
$ pip install py-smart-gardena
```
## Usage
### Data model
The entrypoint of the library is the the SmartSytem class (in gardena.smart_system
package).
From there, you can get all locations from your account, and for each of these
locations, get the declared devices.
All communications are not done directly with the gateway. This library uses a websocket in order
to communicate with gardena systems in order to avoid throttling. There is only one connection to authenticate,
and two connections to revoke tokens, everything else is done through websockets.
### Authentication
You first need to get a client id (also called application key in the
API documentation) for your personal installation of gardena. To do
so, create an account here : https://developer.husqvarnagroup.cloud/
Then you need to create an application, add APIs (Authentication API
and GARDENA smart system API), and copy the application key as
explained here: https://developer.husqvarnagroup.cloud/docs/getting-started
The library manages the token for you then.
An exception is raised if authentication fails.
```python
from gardena.smart_system import SmartSystem
import pprint
smart_system = SmartSystem(client_id="client_id", client_secret="client_secret")
await smart_system.authenticate()
await smart_system.update_locations()
for location in smart_system.locations.values():
await smart_system.update_devices(location)
pprint.pprint(location)
for device in location.devices.values():
pprint.pprint(device)
await smart_system.start_ws(smart_system.locations['LOCATION_ID'])
```
Once authentication is successful, you need to gather locations and devices for the first time and then, you can create start the websocket in order to get updates automatically.
### Locations
Locations are automatically retrieved the first time from the API, and then the websocket is used to get updates.
Here is the list of the current available fields and methods :
```python
for location in smart_system.locations.values():
print("location : " + location.name + "(" + location.id + ")")
```
### Devices
Devices are automatically retrieved the first time from the API, and then the websocket is used to get updates. They are stored in each locations. Depending on the function type, you can have diffrents fields.
#### Mowers
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("MOWER"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"activity : {device.activity}")
print(f"operating_hours : {device.operating_hours}")
print(f"state : {device.state}")
print(f"last_error_code : {device.last_error_code}")
```
#### Power Socket
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("POWER_SOCKET"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"activity : {device.activity}")
print(f"state : {device.state}")
```
#### Sensor
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("SENSOR"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"ambient_temperature : {device.ambient_temperature}")
print(f"light_intensity : {device.light_intensity}")
print(f"soil_humidity : {device.soil_humidity}")
print(f"soil_temperature : {device.soil_temperature}")
```
#### Smart irrigation control
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("SMART_IRRIGATION_CONTROL"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"valve_set_id : {device.valve_set_id}")
print(f"valve_set_state : {device.valve_set_state}")
print(f"valve_set_last_error_code : {device.valve_set_last_error_code}")
for valve in device.valves.values():
print(f"name : {valve['name']}")
print(f"{valve['name']} - id : {valve['id']}")
print(f"{valve['name']} - activity : {valve['activity']}")
print(f"{valve['name']} - state : {valve['state']}")
print(f"{valve['name']} - last_error_code : {valve['last_error_code']}")
```
#### Smart water control
```python
for device in smart_system.locations["LOCATION_ID"].find_device_by_type("WATER_CONTROL"):
print(f"name : {device.name}")
print(f"id : {device.id}")
print(f"type : {device.type}")
print(f"model_type : {device.model_type}")
print(f"battery_level : {device.battery_level}")
print(f"battery_state : {device.battery_state}")
print(f"rf_link_level : {device.rf_link_level}")
print(f"rf_link_state : {device.rf_link_state}")
print(f"serial : {device.serial}")
print(f"valve_set_id : {device.valve_set_id}")
print(f"valve_name : {device.valve_name}")
print(f"valve_id : {device.valve_id}")
print(f"valve_activity : {device.valve_activity}")
print(f"valve_state : {device.valve_state}")
```
### Using websocket
Once the websocket has been started, everything is managed and the devices are
automatically updated once their state change.
In order for your to be alerted of such a change, you need to add a callback to the
device.
This callback will be called each time the device state changed :
```python
def my_callback(device):
print(f"The device {device.name} has been updated !")
device.add_callback(my_callback)
```
## Development environment
To install the dev environment, you just have to do, in the source code directory :
```sh
$ pip install -e .[dev]
```
%prep
%autosetup -n py-smart-gardena-1.3.7
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-py-smart-gardena -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon May 15 2023 Python_Bot - 1.3.7-1
- Package Spec generated