Skip to content

AlbinLind/dawarich-home-assistant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

273 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dawarich Home Assistant Integration

Important

Version 1.0.0 includes a breaking change that affects entity identifiers. More Information


Note

This is an experimental integration for Dawarich, expect possibly breaking changes. This is a community integration, not affiliated with Dawarich.

Dawarich is a self-hosted Google Timeline alternative (see why you would want to consider it).

This integration does two things, one of which is optional.

  1. It provides statistics for your account. This includes total distance, number of cities visited, current Dawarich version, and more.
  2. (optional) You can set a device tracker (such as a mobile phone) to send its data through Home Assistant to Dawarich. This way, you don't need another app and can instead use any existing location entities in Home Assistant.

Install

There are two ways to install this. The easiest is with HACS.

Install with HACS

Altough the below instructions might look complicated, they are rather simple.

  1. Make sure you have HACS installed using these instructions.
  2. Click the button below to add the custom repository to HACS directly:
    Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.
  3. Press the download button in the bottom right corner.
  4. Restart Home Assistant.
  5. Click the button below to configure the Dawarich integration:
    Open your Home Assistant instance and start setting up a new integration.

Manual Installation

Take the items under custom_components/dawarich and place them in the folder homeassistant/custom_components/dawarich.

Upgrading

Upgrading to v1.0.0

Important

Version 1.0.0 includes a breaking change that affects entity identifiers.

In version 1.0.0, we changed how device and entity unique IDs are generated. Previously, they were based on the API key, which caused issues when reconfiguring credentials. Now they use the stable config entry ID.

If you are upgrading from a version earlier than 1.0.0, you need to:

  1. Delete the existing Dawarich integration from Home Assistant
    • Go to SettingsDevices & ServicesDawarich
    • Click the three dots menu (⋮) and select Delete
  2. Re-add the integration
    • Click Add Integration and search for "Dawarich"
    • Enter your connection details and API key

Tip

Your history will be preserved! When you re-add the integration with the same name, the new entity IDs will be generated based on the config entry ID. Since this creates the same entity IDs as before, Home Assistant will automatically reconnect your historical data to the new entities.

This is a one-time migration. After upgrading to 1.0.0, you can use the new Reconfigure option (⋮ menu → Reconfigure) to update your settings, including your API key, without losing your entities or history.

Configuration

Below are the configuration options for the Dawarich Home Assistant integration. After configuration, input your Dawarich API key when prompted, which is available on the Dawarich account page.

  • Host: hostname, IP address, or URL that resolves to the running Dawarich instance
  • Port: port number for host
  • Name: integration entry category to contain devices
  • Device Tracker: device tracker to send data to Dawarich
  • Use SSL: check to use HTTPS (i.e. prepends url with https)
  • Verify SSL: make sure secure connection is made through SSL

Known Issues

Below are some known issues that are being looked at, but with workarounds for the moment.

Entity or Device not found in registry

This warning shows up because we are trying to determine if the device or entity is disabled. If you change the name of the tracker sensor of Dawarich you will get a warning. If you at the same time have disabled the entity then this will, until you restart your home assistant instance, continue to send new locations.

About

Custom Integration for Dawarich in Home Assistant

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages