repository·dev·Indexed 20 days ago
https://github.com/keesschollaart81/vscode-home-assistantA VS Code extension providing developer tooling for Home Assistant configuration, including schema validation, auto-completion for entity IDs, actions, scenes, and triggers, and Jinja template rendering via the Home Assistant API. It features seamless navigation between included YAML files using 'Go to Definition' and the ability to reload integrations directly from the editor.
The Home Assistant Language Service is the core logic engine designed to work with Home Assistant configurations. It provides the underlying intelligence for IDE extensions, enabling features like autocompletion, validation, and navigation within Home Assistant YAML files. It is used by:
The extension provides schema validation and auto-completion for Home Assistant Configuration and Lovelace files.
Key capabilities include:
!include behavior, providing context-aware validation based on the file's scope.To use this extension for managing your Home Assistant configuration in VS Code, follow these steps:
keesschollaart.vscode-home-assistant via the VS Code Marketplace.For detailed instructions on connection types (local vs. remote) and using VS Code Remote SSH, refer to the project wiki.
Once connected to your Home Assistant server, the extension provides real-time auto-completion for:
This allows you to quickly reference existing entities and services within your YAML configurations without manual lookup.
!include tags. Use the 'F12' key or the 'Go to Definition' command on an included file path to jump directly to the referenced file.The AuthManager class provides static methods to securely manage Home Assistant connection credentials (URL and Long-Lived Access Token) using VS Code's SecretStorage. It supports a fallback mechanism to environment variables and legacy settings.json configurations.
When retrieving credentials, the manager follows this priority:
HASS_TOKEN or SUPERVISOR_TOKEN.HASS_SERVER or http://supervisor/core (if SUPERVISOR_TOKEN is present).vscode-home-assistant.longLivedAccessToken and vscode-home-assistant.hostUrl (these are automatically migrated to SecretStorage upon access).hasCredentials(context): Returns true if both a valid URL and token are available.getTokenWithUI(context): A high-level helper that attempts to resolve credentials through the hierarchy and, if missing, prompts the user via VS Code input boxes to enter the URL and Token.import { AuthManager } from './auth/manager';
// Check if credentials exist
const ready = await AuthManager.hasCredentials(context);
if (!ready) {
// Prompt user via UI to fill in missing info
const token = await AuthManager.getTokenWithUI(context);
if (token) {
console.log('Authenticated!');
}
}Most template entities inherit from BaseItem and support the following common configuration keys:
availability: A template that determines if the entity is available. If it fails to render or returns True, 1, true, yes, on, enable, or a non-zero number, the entity is available.default_entity_id: Used instead of name for automatic generation of the entity ID (e.g., sensor.my_awesome_sensor).icon: A template for the entity's icon.name: A template for the entity's name.picture: A template for the entity's picture.unique_id: A unique identifier for the entity. When provided, it allows customization of the name, icon, and entity ID via the web interface.The conditional element type allows you to show or hide a group of elements based on the state of specific entities.
Required keys:
type: Must be "conditional".conditions: An array of Condition objects.elements: An array of Element objects to be displayed when conditions are met.The service-button element creates a button with arbitrary text that triggers a Home Assistant service call.
Required keys:
type: Must be "service-button".service: The name of the service to call.title: The label displayed on the button.Optional keys:
service_data: Data to pass to the service call.Most Home Assistant actions share a set of common configuration keys that allow you to manage their execution behavior within a script or automation sequence:
alias: A human-readable name for the action.enabled: A boolean to disable the action without removing it from the configuration.continue_on_error: If set to true, the action sequence will continue even if this specific action encounters an error.You can combine multiple conditions using logical operators. Home Assistant supports both standard and shorthand notations.
Passes if all embedded conditions are valid.
condition: and with a conditions list.and key directly.Passes if any embedded condition is valid.
condition: or with a conditions list.or key directly.Passes if all embedded conditions are NOT valid.
condition: not with a conditions list.not key directly.# Standard And
condition: and
conditions:
- condition: state
entity_id: light.kitchen
state: "on"
- condition: sun
after: sunset
# Shorthand And
and:
- condition: state
entity_id: light.kitchen
state: "on"
- condition: sun
after: sunset
# Not Shorthand
not:
- condition: state
entity_id: binary_sensor.motion
state: "on"