Basic instructions

vermut · May 20, 2024 · 81b15f8 · 81b15f8
1 parent 8d726ce
commit 81b15f8
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,53 @@
 OpenMower integration for HomeAssistant
 ===
 
+Openmower is the DIY RTK GPS Smart Mowing Robot for Everyone! Based on the YardForce classic 500 lawn mover and fully open source. A custom built motherboard, a raspberry pi and a GPS module gets rid of the guide wire and makes software the key factor in the project.
 
-Usage
+[openmower.de](https://openmower.de/)
+
+This integration is based on MQTT messages from the openmower container that runs on the RPI. 
+
+It will give you full control over the mower. Buttons to start, stop, pause, create automations from etc. Statistics like battery load, motor temperature, location. GPS coordinates are integrated into the device tracker.
+
+Prerequisits
+===
+* A functional openmower (doh!)
+* A software version where MQTT is supported, currently only on the edge version.
+* Activated MQTT in openmower config (/boot/openmower/mover_config.txt)
+```
+export OM_MQTT_ENABLE="True"            # Enable or disable
+export OM_MQTT_HOSTNAME="10.2.3.4"      # IP or hostname of your HA
+export OM_MQTT_PORT="1883"              # Port, default 1883
+export OM_MQTT_USER="mqtt_om"           # MQTT user on your HA
+export OM_MQTT_PASSWORD="mqtt_om"       # MQTT password on your HA
+export OM_MQTT_TOPIC_PREFIX="openmower" # The prefix that all MQTT traffic from this mower should have. If you have multiple mowers this can be used to separate them.
+```
+* Home assistant with HACS
+* Mosquitto or similar MQTT broker.
+* A MQTT integration
+
+Installation
 ===
 
-* Install via HACS, by adding this repo as Custom Repository
-* Configure external MQTT in mower_config.txt
-* Add new integration "OpenMower"
-* Fill in your MQTT prefix and datum point location
+Install via HACS by adding https://github.com/vermut/ha_openmower.git as a Custom Repository. Refresh HACS, go to Openmower and download the integration.
+
+Add the integration in settings -> integrations. Here you fill in the details for your mower. The prefix you set in the config and the LON/LAT in the same config file.
+
+![alt text](image-1.png)
+
+Your mower should now turn up in Home assistant
+
+![alt text](image-2.png)
+
+![alt text](image.png)
+
+Troubleshooting
+===
+Verify that mqtt is active on the mower. 
+netstat -anp | grep 1883
+
+![alt text](image-4.png)
+
+Verify that messages actually reach HA. In the MQTT integration listen for topic # or openmower/# if your prefix is openmower.
+
+![alt text](image-3.png)
diff --git a/image-1.png b/image-1.png
diff --git a/image-2.png b/image-2.png
diff --git a/image-3.png b/image-3.png
diff --git a/image-4.png b/image-4.png
diff --git a/image.png b/image.png