-
Star
(108)
You must be signed in to star a gist -
Fork
(57)
You must be signed in to fork a gist
-
-
Save matt2005/744b5ef548cc13d88d0569eea65f5e5b to your computer and use it in GitHub Desktop.
Alexa Smart Home Skill Adapter for Home Assistant
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| """ | |
| Copyright 2019 Jason Hu <awaregit at gmail.com> | |
| Modified 2020 Matthew Hilton <[email protected]> | |
| Refactor and Modernised 2025 Matthew Hilton <[email protected]> | |
| Licensed under the Apache License, Version 2.0 (the "License"); | |
| you may not use this file except in compliance with the License. | |
| You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, software | |
| distributed under the License is distributed on an "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| See the License for the specific language governing permissions and | |
| limitations under the License. | |
| """ | |
| import json | |
| import logging | |
| import logging.handlers | |
| import os | |
| from typing import Any | |
| import urllib3 | |
| # Configure debug mode | |
| _debug = bool(os.environ.get('DEBUG')) | |
| # Configure logging with enhanced formatting | |
| _log_format = '%(asctime)s - %(name)s - %(levelname)s - [%(filename)s:%(lineno)d] - %(message)s' | |
| _formatter = logging.Formatter(_log_format) | |
| # Console handler | |
| _console_handler = logging.StreamHandler() | |
| _console_handler.setFormatter(_formatter) | |
| # Logger setup | |
| _logger = logging.getLogger('HomeAssistant-SmartHome') | |
| _logger.setLevel(logging.DEBUG if _debug else logging.INFO) | |
| _logger.addHandler(_console_handler) | |
| # Suppress debug logs from urllib3 | |
| logging.getLogger('urllib3').setLevel(logging.INFO) | |
| def lambda_handler(event: dict[str, Any], context: Any) -> dict[str, Any]: | |
| """Handle incoming Alexa directive. | |
| Args: | |
| event: The Alexa directive event payload | |
| context: AWS Lambda context object | |
| Returns: | |
| Response payload for Alexa | |
| Raises: | |
| AssertionError: If request validation fails | |
| """ | |
| _logger.info('Processing Alexa request') | |
| _logger.debug('Event payload: %s', json.dumps(event, indent=2)) | |
| try: | |
| base_url = os.environ.get('BASE_URL') | |
| if base_url is None: | |
| _logger.error('BASE_URL environment variable not set') | |
| raise ValueError('BASE_URL environment variable must be set') | |
| base_url = base_url.rstrip('/') | |
| _logger.debug('Base URL: %s', base_url) | |
| directive = event.get('directive') | |
| if directive is None: | |
| _logger.error('Malformed request: missing directive') | |
| raise ValueError('Request missing required directive field') | |
| payload_version = directive.get('header', {}).get('payloadVersion') | |
| if payload_version != '3': | |
| _logger.error('Unsupported payloadVersion: %s', payload_version) | |
| raise ValueError(f'Only payloadVersion 3 is supported, got {payload_version}') | |
| scope = directive.get('endpoint', {}).get('scope') | |
| if scope is None: | |
| # token is in grantee for Linking directive | |
| scope = directive.get('payload', {}).get('grantee') | |
| if scope is None: | |
| # token is in payload for Discovery directive | |
| scope = directive.get('payload', {}).get('scope') | |
| if scope is None: | |
| _logger.error('Malformed request: missing scope/token') | |
| raise ValueError('Request missing scope in endpoint or payload') | |
| scope_type = scope.get('type') | |
| if scope_type != 'BearerToken': | |
| _logger.error('Unsupported scope type: %s', scope_type) | |
| raise ValueError(f'Only BearerToken scope is supported, got {scope_type}') | |
| token = scope.get('token') | |
| if token is None and _debug: | |
| _logger.debug('Token not found in request, using LONG_LIVED_ACCESS_TOKEN from environment') | |
| token = os.environ.get('LONG_LIVED_ACCESS_TOKEN') | |
| if token is None: | |
| _logger.error('No authentication token available') | |
| raise ValueError('Authentication token is required') | |
| verify_ssl = not bool(os.environ.get('NOT_VERIFY_SSL')) | |
| _logger.debug('SSL verification enabled: %s', verify_ssl) | |
| http = urllib3.PoolManager( | |
| cert_reqs='CERT_REQUIRED' if verify_ssl else 'CERT_NONE', | |
| timeout=urllib3.Timeout(connect=2.0, read=10.0) | |
| ) | |
| _logger.info('Sending request to Home Assistant') | |
| response = http.request( | |
| 'POST', | |
| f'{base_url}/api/alexa/smart_home', | |
| headers={ | |
| 'Authorization': f'Bearer {token}', | |
| 'Content-Type': 'application/json', | |
| }, | |
| body=json.dumps(event).encode('utf-8'), | |
| ) | |
| _logger.debug('Response status: %s', response.status) | |
| if response.status >= 400: | |
| response_text = response.data.decode('utf-8') | |
| _logger.error('Home Assistant returned error %s: %s', response.status, response_text) | |
| error_type = 'INVALID_AUTHORIZATION_CREDENTIAL' if response.status in (401, 403) else 'INTERNAL_ERROR' | |
| return { | |
| 'event': { | |
| 'payload': { | |
| 'type': error_type, | |
| 'message': response_text, | |
| } | |
| } | |
| } | |
| response_data = json.loads(response.data.decode('utf-8')) | |
| _logger.info('Successfully processed Alexa request') | |
| _logger.debug('Response: %s', json.dumps(response_data, indent=2)) | |
| return response_data | |
| except (ValueError, KeyError, json.JSONDecodeError) as e: | |
| _logger.exception('Error processing request: %s', str(e)) | |
| return { | |
| 'event': { | |
| 'payload': { | |
| 'type': 'INVALID_REQUEST', | |
| 'message': str(e), | |
| } | |
| } | |
| } | |
| except Exception as e: | |
| _logger.exception('Unexpected error: %s', str(e)) | |
| return { | |
| 'event': { | |
| 'payload': { | |
| 'type': 'INTERNAL_ERROR', | |
| 'message': 'An unexpected error occurred', | |
| } | |
| } | |
| } |
Author
I've refactored some of the lambda and tidyed it up as I need to update to the python 3.14 runtime. The logging is now improved and the code flow works better.
Care to share? :)
Author
I updated the gist a few days ago.
I updated the gist a few days ago.
Oh, I didn't see that it's your gist, thank you!
It's way better to select the entities specifically (and fine tune their names/ categories) or to at least only select certain categories for discovery.
Are we still limited to just these filter options?
- include_domains: Exposes all entities belonging to specified domains (e.g., light, switch, climate).
- exclude_domains: Hides all entities belonging to specified domains.
- include_entities: Exposes only the explicitly listed entities (e.g., light.living_room_lights). If this is the only filter type used, only those entities will be included.
- exclude_entities: Hides specific entities, even if their domain is included.
- include_entity_globs: Exposes entities that match a specified pattern using wildcards (globs), such as sensor.*_temperature.
- exclude_entity_globs: Hides entities that match a specified pattern using wildcards.
It would be nice to be able to leverage home-assistant.xyz/config/voice-assistants/expose or be able to include/exclude labels...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I've refactored some of the lambda and tidyed it up as I need to update to the python 3.14 runtime.
The logging is now improved and the code flow works better.