Add ability for MQTT device tracker to map non-default topic payloads to zones/states (#27143)

* add ability for MQTT device tracker to map nondefault topic payloads to zones

* update new parameter name and add abbreviation

* support for payload_home, payload_not_home, and payload_custom

* use constants STATE_NOT_HOME and STATE_HOME as defaults

* reference state constants directly

* add empty dict as default for payload_custom

* change parameter name for custom mapping of payloads to non-home zones to be more descriptive

* removed 'payload_other_zones' per ballobs review

* remove abbreviation for 'payload_other_zones'

* add tests for feature
This commit is contained in:
Raman Gupta authored and Paulus Schoutsen committed 2019-10-17 17:51:27 -07:00
1 parent 489340160b
commit 4e25807b7d
3 files changed
+86 -4

No files matched your search

@@ -88,11 +88,13 @@ ABBREVIATIONS = {
"pl_cls": "payload_close",
"pl_disarm": "payload_disarm",
"pl_hi_spd": "payload_high_speed",
"pl_home": "payload_home",
"pl_lock": "payload_lock",
"pl_loc": "payload_locate",
"pl_lo_spd": "payload_low_speed",
"pl_med_spd": "payload_medium_speed",
"pl_not_avail": "payload_not_available",
"pl_not_home": "payload_not_home",
"pl_off": "payload_off",
"pl_off_spd": "payload_off_speed",
"pl_on": "payload_on",
@@ -5,16 +5,23 @@ import voluptuous as vol
from homeassistant.components import mqtt
from homeassistant.components.device_tracker import PLATFORM_SCHEMA
from homeassistant.const import CONF_DEVICES
from homeassistant.core import callback
import homeassistant.helpers.config_validation as cv
from homeassistant.const import CONF_DEVICES, STATE_NOT_HOME, STATE_HOME
from . import CONF_QOS
_LOGGER = logging.getLogger(__name__)
CONF_PAYLOAD_HOME = "payload_home"
CONF_PAYLOAD_NOT_HOME = "payload_not_home"
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(mqtt.SCHEMA_BASE).extend(
{vol.Required(CONF_DEVICES): {cv.string: mqtt.valid_subscribe_topic}}
{
vol.Required(CONF_DEVICES): {cv.string: mqtt.valid_subscribe_topic},
vol.Optional(CONF_PAYLOAD_HOME, default=STATE_HOME): cv.string,
vol.Optional(CONF_PAYLOAD_NOT_HOME, default=STATE_NOT_HOME): cv.string,
}
)
@@ -22,13 +29,24 @@ async def async_setup_scanner(hass, config, async_see, discovery_info=None):
"""Set up the MQTT tracker."""
devices = config[CONF_DEVICES]
qos = config[CONF_QOS]
payload_home = config[CONF_PAYLOAD_HOME]
payload_not_home = config[CONF_PAYLOAD_NOT_HOME]
for dev_id, topic in devices.items():
@callback
def async_message_received(msg, dev_id=dev_id):
"""Handle received MQTT message."""
hass.async_create_task(async_see(dev_id=dev_id, location_name=msg.payload))
if msg.payload == payload_home:
location_name = STATE_HOME
elif msg.payload == payload_not_home:
location_name = STATE_NOT_HOME
else:
location_name = msg.payload
hass.async_create_task(
async_see(dev_id=dev_id, location_name=location_name)
)
await mqtt.async_subscribe(hass, topic, async_message_received, qos)