diff --git a/html/format.htm b/html/format.htm index 70988cc..52cad36 100644 --- a/html/format.htm +++ b/html/format.htm @@ -101,7 +101,8 @@ { "id": "iSpindle-Post", "format": "%7B%20%22name%22%20%3A%20%22%24%7Bmdns%7D%22%2C%20%22ID%22%3A%20%22%24%7Bid%7D%22%2C%20%22token%22%20%3A%20%22%24%7Btoken%7D%22%2C%20%22interval%22%3A%20%24%7Bsleep-interval%7D%2C%20%22temperature%22%3A%20%24%7Btemp%7D%2C%20%22temp_units%22%3A%20%22%24%7Btemp-unit%7D%22%2C%20%22gravity%22%3A%20%24%7Bgravity%7D%2C%20%22angle%22%3A%20%24%7Bangle%7D%2C%20%22battery%22%3A%20%24%7Bbattery%7D%2C%20%22RSSI%22%3A%20%24%7Brssi%7D%7D" }, { "id": "BrewFatherCustom-Post", "format": "%7B%20%20%20%22name%22%3A%20%22%24%7Bmdns%7D%22%2C%20%20%20%22temp%22%3A%20%24%7Btemp%7D%2C%20%20%20%22aux_temp%22%3A%200%2C%20%20%20%22ext_temp%22%3A%200%2C%20%20%20%22temp_unit%22%3A%20%22%24%7Btemp-unit%7D%22%2C%20%20%20%22gravity%22%3A%20%24%7Bgravity%7D%2C%20%20%20%22gravity_unit%22%3A%20%22%24%7Bgravity-unit%7D%22%2C%20%20%20%22pressure%22%3A%200%2C%20%20%20%22pressure_unit%22%3A%20%22PSI%22%2C%20%20%20%22ph%22%3A%200%2C%20%20%20%22bpm%22%3A%200%2C%20%20%20%22comment%22%3A%20%22%22%2C%20%20%20%22beer%22%3A%20%22%22%2C%20%20%20%22battery%22%3A%20%24%7Bbattery%7D%7D" }, { "id": "iSpindle-Mqtt", "format": "ispindel%2F%24%7Bmdns%7D%2Ftilt%3A%24%7Bangle%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Ftemperature%3A%24%7Btemp%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Ftemp_units%3A%24%7Btemp-unit%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Fbattery%3A%24%7Bbattery%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Fgravity%3A%24%7Bgravity%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Finterval%3A%24%7Bsleep-interval%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2FRSSI%3A%24%7Brssi%7D%7C" }, - { "id": "HomeAssistant-Mqtt", "format": "gravmon%2F%24%7Bmdns%7D%2Ftilt%3A%24%7Bangle%7D%7C%0Agravmon%2F%24%7Bmdns%7D%2Ftemperature%3A%24%7Btemp%7D%7C%0Agravmon%2F%24%7Bmdns%7D%2Ftemp_units%3A%24%7Btemp-unit%7D%7C" }, + { "id": "HomeAssistant-Mqtt", "format": "gravmon%2F%24%7Bmdns%7D%2Fgravity%3A%24%7Bgravity%7D%7C%0Agravmon%2F%24%7Bmdns%7D%2Frssi%3A%24%7Brssi%7D%7C%0Agravmon%2F%24%7Bmdns%7D%2Fbattery%3A%24%7Bbattery%7D%7C" }, + { "id": "HomeAssistant-Mqtt2", "format": "homeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_gravity%2Fstate%3A%24%7Bgravity%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_gravity%2Fconfig%3A%7B%22name%22%3A%20%22%24%7Bmdns%7D_gravity%22%2C%20%22state_topic%22%3A%20%22homeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_gravity%2Fstate%22%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_rssi%2Fstate%3A%24%7Brssi%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_rssi%2Fconfig%3A%7B%22name%22%3A%20%22%24%7Bmdns%7D_rssi%22%2C%20%22state_topic%22%3A%20%22homeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_rssi%2Fstate%22%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_battery%2Fstate%3A%24%7Bbattery%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_battery%2Fconfig%3A%7B%22name%22%3A%20%22%24%7Bmdns%7D_battery%22%2C%20%22state_topic%22%3A%20%22homeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_battery%2Fstate%22%7D%7C" }, { "id": "Brewblox-Mqtt", "format": "brewcast%2Fhistory%3A%7B%22key%22%3A%22%24%7Bmdns%7D%22%2C%22data%22%3A%7B%22Temperature%5BdegC%5D%22%3A%20%24%7Btemp-c%7D%2C%22Temperature%5BdegF%5D%22%3A%20%24%7Btemp-f%7D%2C%22Battery%5BV%5D%22%3A%24%7Bbattery%7D%2C%22Tilt%5Bdeg%5D%22%3A%24%7Bangle%7D%2C%22Rssi%5BdBm%5D%22%3A%24%7Brssi%7D%2C%22SG%22%3A%24%7Bgravity-sg%7D%2C%22Plato%22%3A%24%7Bgravity-plato%7D%7D%7D%7C" }, { "id": "UBIDots-Post", "format": "%7B%0A%20%20%20%22temperature%22%3A%20%24%7Btemp%7D%2C%0A%20%20%20%22gravity%22%3A%20%24%7Bgravity%7D%2C%0A%20%20%20%22angle%22%3A%20%24%7Bangle%7D%2C%0A%20%20%20%22battery%22%3A%20%24%7Bbattery%7D%2C%0A%20%20%20%22rssi%22%3A%20%24%7Brssi%7D%0A%7D" } ]; @@ -116,6 +117,7 @@ + diff --git a/html/format.min.htm b/html/format.min.htm index 48e7178..d32a79e 100644 --- a/html/format.min.htm +++ b/html/format.min.htm @@ -5,6 +5,7 @@ { "id": "iSpindle-Post", "format": "%7B%20%22name%22%20%3A%20%22%24%7Bmdns%7D%22%2C%20%22ID%22%3A%20%22%24%7Bid%7D%22%2C%20%22token%22%20%3A%20%22%24%7Btoken%7D%22%2C%20%22interval%22%3A%20%24%7Bsleep-interval%7D%2C%20%22temperature%22%3A%20%24%7Btemp%7D%2C%20%22temp_units%22%3A%20%22%24%7Btemp-unit%7D%22%2C%20%22gravity%22%3A%20%24%7Bgravity%7D%2C%20%22angle%22%3A%20%24%7Bangle%7D%2C%20%22battery%22%3A%20%24%7Bbattery%7D%2C%20%22RSSI%22%3A%20%24%7Brssi%7D%7D" }, { "id": "BrewFatherCustom-Post", "format": "%7B%20%20%20%22name%22%3A%20%22%24%7Bmdns%7D%22%2C%20%20%20%22temp%22%3A%20%24%7Btemp%7D%2C%20%20%20%22aux_temp%22%3A%200%2C%20%20%20%22ext_temp%22%3A%200%2C%20%20%20%22temp_unit%22%3A%20%22%24%7Btemp-unit%7D%22%2C%20%20%20%22gravity%22%3A%20%24%7Bgravity%7D%2C%20%20%20%22gravity_unit%22%3A%20%22%24%7Bgravity-unit%7D%22%2C%20%20%20%22pressure%22%3A%200%2C%20%20%20%22pressure_unit%22%3A%20%22PSI%22%2C%20%20%20%22ph%22%3A%200%2C%20%20%20%22bpm%22%3A%200%2C%20%20%20%22comment%22%3A%20%22%22%2C%20%20%20%22beer%22%3A%20%22%22%2C%20%20%20%22battery%22%3A%20%24%7Bbattery%7D%7D" }, { "id": "iSpindle-Mqtt", "format": "ispindel%2F%24%7Bmdns%7D%2Ftilt%3A%24%7Bangle%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Ftemperature%3A%24%7Btemp%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Ftemp_units%3A%24%7Btemp-unit%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Fbattery%3A%24%7Bbattery%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Fgravity%3A%24%7Bgravity%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2Finterval%3A%24%7Bsleep-interval%7D%7C%0Aispindel%2F%24%7Bmdns%7D%2FRSSI%3A%24%7Brssi%7D%7C" }, - { "id": "HomeAssistant-Mqtt", "format": "gravmon%2F%24%7Bmdns%7D%2Ftilt%3A%24%7Bangle%7D%7C%0Agravmon%2F%24%7Bmdns%7D%2Ftemperature%3A%24%7Btemp%7D%7C%0Agravmon%2F%24%7Bmdns%7D%2Ftemp_units%3A%24%7Btemp-unit%7D%7C" }, + { "id": "HomeAssistant-Mqtt", "format": "gravmon%2F%24%7Bmdns%7D%2Fgravity%3A%24%7Bgravity%7D%7C%0Agravmon%2F%24%7Bmdns%7D%2Frssi%3A%24%7Brssi%7D%7C%0Agravmon%2F%24%7Bmdns%7D%2Fbattery%3A%24%7Bbattery%7D%7C" }, + { "id": "HomeAssistant-Mqtt2", "format": "homeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_gravity%2Fstate%3A%24%7Bgravity%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_gravity%2Fconfig%3A%7B%22name%22%3A%20%22%24%7Bmdns%7D_gravity%22%2C%20%22state_topic%22%3A%20%22homeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_gravity%2Fstate%22%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_rssi%2Fstate%3A%24%7Brssi%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_rssi%2Fconfig%3A%7B%22name%22%3A%20%22%24%7Bmdns%7D_rssi%22%2C%20%22state_topic%22%3A%20%22homeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_rssi%2Fstate%22%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_battery%2Fstate%3A%24%7Bbattery%7D%7C%0Ahomeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_battery%2Fconfig%3A%7B%22name%22%3A%20%22%24%7Bmdns%7D_battery%22%2C%20%22state_topic%22%3A%20%22homeassistant%2Fsensor%2Fgravmon_%24%7Bid%7D_battery%2Fstate%22%7D%7C" }, { "id": "Brewblox-Mqtt", "format": "brewcast%2Fhistory%3A%7B%22key%22%3A%22%24%7Bmdns%7D%22%2C%22data%22%3A%7B%22Temperature%5BdegC%5D%22%3A%20%24%7Btemp-c%7D%2C%22Temperature%5BdegF%5D%22%3A%20%24%7Btemp-f%7D%2C%22Battery%5BV%5D%22%3A%24%7Bbattery%7D%2C%22Tilt%5Bdeg%5D%22%3A%24%7Bangle%7D%2C%22Rssi%5BdBm%5D%22%3A%24%7Brssi%7D%2C%22SG%22%3A%24%7Bgravity-sg%7D%2C%22Plato%22%3A%24%7Bgravity-plato%7D%7D%7D%7C" }, - { "id": "UBIDots-Post", "format": "%7B%0A%20%20%20%22temperature%22%3A%20%24%7Btemp%7D%2C%0A%20%20%20%22gravity%22%3A%20%24%7Bgravity%7D%2C%0A%20%20%20%22angle%22%3A%20%24%7Bangle%7D%2C%0A%20%20%20%22battery%22%3A%20%24%7Bbattery%7D%2C%0A%20%20%20%22rssi%22%3A%20%24%7Brssi%7D%0A%7D" } ];

