Skip to main content

Historical sensors for HomeAssistant

Project description

Historical sensors for Home Assistant

GitHub Release (latest SemVer including pre-releases) CodeQL Code style: black

Buy Me A Coffee

Feed historical data into Home Assistant database.

HomeAssistant architecture is built around polling (or pushing) data from devices, or data providers, in "real-time". Some data sources (e.g, energy, water or gas providers) can't be polled in real-time or readings are not accurate. However reading historical data, like last month consumption, it's possible and accurate. This module adds support to this.

This module uses the recoder component and custom state creation to store states "from the past".

Current projects using this module:

Technical details

Q. How it's accomplished?.

A. It's a relatively easy answer but needs to be broken into some pieces:

  1. A new property for sensors: historical_states. This property holds a list of HistoricalStates which are, basically, a state+datetime (with tzinfo), so… the data we want.

  2. A new hook for sensor: async_update_historical_states. This method is responsible to update historical_states property.
    This is the only function that needs to be implemented.

  3. A new method, implemented by HistoricalSensor class: async_write_ha_historical_states. This method handles the details of creating tweaked states in the past and write them into the database using the recorder component of Home Assistant core.

Q. Something else?

A. Historical sensors can't provide the current state, Home Assistant will show "undefined" state forever, it's OK and intentional.

External vs. internal statistics

Importing CSV files

Licenses

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

homeassistant-historical-sensor-1.0.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file homeassistant-historical-sensor-1.0.1.tar.gz.

File metadata

File hashes

Hashes for homeassistant-historical-sensor-1.0.1.tar.gz
Algorithm Hash digest
SHA256 bba9ada8c22d8e365c6a1cf059b0872e075d3371c1ed83111adf963e02706d9e
MD5 5a36f2a0e6943e30e9334c82b7322a6e
BLAKE2b-256 8caad7d7ea7b72ea71173e488f848a2bb03c046f6162b78b0b4d44b5c8dc9e84

See more details on using hashes here.

File details

Details for the file homeassistant_historical_sensor-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for homeassistant_historical_sensor-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2c2fcb5d445736603011821da5d39f54407939352b151e63e793298f9fde1b98
MD5 d96e661b860819cbef180af9d048454b
BLAKE2b-256 88694b060c644131ec4e1aedbac504c9f71d9a89abc944fbfdc9dccbe6b4d461

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page