Add WS API for listing available statistic ids (#51984)

* Add WS API for listing available statistic ids

* Update homeassistant/components/history/__init__.py

Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io>
Co-authored-by: Bram Kragten <mail@bramkragten.nl>
This commit is contained in:
Erik Montnemery 2021-06-18 21:32:30 +02:00 committed by GitHub
parent 805ef3f90b
commit 0ca199d8d0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 103 additions and 1 deletions

View file

@ -14,7 +14,10 @@ import voluptuous as vol
from homeassistant.components import websocket_api
from homeassistant.components.http import HomeAssistantView
from homeassistant.components.recorder import history, models as history_models
from homeassistant.components.recorder.statistics import statistics_during_period
from homeassistant.components.recorder.statistics import (
list_statistic_ids,
statistics_during_period,
)
from homeassistant.components.recorder.util import session_scope
from homeassistant.const import (
CONF_DOMAINS,
@ -105,6 +108,7 @@ async def async_setup(hass, config):
hass.components.websocket_api.async_register_command(
ws_get_statistics_during_period
)
hass.components.websocket_api.async_register_command(ws_get_list_statistic_ids)
return True
@ -157,6 +161,26 @@ async def ws_get_statistics_during_period(
connection.send_result(msg["id"], statistics)
@websocket_api.websocket_command(
{
vol.Required("type"): "history/list_statistic_ids",
vol.Optional("statistic_type"): str,
}
)
@websocket_api.require_admin
@websocket_api.async_response
async def ws_get_list_statistic_ids(
hass: HomeAssistant, connection: websocket_api.ActiveConnection, msg: dict
) -> None:
"""Fetch a list of available statistic_id."""
statistics = await hass.async_add_executor_job(
list_statistic_ids,
hass,
msg.get("statistic_type"),
)
connection.send_result(msg["id"], {"statistic_ids": statistics})
class HistoryPeriodView(HomeAssistantView):
"""Handle history period requests."""