Updated the documentation + corrected some typos

grott-current/DOCS.md

@@ -16,16 +16,17 @@ The add-on has a couple of options available. To get the add-on running:
 2. Have some patience and wait a couple of minutes.
 3. Check the add-on log output to see the result.
 
-## Add-on configuration:
+## Add-on configuration
+
 All options from grott are available as options in this add-on. They need to follow the naming convention of the environment variables. Eg:  
 
 ```yaml
-	gmode: proxy
-	gnomqtt: False
-	gmqttip: 127.0.0.1
-	gmqttport: 5288
-	gmqttauth: False
-	gmqtttopic: energy/grott
-	gmqttuser: user
-	gmqttpassword: password
+ gmode: proxy
+ gnomqtt: False
+ gmqttip: 127.0.0.1
+ gmqttport: 5288
+ gmqttauth: False
+ gmqtttopic: energy/grott
+ gmqttuser: user
+ gmqttpassword: password
 ```

grott-current/README.md

@@ -4,4 +4,6 @@ This addon allow you to run a local version of grott with the HA plugin and auto
 
 The data is fowarded to the growatt's server. The grott server decode them and send them to your HA instance.
 
-This addon is based on the 2.7.7 grott code and current grott_ha extension.
+This addon is based on the 2.7.7 [grott](https://github.com/johanmeijer/grott) code and current grott_ha extension.
+
+Stopping the add-on -> rebuilding -> restarting, install the latest grott HA plugin in the add-on.

grott-current/config.json

@@ -1,9 +1,9 @@
 {
 	"name": "Grott - HA extension - current",
-	"version": "0.0.3-current",
+	"version": "0.0.4-current",
 	"slug": "grott-current",
 	"description": "The Growatt inverter monitor - current HA plugin",
-	"url": "https://github.com/johanmeijer/grott",
+	"url": "https://github.com/egguy/grott-home-assistant-add-on/tree/main/grott-current",
 	"arch": [
 		"armhf",
 		"armv7",
@@ -20,10 +20,13 @@
 	"ports": {
 		"5279/tcp": 5279
 	},
+	"ports_description": {
+		"5279/tcp": "The port used by grott to receive the data of the logger"
+	},
 	"watchdog": "tcp://[HOST]:[PORT:5279]",
 	"options": {
 		"gmode": "proxy",
-		"gnomqtt": "False",
+		"gnomqtt": true,
 		"ginvtype": "default",
 		"ginvtypemap": "",
 		"mqtt": {}

grott-current/script.sh

@@ -41,7 +41,7 @@ if  bashio::config.has_value 'gifbucket'; then export gifbucket="$(bashio::confi
 if  bashio::config.has_value 'giftoken'; then export giftoken="$(bashio::config 'giftoken')"; fi
 if  bashio::config.has_value 'ginvtypemap'; then export ginvtypemap="$(bashio::config 'ginvtypemap')"; fi
 
-
+# pre configure the extension to use the integrated mosquitto broker
 export gextension="True"
 export gextname="grott_ha"
 export gextvar="{\"ha_mqtt_host\": \"$(bashio::services mqtt "host")\", \"ha_mqtt_port\": \"$(bashio::services mqtt "port")\", \"ha_mqtt_user\": \"$(bashio::services mqtt "username")\", \"ha_mqtt_password\": \"$(bashio::services mqtt "password")\"}"

grott-current/translations/en.yaml

@@ -1,11 +1,20 @@
 ---
 configuration:
+  gverbose:
+    name: Verbose mode
+    description: Enable the verbose mode. Useful for debugging
+  gminrecl:
+    name: Minimum record length
+    description: The minimum packet length to be treated
+  gnomqtt:
+    name: Disable grott MQTT
+    description: Prevent grott from sending MQTT Message, the add-on has it own MQTT messaging, so this configuration is not required.
   ginvtype:
     name: Inverter type
-    description: "For changing the layout used for decoding (ex: sph or tl3). Keep it on default if using inverter map."
+    description: "For changing the layout used for decoding (ex: sph, spf or tl3). Keep it on default if using inverter map."
   ginvtypemap:
     name: Inverter mapping
-    description: 'An inverter mapping in the form {"SERIAL": "type"} eg: for an SPH6000 with servial "NWO00415E3" : {"NWO00415E3": "sph"}'
+    description: 'An inverter mapping in the form {"SERIAL": "type"} e.g.: for an SPH6000 with serial "NWO00415E3" : {"NWO00415E3": "sph"}'
 
 network:
-  5279/TCP: The webserver port (Not used for Ingress)
+  5279/TCP: This is the port used by grott to receive datalogger information.