Merge pull request #23 from bexelbie/docs-update

Update docs to discuss removing the example meter

wmbusmeters-ha-addon-edge/DOCS.md

@@ -14,8 +14,9 @@ comparison to installing any other community-driven Home Assistant add-on.
 1. Enable "Show in sidebar"
 1. Plug-in your radio receiver USB dongle
 1. Start the addon container
-1. In the logs you should see all the W-Mbus telegrams that wmbusmeter is able to receive. <br> _If you don't see anything, check the logs carefully. <br> If you configure it late evening or in the night, please note the radio modules often send telegrams less frequently than in typical working hours or don't send them at all. <br> If your antenna is in a distance to the radio module, try to locate it closer._
-1. You are ready to configure! Go to wmbusmeter in sidebar, make necessary configuration and save it.
+1. In the log tab in the add-on, not in the sidebar, you should see all the W-Mbus telegrams that wmbusmeter is able to receive. <br> _If you don't see anything, check the logs carefully. <br> If you configure it late evening or in the night, please note the radio modules often send telegrams less frequently than in typical working hours or don't send them at all. <br> If your antenna is in a distance to the radio module, try to locate it closer._
+1. You are ready to configure! Go to wmbusmeter in sidebar, add necessary configuration and save it. <br> _Once you configure your first meter, you will no longer see meter output in the log.  Check your MQTT server and make sure you set up the sensor, per the next step._
+   **Note:** A meter requires four values, name, driver, id, and key
 1. Finally, don't forget about adding the MQTT sensor into your Home Assistant.
 
 

wmbusmeters-ha-addon-edge/run.sh

@@ -5,13 +5,13 @@ RESET_CONF=$(bashio::config 'reset_config')
 
 if [ ! -f ${CONFIG_PATH} ]
 then
-    echo '{"data_path": "/config/wmbusmeters", "enable_mqtt_discovery": "false", "conf": {"loglevel": "normal", "device": "auto:t1", "donotprobe": "/dev/ttyAMA0", "logtelegrams": "false", "format": "json", "logfile": "/dev/stdout", "shell": "/wmbusmeters/mosquitto_pub.sh \"wmbusmeters/$METER_NAME\" \"$METER_JSON\""}, "meters": [{"name": "ExampleMeter", "driver": "amiplus", "id": "12345678", "key": "NOKEY"}], "mqtt": {}}' | jq . > ${CONFIG_PATH}
+    echo '{"data_path": "/config/wmbusmeters", "enable_mqtt_discovery": "false", "conf": {"loglevel": "normal", "device": "auto:t1", "donotprobe": "/dev/ttyAMA0", "logtelegrams": "false", "format": "json", "logfile": "/dev/stdout", "shell": "/wmbusmeters/mosquitto_pub.sh \"wmbusmeters/$METER_NAME\" \"$METER_JSON\""}, "meters": [], "mqtt": {}}' | jq . > ${CONFIG_PATH}
 fi
 
 if [ "${RESET_CONF}" = "yes" ]
 then
     bashio::log.info "RESET CONFIG selected - reseting add-on configuration to default ..."
-    echo '{"data_path": "/config/wmbusmeters", "enable_mqtt_discovery": "false", "conf": {"loglevel": "normal", "device": "auto:t1", "donotprobe": "/dev/ttyAMA0", "logtelegrams": "false", "format": "json", "logfile": "/dev/stdout", "shell": "/wmbusmeters/mosquitto_pub.sh \"wmbusmeters/$METER_NAME\" \"$METER_JSON\""}, "meters": [{"name": "ExampleMeter", "driver": "amiplus", "id": "12345678", "key": "NOKEY"}], "mqtt": {}}' | jq . > ${CONFIG_PATH}
+    echo '{"data_path": "/config/wmbusmeters", "enable_mqtt_discovery": "false", "conf": {"loglevel": "normal", "device": "auto:t1", "donotprobe": "/dev/ttyAMA0", "logtelegrams": "false", "format": "json", "logfile": "/dev/stdout", "shell": "/wmbusmeters/mosquitto_pub.sh \"wmbusmeters/$METER_NAME\" \"$METER_JSON\""}, "meters": [], "mqtt": {}}' | jq . > ${CONFIG_PATH}
     bashio::addon.option "reset_config" "no"
     bashio::addon.restart
 fi