(C) Copyright 2021-22 Magnus Persson
\ No newline at end of file + { "id": "UBIDots-Post", "format": "%7B%0A%20%20%20%22temperature%22%3A%20%24%7Btemp%7D%2C%0A%20%20%20%22gravity%22%3A%20%24%7Bgravity%7D%2C%0A%20%20%20%22angle%22%3A%20%24%7Bangle%7D%2C%0A%20%20%20%22battery%22%3A%20%24%7Bbattery%7D%2C%0A%20%20%20%22rssi%22%3A%20%24%7Brssi%7D%0A%7D" } ];

(C) Copyright 2021-22 Magnus Persson
\ No newline at end of file diff --git a/src_docs/source/services.rst b/src_docs/source/services.rst index 5eec4a1..4caf28f 100644 --- a/src_docs/source/services.rst +++ b/src_docs/source/services.rst @@ -129,7 +129,7 @@ format template that can be used. For information on customizing the format see Home Assistant +++++++++++++++ -`HomeAssistant `_ is a platform for home automation and can collect sensor data +`HomeAssistant `_ is a platform for home automation and can collect sensor data from multiple devices. This setup uses the MQTT integration with home assistant to collect values from the device. @@ -139,31 +139,41 @@ device is named `gravmon2` :: + mqtt: sensor: - - platform: mqtt - name: "gravmon2_gravity" - state_topic: "gravmon/gravmon2/gravity" - - platform: mqtt - name: "gravmon2_battery" - state_topic: "gravmon/gravmon2/battery" - - platform: mqtt - name: "gravmon2_rssi" - state_topic: "gravmon/gravmon2/RSSI" - - platform: mqtt - name: "gravmon2_temp" - state_topic: "gravmon/gravmon2/temp" + - name: "Gravmon2-Gravity" + state_topic: "gravmon/gravmon2/gravity" + unique_id: gravmon2_grav + unit_of_measurement: "SG" + - name: "Gravmon2-RSSI" + state_topic: "gravmon/gravmon2/rssi" + unique_id: gravmon2_rssi + unit_of_measurement: "dBm" Enter the name of the MQTT server in Home Assistant in the URL. You might need to install that option first. This is the format needed to submit the data to the correct topics as needed above. You can add as -many sensors / topics as you want. +many sensors / topics as you want. It's also possible that you will need to create a user and supply the +username / password to be able to publish messages on a topic. :: gravmon/${mdns}/gravity:${gravity}| + gravmon/${mdns}/rssi:${rssi}| gravmon/${mdns}/battery:${battery}| - gravmon/${mdns}/RSSI:${rssi}| - gravmon/${mdns}/temp:${temp}| + + +It's also possible to allow home assistant to do autodisovery and automatically create the sensor. This format +template will create two sensors and update the values for them. + +:: + + homeassistant/sensor/gravmon_${id}_gravity/state:${gravity}| + homeassistant/sensor/gravmon_${id}_gravity/config:{"name": "${mdns}_gravity", "state_topic": "homeassistant/sensor/gravmon_${id}_gravity/state"}| + homeassistant/sensor/gravmon_${id}_rssi/state:${rssi}| + homeassistant/sensor/gravmon_${id}_rssi/config:{"name": "${mdns}_rssi", "state_topic": "homeassistant/sensor/gravmon_${id}_rssi/state"}| + homeassistant/sensor/gravmon_${id}_battery/state:${battery}| + homeassistant/sensor/gravmon_${id}_battery/config:{"name": "${mdns}_battery", "state_topic": "homeassistant/sensor/gravmon_${id}_battery/state"}| Brewer's Friend