Skip to content

Latest commit

 

History

History
254 lines (173 loc) · 11.1 KB

File metadata and controls

254 lines (173 loc) · 11.1 KB
Module Name HomeAssistantX
Module Guid 9c949e39-7bcb-41a2-ab01-ca4e6fe1dc27
Download Help Link https://github.com/EvotecIT/HomeAssistantX
Help Version 0.1.0
Locale en-US

HomeAssistantX Module

Description

Task-oriented PowerShell access to Home Assistant Core and Supervisor through HomeAssistantX.

HomeAssistantX Cmdlets

Creates, verifies, and optionally stores the runspace's default Home Assistant connection.

Closes the supplied connection or the current runspace default.

Exports one bounded camera snapshot through an atomic local-file replacement.

Downloads Home Assistant-redacted diagnostics for a configuration entry or one device.

Finds Home Assistant instances advertised on the local IPv4 network.

Lists Home Assistant actions and their runtime-provided field descriptions.

Gets installed Supervisor-managed Home Assistant apps.

Lists Home Assistant areas (rooms), optionally within a floor.

Reads automation runtime state or an administrator-only editable configuration.

Gets backups from a Supervisor-managed Home Assistant installation.

Lists Home Assistant calendar entities.

Gets events from one Home Assistant calendar over an explicit time range.

Reads camera state, capabilities, stream details, preferences, or temporary signed paths.

Lists Home Assistant categories within an explicit registry scope.

Gets the default Home Assistant connection for the current PowerShell runspace.

Reads Home Assistant frontend panels, Lovelace dashboards, configurations, resources, or mode information.

Lists Home Assistant devices, optionally filtered by area or floor.

Reads Energy preferences, capabilities, validation, provider forecasts, or fossil-energy periods.

Gets joined entities by name, identifier, domain, device, area, or floor.

Lists Home Assistant floors with their joined areas, devices, and entities.

Gets recorder history for one or more entity identifiers.

Gets Core configuration, an operational snapshot, capabilities, system health, or Supervisor information.

Gets Home Assistant configuration entries by identifier, domain, or all integrations.

Gets Core repairs issues or Supervisor resolution issues.

Gets all Supervisor jobs or one job by identifier.

Lists Home Assistant labels, optionally selecting one by name or ID.

Gets structured system-log entries or bounded Core, Supervisor, host, and app log lines.

Reads human-oriented Recorder logbook activity for a bounded time range.

Browses, searches, or resolves Home Assistant media sources and media-player libraries.

Gets persistent notifications currently stored by Home Assistant.

Lists Recorder statistics or returns typed aggregated values.

Gets automation or script trace summaries, or one complete trace run.

Gets update entities or Supervisor component and app updates.

Reads current observations, forecasts, or supported weather units.

Installs an update entity or a Supervisor-managed Core, OS, Supervisor, or app update.

Invokes any Home Assistant action with one target-oriented set of parameters.

Runs one explicit lifecycle operation for a Supervisor-managed Home Assistant app.

Runs selected automation entities without changing their definitions.

Runs a bounded Recorder maintenance task.

Controls a Home Assistant remote, including sending, learning, and deleting commands.

Runs a scene, script, or button routine through one task-oriented command.

Creates a full Supervisor backup with optional compression, location, and database exclusion.

Streams refreshed event lists for one calendar without polling.

Streams Home Assistant events without polling until canceled.

Streams persistent-notification changes without polling.

Streams weather forecast updates without polling.

Deletes one administrator-managed automation definition.

Deletes a Home Assistant calendar event or recurring occurrence.

Deletes a Home Assistant category from an explicit scope.

Removes a Lovelace dashboard, its configuration, or a storage-mode resource.

Deletes a Home Assistant label.

Dismisses one or all persistent Home Assistant notifications.

Permanently removes long-term statistics for one or more identifiers.

Restarts Core, Supervisor, host, an app, or reloads one integration.

Sends a persistent notification or a message to selected notify entities.

Arms, disarms, or triggers alarm panels with high-impact confirmation.

Creates or replaces one administrator-managed automation definition.

Creates or updates a timed or all-day Home Assistant calendar event.

Updates administrator-only camera streaming preferences.

Creates or updates a Home Assistant category within an explicit scope.

Sets common climate values with typed parameters instead of raw action data.

Moves covers with a typed action, position, or tilt position.

Creates or updates Lovelace dashboards, configurations, and storage-mode resources.

Updates one or more Energy dashboard preference collections.

Sets one fan action, speed, oscillation, direction, or preset.

Sets common boolean, number, select, text, date, time, and date-time helpers.

Sets humidifier power, humidity, or mode.

Creates or updates a Home Assistant label while allowing nullable fields to be explicitly cleared.

Starts, pauses, or docks Home Assistant lawn mower entities.

Controls lights with typed power, brightness, color, effect, and transition parameters.

Locks, unlocks, or opens a lock with high-impact confirmation.

Controls media-player power, playback, volume, source, grouping, queueing, and content.

Controls sirens with typed tone, volume, and duration options.

Updates metadata, converts units, adjusts sums, or imports Recorder statistics.

Turns switches on, off, or toggles them through a resolved Home Assistant target.

Controls common vacuum lifecycle, fan-speed, and area-cleaning operations.

Moves a valve with one typed action or target position.

Sets water-heater power, temperature, operation mode, or away mode.

Asks Home Assistant to validate an automation draft without saving it.

Validates the active Home Assistant configuration without restarting Core.

Validates Recorder long-term statistics and returns every issue reported by Home Assistant.