Add SmartThings component and switch platform (#20148)
* Added SmartThings component and switch platform * Corrected comment typos. * Embedded switch platform. * Replaced custom view usage with webhook component. * Replaced urls with tokens in strings. * Fixed line length. * Use generated webhook id instead of static one. * Reuse core constant instead of defining again. * Optimizations in anticipation of future platforms. * Use async_generate_path instead of hard-coded path. * Fixed line length. * Updates per review feedback. * Updates per latest review feedback.
This commit is contained in:
1 parent
5a0c707a37
commit
69ec7980ad
18 files changed
+1793
No files matched your search
@@ -0,0 +1,275 @@
|
||||
"""
|
||||
SmartApp functionality to receive cloud-push notifications.
|
||||
|
||||
This module defines the functions to manage the SmartApp integration
|
||||
within the SmartThings ecosystem in order to receive real-time webhook-based
|
||||
callbacks when device states change.
|
||||
"""
|
||||
import asyncio
|
||||
import functools
|
||||
import logging
|
||||
from uuid import uuid4
|
||||
|
||||
from aiohttp import web
|
||||
|
||||
from homeassistant.components import webhook
|
||||
from homeassistant.const import CONF_ACCESS_TOKEN, CONF_WEBHOOK_ID
|
||||
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
||||
from homeassistant.helpers.dispatcher import (
|
||||
async_dispatcher_connect, async_dispatcher_send)
|
||||
from homeassistant.helpers.typing import HomeAssistantType
|
||||
|
||||
from .const import (
|
||||
APP_NAME_PREFIX, APP_OAUTH_SCOPES, CONF_APP_ID, CONF_INSTALLED_APP_ID,
|
||||
CONF_INSTANCE_ID, CONF_LOCATION_ID, DATA_BROKERS, DATA_MANAGER, DOMAIN,
|
||||
SETTINGS_INSTANCE_ID, SIGNAL_SMARTAPP_PREFIX, STORAGE_KEY, STORAGE_VERSION,
|
||||
SUPPORTED_CAPABILITIES)
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def find_app(hass: HomeAssistantType, api):
|
||||
"""Find an existing SmartApp for this installation of hass."""
|
||||
apps = await api.apps()
|
||||
for app in [app for app in apps
|
||||
if app.app_name.startswith(APP_NAME_PREFIX)]:
|
||||
# Load settings to compare instance id
|
||||
settings = await app.settings()
|
||||
if settings.settings.get(SETTINGS_INSTANCE_ID) == \
|
||||
hass.data[DOMAIN][CONF_INSTANCE_ID]:
|
||||
return app
|
||||
|
||||
|
||||
async def validate_installed_app(api, installed_app_id: str):
|
||||
"""
|
||||
Ensure the specified installed SmartApp is valid and functioning.
|
||||
|
||||
Query the API for the installed SmartApp and validate that it is tied to
|
||||
the specified app_id and is in an authorized state.
|
||||
"""
|
||||
from pysmartthings import InstalledAppStatus
|
||||
|
||||
installed_app = await api.installed_app(installed_app_id)
|
||||
if installed_app.installed_app_status != InstalledAppStatus.AUTHORIZED:
|
||||
raise RuntimeWarning("Installed SmartApp instance '{}' ({}) is not "
|
||||
"AUTHORIZED but instead {}"
|
||||
.format(installed_app.display_name,
|
||||
installed_app.installed_app_id,
|
||||
installed_app.installed_app_status))
|
||||
return installed_app
|
||||
|
||||
|
||||
def _get_app_template(hass: HomeAssistantType):
|
||||
from pysmartthings import APP_TYPE_WEBHOOK, CLASSIFICATION_AUTOMATION
|
||||
|
||||
return {
|
||||
'app_name': APP_NAME_PREFIX + str(uuid4()),
|
||||
'display_name': 'Home Assistant',
|
||||
'description': "Home Assistant at " + hass.config.api.base_url,
|
||||
'webhook_target_url': webhook.async_generate_url(
|
||||
hass, hass.data[DOMAIN][CONF_WEBHOOK_ID]),
|
||||
'app_type': APP_TYPE_WEBHOOK,
|
||||
'single_instance': True,
|
||||
'classifications': [CLASSIFICATION_AUTOMATION]
|
||||
}
|
||||
|
||||
|
||||
async def create_app(hass: HomeAssistantType, api):
|
||||
"""Create a SmartApp for this instance of hass."""
|
||||
from pysmartthings import App, AppOAuth, AppSettings
|
||||
from pysmartapp.const import SETTINGS_APP_ID
|
||||
|
||||
# Create app from template attributes
|
||||
template = _get_app_template(hass)
|
||||
app = App()
|
||||
for key, value in template.items():
|
||||
setattr(app, key, value)
|
||||
app = (await api.create_app(app))[0]
|
||||
_LOGGER.debug("Created SmartApp '%s' (%s)", app.app_name, app.app_id)
|
||||
|
||||
# Set unique hass id in settings
|
||||
settings = AppSettings(app.app_id)
|
||||
settings.settings[SETTINGS_APP_ID] = app.app_id
|
||||
settings.settings[SETTINGS_INSTANCE_ID] = \
|
||||
hass.data[DOMAIN][CONF_INSTANCE_ID]
|
||||
await api.update_app_settings(settings)
|
||||
_LOGGER.debug("Updated App Settings for SmartApp '%s' (%s)",
|
||||
app.app_name, app.app_id)
|
||||
|
||||
# Set oauth scopes
|
||||
oauth = AppOAuth(app.app_id)
|
||||
oauth.client_name = 'Home Assistant'
|
||||
oauth.scope.extend(APP_OAUTH_SCOPES)
|
||||
await api.update_app_oauth(oauth)
|
||||
_LOGGER.debug("Updated App OAuth for SmartApp '%s' (%s)",
|
||||
app.app_name, app.app_id)
|
||||
return app
|
||||
|
||||
|
||||
async def update_app(hass: HomeAssistantType, app):
|
||||
"""Ensure the SmartApp is up-to-date and update if necessary."""
|
||||
template = _get_app_template(hass)
|
||||
template.pop('app_name') # don't update this
|
||||
update_required = False
|
||||
for key, value in template.items():
|
||||
if getattr(app, key) != value:
|
||||
update_required = True
|
||||
setattr(app, key, value)
|
||||
if update_required:
|
||||
await app.save()
|
||||
_LOGGER.debug("SmartApp '%s' (%s) updated with latest settings",
|
||||
app.app_name, app.app_id)
|
||||
|
||||
|
||||
def setup_smartapp(hass, app):
|
||||
"""
|
||||
Configure an individual SmartApp in hass.
|
||||
|
||||
Register the SmartApp with the SmartAppManager so that hass will service
|
||||
lifecycle events (install, event, etc...). A unique SmartApp is created
|
||||
for each SmartThings account that is configured in hass.
|
||||
"""
|
||||
manager = hass.data[DOMAIN][DATA_MANAGER]
|
||||
smartapp = manager.smartapps.get(app.app_id)
|
||||
if smartapp:
|
||||
# already setup
|
||||
return smartapp
|
||||
smartapp = manager.register(app.app_id, app.webhook_public_key)
|
||||
smartapp.name = app.display_name
|
||||
smartapp.description = app.description
|
||||
smartapp.permissions.extend(APP_OAUTH_SCOPES)
|
||||
return smartapp
|
||||
|
||||
|
||||
async def setup_smartapp_endpoint(hass: HomeAssistantType):
|
||||
"""
|
||||
Configure the SmartApp webhook in hass.
|
||||
|
||||
SmartApps are an extension point within the SmartThings ecosystem and
|
||||
is used to receive push updates (i.e. device updates) from the cloud.
|
||||
"""
|
||||
from pysmartapp import Dispatcher, SmartAppManager
|
||||
|
||||
data = hass.data.get(DOMAIN)
|
||||
if data:
|
||||
# already setup
|
||||
return
|
||||
|
||||
# Get/create config to store a unique id for this hass instance.
|
||||
store = hass.helpers.storage.Store(STORAGE_VERSION, STORAGE_KEY)
|
||||
config = await store.async_load()
|
||||
if not config:
|
||||
# Create config
|
||||
config = {
|
||||
CONF_INSTANCE_ID: str(uuid4()),
|
||||
CONF_WEBHOOK_ID: webhook.generate_secret()
|
||||
}
|
||||
await store.async_save(config)
|
||||
|
||||
# SmartAppManager uses a dispatcher to invoke callbacks when push events
|
||||
# occur. Use hass' implementation instead of the built-in one.
|
||||
dispatcher = Dispatcher(
|
||||
signal_prefix=SIGNAL_SMARTAPP_PREFIX,
|
||||
connect=functools.partial(async_dispatcher_connect, hass),
|
||||
send=functools.partial(async_dispatcher_send, hass))
|
||||
manager = SmartAppManager(
|
||||
webhook.async_generate_path(config[CONF_WEBHOOK_ID]),
|
||||
dispatcher=dispatcher)
|
||||
manager.connect_install(functools.partial(smartapp_install, hass))
|
||||
manager.connect_uninstall(functools.partial(smartapp_uninstall, hass))
|
||||
|
||||
webhook.async_register(hass, DOMAIN, 'SmartApp',
|
||||
config[CONF_WEBHOOK_ID], smartapp_webhook)
|
||||
|
||||
hass.data[DOMAIN] = {
|
||||
DATA_MANAGER: manager,
|
||||
CONF_INSTANCE_ID: config[CONF_INSTANCE_ID],
|
||||
DATA_BROKERS: {},
|
||||
CONF_WEBHOOK_ID: config[CONF_WEBHOOK_ID]
|
||||
}
|
||||
|
||||
|
||||
async def smartapp_install(hass: HomeAssistantType, req, resp, app):
|
||||
"""
|
||||
Handle when a SmartApp is installed by the user into a location.
|
||||
|
||||
Setup subscriptions using the access token SmartThings provided in the
|
||||
event. An explicit subscription is required for each 'capability' in order
|
||||
to receive the related attribute updates. Finally, create a config entry
|
||||
representing the installation if this is not the first installation under
|
||||
the account.
|
||||
"""
|
||||
from pysmartthings import SmartThings, Subscription, SourceType
|
||||
|
||||
# This access token is a temporary 'SmartApp token' that expires in 5 min
|
||||
# and is used to create subscriptions only.
|
||||
api = SmartThings(async_get_clientsession(hass), req.auth_token)
|
||||
|
||||
async def create_subscription(target):
|
||||
sub = Subscription()
|
||||
sub.installed_app_id = req.installed_app_id
|
||||
sub.location_id = req.location_id
|
||||
sub.source_type = SourceType.CAPABILITY
|
||||
sub.capability = target
|
||||
try:
|
||||
await api.create_subscription(sub)
|
||||
_LOGGER.debug("Created subscription for '%s' under app '%s'",
|
||||
target, req.installed_app_id)
|
||||
except Exception: # pylint:disable=broad-except
|
||||
_LOGGER.exception("Failed to create subscription for '%s' under "
|
||||
"app '%s'", target, req.installed_app_id)
|
||||
|
||||
tasks = [create_subscription(c) for c in SUPPORTED_CAPABILITIES]
|
||||
await asyncio.gather(*tasks)
|
||||
_LOGGER.debug("SmartApp '%s' under parent app '%s' was installed",
|
||||
req.installed_app_id, app.app_id)
|
||||
|
||||
# The permanent access token is copied from another config flow with the
|
||||
# same parent app_id. If one is not found, that means the user is within
|
||||
# the initial config flow and the entry at the conclusion.
|
||||
access_token = next((
|
||||
entry.data.get(CONF_ACCESS_TOKEN) for entry
|
||||
in hass.config_entries.async_entries(DOMAIN)
|
||||
if entry.data[CONF_APP_ID] == app.app_id), None)
|
||||
if access_token:
|
||||
# Add as job not needed because the current coroutine was invoked
|
||||
# from the dispatcher and is not being awaited.
|
||||
await hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={'source': 'install'},
|
||||
data={
|
||||
CONF_APP_ID: app.app_id,
|
||||
CONF_INSTALLED_APP_ID: req.installed_app_id,
|
||||
CONF_LOCATION_ID: req.location_id,
|
||||
CONF_ACCESS_TOKEN: access_token
|
||||
})
|
||||
|
||||
|
||||
async def smartapp_uninstall(hass: HomeAssistantType, req, resp, app):
|
||||
"""
|
||||
Handle when a SmartApp is removed from a location by the user.
|
||||
|
||||
Find and delete the config entry representing the integration.
|
||||
"""
|
||||
entry = next((entry for entry in hass.config_entries.async_entries(DOMAIN)
|
||||
if entry.data.get(CONF_INSTALLED_APP_ID) ==
|
||||
req.installed_app_id),
|
||||
None)
|
||||
if entry:
|
||||
_LOGGER.debug("SmartApp '%s' under parent app '%s' was removed",
|
||||
req.installed_app_id, app.app_id)
|
||||
# Add as job not needed because the current coroutine was invoked
|
||||
# from the dispatcher and is not being awaited.
|
||||
await hass.config_entries.async_remove(entry.entry_id)
|
||||
|
||||
|
||||
async def smartapp_webhook(hass: HomeAssistantType, webhook_id: str, request):
|
||||
"""
|
||||
Handle a smartapp lifecycle event callback from SmartThings.
|
||||
|
||||
Requests from SmartThings are digitally signed and the SmartAppManager
|
||||
validates the signature for authenticity.
|
||||
"""
|
||||
manager = hass.data[DOMAIN][DATA_MANAGER]
|
||||
data = await request.json()
|
||||
result = await manager.handle_request(data, request.headers)
|
||||
return web.json_response(result)
|
||||
Reference in new issue
Block a user