Get energy dashboard preferences
energy_get_energy_prefsRetrieve current Home Assistant Energy Dashboard preferences, including energy sources and device consumption, to inspect before editing or saving changes.
Instructions
Return the full HA Energy Dashboard preferences.
Calls the WebSocket endpoint energy/get_prefs and returns its payload
unchanged, including the configured energy_sources and
device_consumption lists.
Use when: you need the current preferences before editing them with
energy_save_energy_prefs or one of the energy_add_*/
energy_remove_energy_source helpers.
Not for: adding or removing a single source without hand-building the
full list — use energy_add_grid_consumption, energy_add_grid_return,
energy_add_solar_source, energy_add_battery_source or
energy_remove_energy_source instead.
Returns: dict with energy_sources (list) and device_consumption
(list), exactly as HA stores them.
Errors: {"error": "..."} when the WebSocket call raises.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||