HERE Travel Time

The here_travel_time sensor provides travel time from the HERE Routing API.

Setup

You need to register for an API key (REST & XYZ HUB API/CLI) by following the instructions here.

HERE offers a Freemium Plan which includes 250,000 free Transactions per month. For the Routing API, one transaction equals one request with one starting point (no multi stop). More information can be found here

By default HERE will deactivate your account if you exceed the free Transaction limit for the month. You can add payment details to reenable your account as described here

Migrate from app_code to api_key

HERE has changed its authentication mechanism. It is no longer possible to use app_id and app_code. Existing users have to follow the migration guide in order to retrieve the now needed api_key.

Configuration

To enable the sensor, add the following lines to your configuration.yaml file:

# Example entry for configuration.yaml
sensor:
  - platform: here_travel_time
    api_key: "YOUR_API_KEY"
    origin_latitude: "51.222975"
    origin_longitude: "9.267577"
    destination_latitude: "51.257430"
    destination_longitude: "9.335892"

Configuration Variables

api_key string Required

Your application’s API key (get one by following the instructions above).

origin_latitude float (Exclusive)

The starting latitude for calculating travel distance and time. Must be used in combination with origin_longitude. Cannot be used in combination with origin_entity_id.

origin_longitude float (Exclusive)

The starting longitude for calculating travel distance and time. Must be used in combination with origin_latitude. Cannot be used in combination with origin_entity_id.

destination_latitude float (Exclusive)

The finishing latitude for calculating travel distance and time. Must be used in combination with destination_longitude. Cannot be used in combination with destination_entity_id.

destination_longitude float (Exclusive)

The finishing longitude for calculating travel distance and time. Must be used in combination with destination_latitude. Cannot be used in combination with destination_entity_id.

origin_entity_id string (Exclusive)

The entity_id holding the starting point for calculating travel distance and time. Cannot be used in combination with origin_latitude/origin_longitude.

destination_entity_id string (Exclusive)

The entity_id holding the finishing point for calculating travel distance and time. Cannot be used in combination with destination_latitude/destination_longitude.

name string (Optional, default: HERE Travel Time)

A name to display on the sensor. The default is “HERE Travel Time”.

mode string (Optional, default: car)

You can choose between: bicycle, car, pedestrian, publicTransport, publicTransportTimeTable or truck. The default is car. For public transport publicTransportTimeTable is recommended. You can find more information on the modes here and on the public modes here

route_mode string (Optional, default: fastest)

You can choose between: fastest, or shortest. This will determine whether the route is optimized to be the shortest and completely disregard traffic and speed limits or the fastest route according to the current traffic information. The default is fastest

traffic_mode boolean (Optional, default: false)

You can choose between: true, or false. Decide whether you want to take the current traffic condition into account. Default is false.

arrival time (Optional)

Time when travel is expected to end. A 24 hour time string like 08:00:00. On a sensor update it will be combined with the current date to get travel time for that moment. Cannot be used in combination with departure. Can only be used in combination with mode: publicTransportTimeTable

departure time (Optional)

Time when travel is expected to end. A 24 hour time string like 08:00:00. On a sensor update it will be combined with the current date to get travel time for that moment. Cannot be used in combination with arrival. If departure is not provided each update of the sensor uses the current date and time.

unit_system string (Optional)

You can choose between metric or imperial.

Default:

Defaults to metric or imperial based on the Home Assistant configuration.

scan_interval integer (Optional, default: 300)

Defines the update interval of the sensor in seconds. Defaults to 300 (5 minutes).

Dynamic Configuration

Tracking can be set up to track entities of type device_tracker, zone, sensor and person. If an entity is placed in the origin or destination then every 5 minutes when the platform updates, it will use the latest location of that entity.

# Example entry for configuration.yaml
sensor:
  # Tracking entity to entity
  - platform: here_travel_time
    api_key: "YOUR_API_KEY"
    name: Phone To Home
    origin_entity_id: device_tracker.mobile_phone
    destination_entity_id: zone.home
  # Full config
  - platform: here_travel_time
    api_key: "YOUR_API_KEY"
    name: Work to Home By Bike
    origin_entity_id: zone.work
    destination_latitude: 59.2842
    destination_longitude: 59.2642
    mode: bicycle
    route_mode: fastest
    traffic_mode: false
    unit_system: imperial
    departure: "17:00:00"
    scan_interval: 2678400 # 1 month

Entity Tracking

device_tracker
- If the state is a zone, then the zone location will be used
- If the state is not a zone, it will look for the longitude and latitude attributes
zone
- Uses the longitude and latitude attributes
sensor
- If the state is a zone, then will use the zone location
- All other states will be passed directly into the HERE API
  - This includes all valid locations listed in the Configuration Variables

Updating sensors on-demand using Automation

You can also use the homeassistant.update_entity service to update the sensor on-demand. For example, if you want to update sensor.morning_commute every 2 minutes on weekday mornings, you can use the following automation:

automation:
- id: update_morning_commute_sensor
  alias: "Commute - Update morning commute sensor"
  initial_state: 'on'
  trigger:
    - platform: time_pattern
      minutes: '/2'
  condition:
    - condition: time
      after: '08:00:00'
      before: '11:00:00'
    - condition: time
      weekday:
        - mon
        - tue
        - wed
        - thu
        - fri
  action:
    - service: homeassistant.update_entity
      entity_id: sensor.morning_commute