Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.history.HistoryPeriodView Class Reference
Inheritance diagram for homeassistant.components.history.HistoryPeriodView:
[legend]
Collaboration diagram for homeassistant.components.history.HistoryPeriodView:
[legend]

Public Member Functions

web.Response get (self, web.Request request, str|None datetime=None)
 

Static Public Attributes

list extra_urls = ["/api/history/period/{datetime}"]
 
string name = "api:history:view-period"
 
string url = "/api/history/period"
 

Private Member Functions

web.Response _sorted_significant_states_json (self, HomeAssistant hass, dt start_time, dt end_time, list[str] entity_ids, bool include_start_time_state, bool significant_changes_only, bool minimal_response, bool no_attributes)
 

Detailed Description

Handle history period requests.

Definition at line 54 of file __init__.py.

Member Function Documentation

◆ _sorted_significant_states_json()

web.Response homeassistant.components.history.HistoryPeriodView._sorted_significant_states_json (   self,
HomeAssistant  hass,
dt  start_time,
dt  end_time,
list[str]  entity_ids,
bool  include_start_time_state,
bool  significant_changes_only,
bool  minimal_response,
bool  no_attributes 
)
private
Fetch significant stats from the database as json.

Definition at line 137 of file __init__.py.

◆ get()

web.Response homeassistant.components.history.HistoryPeriodView.get (   self,
web.Request  request,
str | None   datetime = None 
)
Return history over a period of time.

Definition at line 61 of file __init__.py.

Member Data Documentation

◆ extra_urls

list homeassistant.components.history.HistoryPeriodView.extra_urls = ["/api/history/period/{datetime}"]
static

Definition at line 59 of file __init__.py.

◆ name

string homeassistant.components.history.HistoryPeriodView.name = "api:history:view-period"
static

Definition at line 58 of file __init__.py.

◆ url

string homeassistant.components.history.HistoryPeriodView.url = "/api/history/period"
static

Definition at line 57 of file __init__.py.


The documentation for this class was generated from the following file: