Rohan Kapoor
2bdbf6955d
* Migrate geofency over to the Webhook component * Return web.Response correctly * Fix test * Lint * Fix error that tests caught
162 lines
4.3 KiB
Python
162 lines
4.3 KiB
Python
"""
|
|
Support for Geofency.
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/geofency/
|
|
"""
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
from aiohttp import web
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.const import HTTP_UNPROCESSABLE_ENTITY, STATE_NOT_HOME, \
|
|
ATTR_LATITUDE, ATTR_LONGITUDE, CONF_WEBHOOK_ID, HTTP_OK
|
|
from homeassistant.helpers import config_entry_flow
|
|
from homeassistant.helpers.discovery import async_load_platform
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
|
from homeassistant.util import slugify
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DOMAIN = 'geofency'
|
|
DEPENDENCIES = ['webhook']
|
|
|
|
CONF_MOBILE_BEACONS = 'mobile_beacons'
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
vol.Optional(DOMAIN): vol.Schema({
|
|
vol.Optional(CONF_MOBILE_BEACONS, default=[]): vol.All(
|
|
cv.ensure_list,
|
|
[cv.string]
|
|
),
|
|
}),
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
ATTR_CURRENT_LATITUDE = 'currentLatitude'
|
|
ATTR_CURRENT_LONGITUDE = 'currentLongitude'
|
|
|
|
BEACON_DEV_PREFIX = 'beacon'
|
|
|
|
LOCATION_ENTRY = '1'
|
|
LOCATION_EXIT = '0'
|
|
|
|
TRACKER_UPDATE = '{}_tracker_update'.format(DOMAIN)
|
|
|
|
|
|
async def async_setup(hass, hass_config):
|
|
"""Set up the Geofency component."""
|
|
config = hass_config[DOMAIN]
|
|
mobile_beacons = config[CONF_MOBILE_BEACONS]
|
|
hass.data[DOMAIN] = [slugify(beacon) for beacon in mobile_beacons]
|
|
|
|
hass.async_create_task(
|
|
async_load_platform(hass, 'device_tracker', DOMAIN, {}, hass_config)
|
|
)
|
|
return True
|
|
|
|
|
|
async def handle_webhook(hass, webhook_id, request):
|
|
"""Handle incoming webhook with Mailgun inbound messages."""
|
|
data = _validate_data(await request.post())
|
|
|
|
if not data:
|
|
return web.Response(
|
|
body="Invalid data",
|
|
status=HTTP_UNPROCESSABLE_ENTITY
|
|
)
|
|
|
|
if _is_mobile_beacon(data, hass.data[DOMAIN]):
|
|
return _set_location(hass, data, None)
|
|
if data['entry'] == LOCATION_ENTRY:
|
|
location_name = data['name']
|
|
else:
|
|
location_name = STATE_NOT_HOME
|
|
if ATTR_CURRENT_LATITUDE in data:
|
|
data[ATTR_LATITUDE] = data[ATTR_CURRENT_LATITUDE]
|
|
data[ATTR_LONGITUDE] = data[ATTR_CURRENT_LONGITUDE]
|
|
|
|
return _set_location(hass, data, location_name)
|
|
|
|
|
|
def _validate_data(data):
|
|
"""Validate POST payload."""
|
|
data = data.copy()
|
|
|
|
required_attributes = ['address', 'device', 'entry',
|
|
'latitude', 'longitude', 'name']
|
|
|
|
valid = True
|
|
for attribute in required_attributes:
|
|
if attribute not in data:
|
|
valid = False
|
|
_LOGGER.error("'%s' not specified in message", attribute)
|
|
|
|
if not valid:
|
|
return {}
|
|
|
|
data['address'] = data['address'].replace('\n', ' ')
|
|
data['device'] = slugify(data['device'])
|
|
data['name'] = slugify(data['name'])
|
|
|
|
gps_attributes = [ATTR_LATITUDE, ATTR_LONGITUDE,
|
|
ATTR_CURRENT_LATITUDE, ATTR_CURRENT_LONGITUDE]
|
|
|
|
for attribute in gps_attributes:
|
|
if attribute in data:
|
|
data[attribute] = float(data[attribute])
|
|
|
|
return data
|
|
|
|
|
|
def _is_mobile_beacon(data, mobile_beacons):
|
|
"""Check if we have a mobile beacon."""
|
|
return 'beaconUUID' in data and data['name'] in mobile_beacons
|
|
|
|
|
|
def _device_name(data):
|
|
"""Return name of device tracker."""
|
|
if 'beaconUUID' in data:
|
|
return "{}_{}".format(BEACON_DEV_PREFIX, data['name'])
|
|
return data['device']
|
|
|
|
|
|
def _set_location(hass, data, location_name):
|
|
"""Fire HA event to set location."""
|
|
device = _device_name(data)
|
|
|
|
async_dispatcher_send(
|
|
hass,
|
|
TRACKER_UPDATE,
|
|
device,
|
|
(data[ATTR_LATITUDE], data[ATTR_LONGITUDE]),
|
|
location_name,
|
|
data
|
|
)
|
|
|
|
return web.Response(
|
|
body="Setting location for {}".format(device),
|
|
status=HTTP_OK
|
|
)
|
|
|
|
|
|
async def async_setup_entry(hass, entry):
|
|
"""Configure based on config entry."""
|
|
hass.components.webhook.async_register(
|
|
DOMAIN, 'Geofency', entry.data[CONF_WEBHOOK_ID], handle_webhook)
|
|
return True
|
|
|
|
|
|
async def async_unload_entry(hass, entry):
|
|
"""Unload a config entry."""
|
|
hass.components.webhook.async_unregister(entry.data[CONF_WEBHOOK_ID])
|
|
return True
|
|
|
|
config_entry_flow.register_webhook_flow(
|
|
DOMAIN,
|
|
'Geofency Webhook',
|
|
{
|
|
'docs_url': 'https://www.home-assistant.io/components/geofency/'
|
|
}
|
|
)
|