This is an Arduino Sketch for the ESP32 companion of the ArduMower.
It provides the same Bluetooth LE and HTTP connectivity as the esp32_ble Sketch from the Sunray repository.
It also offers support for MQTT and Prometheus to ease the integration of ArduMower into home automation and monitoring setups.
ArduMower Modem - Firmware for the ESP32 connected as Modem to an ArduMower Copyright (c) 2022 Tim Otto
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Flashing the firmware onto the ESP32 for the first time requires some effort. Subsequent updates can be installed comfortably using the web interface of the Modem.
Use the modem_install Arduino Sketch from the util folder to install the latest release binary on your ESP32.
This Arduino Sketch requires nothing but a vanilla Arduino setup with the ESP32 package installed.
No additional libraries are required.
Download the source code of the latest release and use the Arduino IDE to compile and flash it onto the ESP32 using the Board ESP32 Dev Module and Partition Scheme Minimal SPIFFS. You will need the Arduino libraries listed in the Dependencies section below to compile the source code.
Once the firmware is running it will start a WiFi access point called ArduMower Modem with the password ArduMower Modem. Connect to that access point to access the Modem's web interface at http://192.168.4.1/. From there you are able to configure your WiFi credentials, Bluetooth security settings and everything else.
The primary feature of the firmware is the same as the esp32_ble Arduino Sketch from the Sunray repository. But there's more.
The ArduMower Modem supports MQTT for status reporting and control. It has support for HomeAssistant Autodiscovery as a vacuum cleaner. This integrates nicely with Google Assistant, and I'm pretty sure with Alexa as well.
The Prometheus endpoint of the ArduMower Modem makes it easy to collect metrics about the ArduMower and the Modem.
The sketch is developed using Arduino 1.8.16 and the Arduino core for the ESP32 1.0.6. All automation is orchestrated by a Taskfile. Building the web interface requires Node JS. The tools to package the web interface and to run the validation tests require Go.
Most libraries are available via the Arduino Library Manager:
Two libraries need to be installed manually:
The original versions from me-no-dev work great as long as load and throughput are low. The AsyncTCP fork from OttoWinter and ESPAsyncWebServer fork from lorol were already almost stable. Still, both required a small fix, so I forked them again until I have my commits merged upsream.
Several tasks defined in Taskfile.yml allow integration with an arbitrary IDE or just the command line by using the Arduino CLI.
My ArduMower is my only lawn mower. It saved me countless hours of manual labor which I was able to spend tinkering with this source code and other hobbies.
I am very grateful to the ArduMower community for building an awesome hardware and software platform and making it available to the public. With this contribution I want to become an active member of the ArduMower community.