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.0.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for homeassistant-historical-sensor-1.0.0.tar.gz
Algorithm Hash digest
SHA256 03643269a09d04fbdf24bce67addaca377bafc07b58c5cbbe7e1a5ff6432390c
MD5 58624209f7c947ffadf2a3b4b190bf11
BLAKE2b-256 97a44bf7305c55ae82fab8e600eea23bb57d8b3b854e263255538708f8eadc73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for homeassistant_historical_sensor-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2efeb6553e561b8dbda11e35729d167c93eaed585e9b8fed7089d2ea1a293a1
MD5 0d9937484b2d6e15cd72a5b0296bf8fe
BLAKE2b-256 f313c22d687ee758106105f2abf9e4cd7a72520fa43eee251aad827c10163215

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