Added suggestions

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

Hide file tree

Showing 9 changed files with 23 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -5,11 +5,13 @@ Openmower is the DIY RTK GPS Smart Mowing Robot for Everyone! Based on the YardF
 
 [openmower.de](https://openmower.de/)
 
+[Openmower on github](https://github.com/ClemensElflein/OpenMower)
+
 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
+Prerequisites
 ===
 * A functional openmower (doh!)
 * A software version where MQTT is supported, currently only on the edge version.
@@ -23,8 +25,14 @@ 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
+* Mosquitto or similar MQTT broker. Mosquitto is the easiest to install, you find it in the add-on store. 
+
+![alt text](docs/image-5.png)
+![alt text](docs/image-6.png)
+
+Once installed it will turn up in the normal integrations as MQTT.
+
+![alt text](docs/image-7.png)
 
 Installation
 ===
@@ -33,21 +41,24 @@ Install via HACS by adding https://github.com/vermut/ha_openmower.git as a Custo
 
 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)
+![alt text](docs/image-1.png)
 
 Your mower should now turn up in Home assistant
 
-![alt text](image-2.png)
+![alt text](docs/image-2.png)
 
-![alt text](image.png)
+![alt text](docs/image.png)
 
-Troubleshooting
-===
-Verify that mqtt is active on the mower. 
-netstat -anp | grep 1883
 
-![alt text](image-4.png)
 
+Troubleshooting
+===
+Verify that mqtt is active on the mower and check if xbot_moniroting is connected to homeassistant.
+```
+openmower@openmower:~ $ sudo netstat -pnt | grep 1883 | grep xbot_monitoring
+tcp        0      0 127.0.0.1:42818         127.0.0.1:1883          ESTABLISHED 911/xbot_monitoring
+tcp        0      0 <MOWER_IP>:43340     <HOMEASSISTANT_IP>:1883      ESTABLISHED 911/xbot_monitoring
+```
 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)
+![alt text](docs/image-3.png)
diff --git a/image-1.png → docs/image-1.png b/image-1.png → docs/image-1.png
diff --git a/image-2.png → docs/image-2.png b/image-2.png → docs/image-2.png
diff --git a/image-3.png → docs/image-3.png b/image-3.png → docs/image-3.png
diff --git a/image-4.png → docs/image-4.png b/image-4.png → docs/image-4.png
diff --git a/docs/image-5.png b/docs/image-5.png
diff --git a/docs/image-6.png b/docs/image-6.png
diff --git a/docs/image-7.png b/docs/image-7.png
diff --git a/image.png → docs/image.png b/image.png → docs/image.png