Skip to content

Releases

ha-history-exporter 1.5.0

ha-history-exporter 1.5.0 Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 04 Nov 22:54
v1.5.0
ad5f7e8
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Initial release

ha-history-exporter 1.5.0 is the first public release of the Home Assistant History Exporter, a command-line tool that keeps your own copy of your Home Assistant history. It saves the history to your computer, one day at a time, as ordinary JSONL, CSV or Parquet files. It runs on your computer, only reads from Home Assistant and changes nothing there.

Highlights

  • Back up your whole history: every recorded change of every entity, with its attributes, including entities that are unavailable at the moment.
  • Choose JSONL, CSV and Parquet, one or several at once, with identical content.
  • Complete calendar days in your time zone, including the days the clocks change.
  • Safe to repeat: days you already saved are skipped, so you can run it every day, by hand or automatically with Task Scheduler or cron.
  • No half-finished days: a day is saved completely or not at all, even after a crash or a power cut.
  • Checks its own work: every file is read back before a day counts as saved, and hhe verify confirms later that your files are still intact.
  • hhe status lists your saved days and any gaps, and hhe convert adds another format later without contacting Home Assistant.
  • Days outside your Recorder retention are named and skipped instead of being saved incomplete.
  • Guided setup with hhe init, settings with hhe config, and hhe doctor to check your installation, settings, saved files and connection.
  • --json output and documented exit codes for scripts and scheduled tasks.
  • Private: no cloud service, no add-on and no integration. Your access token stays in a file only your account can read, and HTTPS certificates are verified.
  • Runs on Windows, macOS and Linux with Python 3.12 or newer.

Installation

Install the History Exporter with pipx:

pipx install ha-history-exporter

Parquet files need one more component, installed with pipx inject ha-history-exporter pyarrow. JSONL and CSV work without it.

Then run hhe init and follow the Quickstart to save your first days. The project README has step-by-step guides for Windows, macOS and Linux, instructions for daily exports and troubleshooting.

Should you encounter a problem please open an Issue on GitHub and include the version from hhe --version, your operating system, the exact error message and the output of hhe doctor, without private addresses.

Assets 5
Loading