First, the explained method including installing the script or parts of software in this repository comes with some modification instructions for your Gardena components. Be warned with the all-known words at first:
This small script is for simple communication between the Gardena Smart Garden Gateway and a MQTT broker of your desire - without any need of cloud infrastructure. It has been tested with the Gardena Smart Garden Gateway (Art. No. 190005). Required prequisions are rooting the Gateway and enabling the nngforward-service (see FAQ below). The Bluetooth powered devices are not covered through this solution.
Note that this piece of software is currently in an early state. We wanted to push anything as soon as possible to share it to all of you. Take care with us đź’š
There are two methods of installation:
-
Install the python script onto the gardena gateway, and have it communicate directly with MQTT on a remote computer.
-
Forward the LemonBeat communications to a remote host via socat, and run the python script there. This option has the advantage that you make minimal changes to the gardena gateway, and you are less constrained with regards to CPU power, memory and storage, which are all very tight on the gardena gateway.
-
Connect to the UART of the gateway and log in. Enable remote SSH access and make sure you have access, by adding your public SSH key to the gateway's /home.root/.ssh/authorized_keys file. See the FAQ [How do I root my Gardena Smart Gateway and prepare it for using the script] for details.
-
Python3 and most prerequisites are already present on the gateway, only the paho-mqtt is missing. So we need to install that. So we first need to install pip, the python package manager.
We just have enough free space to do this, but it barely fits.
user@workstation:~$ ssh root@gardena root@gardena:~#df -H /media/rfs/rw Filesystem Size Used Available Use% Mounted on ubi0:overlay 26.0M 2.8M 21.9M 11% /media/rfs/rw root@gardena:~# opkg install python3-pipHow is the diskspace usage now?
root@gardena:~#df -H /media/rfs/rw Filesystem Size Used Available Use% Mounted on ubi0:overlay 26.0M 21.8M 2.8M 88% /media/rfs/rw
Almost out of space...
-
Install paho-mqtt:
root@gardena:~# pip3 install paho-mqtt -
Download the scripts from github, and adjust the configuration:
root@gardena:~# wget https://github.com/andrexp/gardena-local-control/archive/refs/tags/2.0.0.1.tar.gz root@gardena:~# tar tar -xvf 2.0.0.1.tar.gz root@gardena:~# cd gardena-local-control-2.0.0.1 root@gardena:~# vi config.pyAdjust MQTT_BROKER_IP, MQTT_BROKER_PORT, MQTT_AUTHENTICATION, MQTT_BROKER_USER and MQTT_BROKER_PASSWORD to fit your configuration.
-
Test to see if everything works.
First, on the MQTT server, in my case a raspberry pi, start monitoring the GardenaLocalControl topic:
pi@raspberry:~$ mosquitto_sub -v -h 127.0.01 -p 1883 -t 'GardenaLocalControl/#Start the script directly on the gardena gateway:
root@gardena:~# python3 gardenalocalcontrol.pyIn the mosquitto listener, you should see the GardenaLocalControl come online:
GardenaLocalControl/State OnlineNow in the gardena app, refresh e.g. the battery or the soil moisture reading. You should see the message come through:
GardenaLocalControl/3034F8EE901298000004E279/command 7 GardenaLocalControl/3034F8EE901298000004E279/rf_link_quality 80If all is working, hit control-C to stop the script. Time to install.
-
Install your favourite flavour, I recommend install_service:
root@gardena:~# chmod 755 install_service root@gardena:~# ./install_serviceThe service is started at the end of the install script. You should see it come back online in MQTT.
-
Reboot the gateway to make sure the service starts up on boot.
-
Ensure our work is not erased on software upgrade:
echo "/opt" >> /etc/sysupgrade.conf echo "/home/root/.ssh/authorized_keys" >> /etc/sysupgrade.conf echo "/usr/lib/python3.11/site-packages" >> /etc/sysupgrade.conf echo "/etc/systemd/system/gardenalocalcontrol.service" >> /etc/sysupgrade.conf echo "/etc/systemd/system/multi-user.target.wants/gardenalocalcontrol.service" >> /etc/sysupgrade.conf -
Cleanup - remove the pip package manager:
root@gardena:~# opkg remove --autoremove python3-pip root@gardena:~#df -H /media/rfs/rw Filesystem Size Used Available Use% Mounted on ubi0:overlay 26.0M 10.7M 13.9M 43% /media/rfs/rwOkay, we managed to reclaim some space but we are still out 8 mb to install a 40 kb package... Perhaps a manual install is more prudent next time. But this will require adjustment of the install shell script to skip the dependency check.
Enable forwarding on the comms:
root@gardena:~# fw_setenv dev_debug_enable_nngforward 1
We have to mirror the communication ports onto the serving machine with:
socat UNIX-LISTEN:/tmp/lemonbeatd-event.ipc,fork,reuseaddr,unlink-early TCP:192.168.178.151:28152 &
socat UNIX-LISTEN:/tmp/lemonbeatd-command.ipc,fork,reuseaddr,unlink-early TCP:192.168.178.151:28153 &
Of course adjust the destination IP address (192.168.178.151) to fit your situation.
Keep in mind to check if the process is killed. In this case the communication to the gateway will be lost and no information can be gathered. So after a reboot you'll have to ssh into the gateway and restart the socat commands. Or install a script as a service to start those socat commands.
-
Check requirements:
Python3 Python-PIP3 -
Clone repository
git clone https://github.com/andrexp/gardena-local-control.git cd gardena-local-control -
Edit config.py Customize your the config.py file for your needs. Especially the MQTT broker address should be set. To find out how to get the location of GARDENA_NNG_FORWARD_PATH_EVT and GARDENA_NNG_FORWARD_PATH_CMD see FAQ below.
Then you have two options to install:
-
Install and execute
Simply use the "install"-script:sudo chmod +x install sudo ./installThis will copy the gardenalocalcontrol.py script to /opt/gardenalocalcontrol and executes instantly after
-
Install as service (OPTIONAL to 4.) Simply use the "install_service"-script:
sudo chmod +x install_service sudo ./install_serviceThis will also copy the gardenalocalcontrol.py script to /opt/gardenalocalcontrol but in addition a .service-File for systemd is created. This will install the script as service and make it start at boot automatically.
You have the following option to update GardenaLocalControl service:
Simply use the "update_service"-script:
sudo chmod +x update_service
sudo ./update_service
This will stop the service, copy all files and restart the gardenalocalcontrol.service.
The script subscribes to the interprocess communication of lemonbeatd (rf-component which does communication with the wireless devices as the Gardena Smart Sileno mowers) and the Gardena cloud/shadoway connector. If a message is received, the script tries to interpet any component of it. Because not all of the information to be gathered is known at this point all information are pushed to the MQTT broker as it is. Therefore the following format and topics are used:
GardenaLocalControl/<device_id>/<attribute> Value
device_id: Internal Device-ID of your Gardena device such as Smart Sileno mowers
attribute: Interpreted data from subscription as described above
Example output for status-codes. For further information about status- and fault-codes see FAQ:
GardenaLocalControl/012345678901234567890/status 1 # current status (e.g. if the id is a lawn mower, is mowing)
Example output for battery level:
GardenaLocalControl/012345678901234567890/battery_level 70 # 70% battery power
Example output for rf-signal-strength:
GardenaLocalControl/012345678901234567890/rf_link_quality 100 # best link quality
For comfort several commands are available to send via MQTT. The main job is done by the script. Simply put a command to MQTT Topic:
GardenaLocalControl/<device_id>/Command
in the following JSON format:
{
"command": <command_name>,
"payload": <payload_depending_on_command>
}
For the first step only basic commands are available for using it with a smart-home system as openHAB or Home-Assistant. More Commands e.g. for Gardena Smart Irrigation Control may follow later.
Start manual mowing with time period. According to app control the valid values are limited to 6 hours.
accepted payload: integer value for mowing time in seconds (in example: 1 hour)
Example:
GardenaLocalControl/012345678901234567890/Command
{
"command": "mower_timer",
"payload": 3600
}
Start mower with next schedule.
accepted payload: "true" (without quotes)
Example:
GardenaLocalControl/012345678901234567890/Command
{
"command": "start_schedule",
"payload": true
}
Park mower until next schedule task would be started
accepted payload: "true" (without quotes)
Example:
GardenaLocalControl/012345678901234567890/Command
{
"command": "park_until_next_task",
"payload": true
}
Park mower permanently
accepted payload: "true" (without quotes)
Example:
GardenaLocalControl/012345678901234567890/Command
{
"command": "park_until_further_notice",
"payload": true
}
Read the status of given deviceid through topic address. The answer of the command will be published to the event-queue. Many interesting information can be gathered. It may be useful to build a rule in an external smart home application like openHAB or HomeAssistant to call this function cyclic.
accepted payload: "true" (without quotes)
Example:
GardenaLocalControl/012345678901234567890/Command
{
"command": "read_status",
"payload": true
}
Supported devices: Gardena Smart Water Control
Start manual watering with time period in seconds. According to app control the valid values are limited to 90 minutes.
accepted payload: integer value for watering time in seconds (in example: 1 minute)
Example:
GardenaLocalControl/012345678901234567890/Command
{
"command": "watering_timer",
"payload": 60
}
Supported devices: Gardena Smart Water Control
Stop (manual) watering.
accepted payload: "true" (without quotes)
Example:
GardenaLocalControl/012345678901234567890/Command
{
"command": "watering_off",
"payload": true
}
With this command all left variations of commands can be sent. Especially new or not fully observed commands can be tested. More complex commands like settings or time schedules can also be used. See docs/control_telegram for more information and reversed engineered commands. Note: All bytecodes has to be decoded with Base64 first.
The payload of the command accepts following values:
| Command | Possible values |
|---|---|
| operation | read, write |
| gardenaCommand | all reverse engineered commands or observed topics such as "schedule_config" |
| varType | vi, vo (this seem to be a declaration of a variable Type "i" may stand for integer value, "o" for string value) |
| gardenaPayload | payload to send coded in Base64 |
Example (sends a schedule configuration for ONE schedule from 8:00am to 8:05am Monday-Sunday):
GardenaLocalControl/012345678901234567890/Command
{
"command": "raw",
"payload": "write,schedule_config,vo,AH8IAAUAAA=="
}
BE AWARE YOU WILL LOSING WARRANTY! ANY MODIFICATIONS WILL BE DONE AT YOUR OWN RISK!
-
Connect to the UART of the Board. You will find the pins and required settings in the official Gardena documentation, you will need a USB to UART-Adapter or a RaspberryPi to be able to connect your computer.
Make sure the UART you use is operating at 3.3V. Baud rate to use is 115200 8/N/1.
-
Use a terminal application such as PuTTy (on Windows) or screen (on Linux)
-
Connect power of the gateway
-
Wait until booting is finished and you see a login prompt, usually something like:
GARDENA-12affe12 login: -
Quickly type in "root" (without quotes)
-
You have successful gained root access
-
Put in your public SSH key using copy and paste:
root@gardena:~# echo "<YOUR-PUBLIC-KEY>" >> /home/root/.ssh/authorized_keys -
Prevent deletion of the key in case of a firmware upgrade by adding the authorized_keys to the exclude file:
echo "/home/root/.ssh/authorized_keys" >> /etc/sysupgrade.conf -
Enable SSH and reload the firewall:
root@gardena:~# fw_setenv dev_debug_allow_local_ssh 1 && systemctl restart firewall -
Test you can access via the network from your workstation:
user@workstation:~$ ssh root@gardena -
Reboot the gateway and test again:
root@gardena:~# reboot user@workstation:~$ ssh root@gardena -
Okay, all good, we have ssh access. We can now shut the gateway down again, close up the case and reinstall it where it came from.
-
Have fun! Some other notes:
The gardena gateway seems to be running Husqvarna's own version of OpenWRT, deduced from the usage of the opkg package manager. opkg is configured to use Husqvarna's own package repositories. Various handy packages are available.
You have to put your files into the file to exclude via firmware updates. See How do I determine the location of GARDENA_NNG_FORWARD_PATH_EVT and GARDENA_NNG_FORWARD_PATH_CMD
This files are used to create the pipe for accessing the interprocess communication. After enabling the
dev_debug_enable_nngforward
flag the gateway prepares the local access to the lemonbeatd communication. You have two options to install your script:
-
You install the script with root access onto your gateway directly. Be aware the files will be deleted in case of a firmware upgrade. To avoid that include your script directory into:
/etc/sysupgrade.confIt's recommended to add the following files/paths to this file:
/opt /home/root/.ssh/authorized_keys /usr/lib/python3.11/site-packagesIf you have installed gardena-local-control as a service add the following additionally:
/etc/systemd/system/gardenalocalcontrol.service /etc/systemd/system/multi-user.target.wants/gardenalocalcontrol.serviceTip: For this method you don't really need to enable the nngforward. The files mentioned in the default config.py are existent. This is only needed if you plan to install the script on a different machine in your network.
In addition keep in mind that the storage of the Gardena Smart Gateway is limited. There are only a few megabytes free. If you install all the dependencies and you want to have some logging on it you may run out of space. But the main advantage of this method is you don't need to care about networking problems. Why this is important? See next solution.
-
You install the script on another machine e.g. a RaspberryPi or any other SoC. If you do so you have to mirror the communication ports onto the serving machine with:
socat UNIX-LISTEN:/tmp/lemonbeatd-event.ipc,fork,reuseaddr,unlink-early TCP:192.168.178.151:28152 & socat UNIX-LISTEN:/tmp/lemonbeatd-command.ipc,fork,reuseaddr,unlink-early TCP:192.168.178.151:28153 &Keep in mind to check if the process is killed. In this case the communication to the gateway will be lost and no information can be gathered.
The simplest way to obatin your desired device_id is to observe the output of the GardenaLocalControl when controlling e.g. a mower or any other device through the App.
You can find status- and fault-codes within the following MQTT-topics:
GardenaLocalControl/<device_id>/status
GardenaLocalControl/<device_id>/last_error_code
Unfortunately this is a enumeration which is not fully discovered, yet. We started to reverse engineer the fault codes from the Garden Smart System App. You will find a small documentation with results included in docs/control_telegram
Of course!
- First, install MQTT-Binding
- Create a new MQTT Thing "Generic MQTT Thing"
- Go to the newly created MQTT Thing which we call "MQTT Things", click on "Channels"
- Create a new MQTT topic listener by clicking "Add Channel"
- The first example creates a listener to the "status" topic of a lawn mower. So we create a "Number" value.
- Click on "Configure channel" of the newly created MQTT Thing channel
- Fill in the "MQTT State Topic"-field as mentioned above
- Now we just need to add a existing create a new openHAB item
- In this example we create a "Number"-item
- We are finished. Note that the status is NULL as long as GardenaLocalControl transmits the first status value. This could take some time. Usually you can force send a status value by sending a command to the gateway.
- Second example: Create the command topic. We do exactly the same steps 3.-6. Note that we now want to have a "Text Value" instead of a "Number". Remember this at point 5. After creating the channel we fill in both: "MQTT Status Topic" and "MQTT Command Topic"
- Hit the check-box "Show advanced"
- Fill in the fields for "Incoming Value Transformations". By using JSONPATH we can extract the command from the transmitted JSON-string of the command topic message payload.
- Again create a new openHAB item as described in 8. We now choose "String" as type. For simple usage add a "Meta Data" to create command options.
- Insert all available commands so you can easily use them by clicking on items current value.
