Skip to content

golles/ha-tomtom-travel-time

Repository files navigation

TomTom Travel Time

GitHub Release GitHub Repo stars License GitHub Activity Code coverage hacs installs Project Maintenance BuyMeCoffee

The TomTom Travel Time integration provides travel time information using TomTom services.

Installation

Method 1: HACS (Recommended)

  1. Open HACS in your Home Assistant instance.
  2. Go to "Integrations".
  3. Click the "+" button.
  4. Search for "TomTom Travel Time".
  5. Click "Download" and restart Home Assistant.

Method 2: Manual Installation

  1. Download the latest release from GitHub releases.
  2. Extract the files to your Home Assistant custom_components directory:
    config/
    └── custom_components/
      └── tomtom_travel_time/
        ├── __init__.py
        ├── manifest.json
        └── ... (all other files)
    
  3. Restart Home Assistant.

API key

To use the TomTom Travel Time integration, you need a (free) TomTom API key. You can obtain one by signing up at the TomTom Developer Portal.

  1. Go to API & SDK Keys and click Create Key.
  2. Enter a name, e.g., "Home Assistant Integration".
  3. Under "Products", select Routing API and Geocoding API
  4. Click Create Key.
  5. Click on your new API key to copy it.

Configuration

Configuration is done entirely through the Home Assistant UI—no YAML editing required!

Quick Start

  1. Go to SettingsDevices & Services.
  2. Click "+ Add Integration".
  3. Search for "TomTom Travel Time".
  4. Follow the setup wizard to create the sensors.

Add integration

Sensors

Set options

Troubleshooting

Debug Logging

To collect detailed logs for troubleshooting:

Method 1: Integration Debug (Recommended)

  1. Go to SettingsDevices & ServicesTomTom Travel Time.
  2. Click the three dots menu in the top right corner.
  3. Click "Enable debug logging".
  4. Reproduce the issue.
  5. Click "Stop debug logging" to download the log file.

Method 2: Logger Configuration

Add this to your configuration.yaml:

logger:
  default: warn
  logs:
    custom_components.tomtom_travel_time: debug
    tomtom_apis: debug

For more information, see the Home Assistant Logger Integration.

Getting Help

  1. Check the existing issues first.
  2. If you find a new issue, create a detailed bug report.
  3. Include debug logs and the integration diagnostics file.

Contributing

Contributions are welcome! This project is open source and benefits from community involvement.

How to Contribute

  1. Report Issues: Found a bug or have a feature request? Open an issue.
  2. Code Contributions: Check the Contribution Guidelines for development setup.
  3. Device Support: Help expand device compatibility by testing with your hardware.

Development

See CONTRIBUTING.md for detailed development setup instructions.

About

A custom Home Assistant component that integrates TomTom travel time data

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Sponsor this project

Contributors