Subaru STARLINK Integration for Home Assistant

Note

The Subaru integration is now part of Home Assistant Core (as of release 2021.3), however not all features have been implemented. Currently, only the device tracker, sensor, and lock platforms are available. Additional PRs will be submitted to include all features of this custom component into Home Assistant Core. Users that desire full functionality should continue to use this custom component until all functionality is merged into Home Assistant Core. When installed, this custom component overrides the Home Assistant Core built-in Subaru integration.

Description
Installation
- HACS
- Manual
Configuration
Options
Services
Events

Description

This Home Assistant custom component retrieves vehicle information and actuates remote services provided by Subaru STARLINK (currently only available in USA and Canada).

This integration requires a telematics equipped Subaru and an active vehicle subscription to the Subaru STARLINK service. Before using this integration, you must first register and have login credentials to MySubaru.

Subaru has deployed three generations of STARLINK telematics. Use the table below to determine which generation your vehicle is. This table is a best guess based upon what Subaru lists as available features.

Model	Gen 1	Gen 2	Gen 3
Ascent	---	2019-2023	2024+
BRZ	---	2022-2023	---
Crosstrek	2016-2018	2019+	---
Forester	2016-2018	2019+	---
Impreza	2016-2018	2019-2022	2023+
Legacy	2016-2019	2020-2022	2023+
Outback	2016-2019	2020-2022	2023+
WRX	2017-2021	2022-2023	---

Sensors

Sensor	Gen 1	Gen 2	Gen 3
Average fuel consumption		✓	✓
Distance to empty		✓	✓
EV battery level		✓	?
EV range		✓	?
EV time to full charge		✓	?
Odometer	✓*	✓	✓
Tire pressures		✓	✓

* Gen 1 odometer only updates every 500 miles

Binary Sensors

Binary Sensor	Gen 2	Gen 3
Door/Trunk/Hood Status	✓	✓
Window Status	✓*	✓
Ignition Status	✓	✓
EV Plug/Charging Status	✓*	?

* Not supported by all vehicles

Device Tracker

Device tracker, lock, and buttons (except refresh) all require a STARLINK Security Plus subscription:

Device Tracker	Gen 1	Gen 2	Gen 3
Vehicle Location	✓	✓	✓

Lock

Lock	Gen 1	Gen 2	Gen 3
Remote lock/unlock	✓	✓	✓

This integration supports remote locking and unlocking of vehicle doors. If doors are remotely unlocked, they will automatically relock if a door is not opened within a minute. There is no remote notification of this automatic relock.

Note

The actual lock status is always unknown due to the fact that the Subaru API does not report this data.

Buttons

Buttons	Gen 1	Gen 2	Gen 3
Start/Stop Horn/Lights	✓	✓	✓
Poll vehicle	✓	✓	✓
Refresh data	✓	✓	✓
Start/Stop Horn/Lights	✓	✓	✓
Start/Stop Engine		✓*	✓*
Start EV charging		✓*	?

* Not supported by all vehicles

Installation

HACS

Add https://github.com/G-Two/homeassistant-subaru as a custom integration repository and install the Subaru (HACS) integration. Restart Home Assistant.

Manual

Clone or download this repository, and copy the custom_components/subaru directory into the config/custom_components directory of your Home Assistant instance. Restart Home Assistant.

Configuration

Once installed, the Subaru integration is configured via the Home Assistant UI:

Configuration -> Devices & Services -> Add Integration -> Subaru (HACS)

Important

After installation and HA restart, you may need to clear your browser cache for the new integration to appear.

When prompted, enter the following configuration parameters:

Email Address: The email address associated with your MySubaru account
Password: The password associated with your MySubaru account
Country: The country your MySubaru account is associated with

After your account is authenticated, you will need to authorize the application with Subaru's two factor authentication. Follow the prompts to select a phone number or email address to receive a verification code and enter when prompted. This should only need to be accomplished during initial configuration.

After successful authorization, if a supported remote services vehicle with active subscription is found in your account, an additional prompt will appear:

PIN: The PIN associated with your MySubaru account

Important

If your account includes multiple vehicles, the same PIN will be used for all vehicles. Ensure that you have configured all vehicles in your account to have the same PIN.

If the PIN prompt does not appear, no supported remote services vehicles were found in your account. Limited vehicle data may still appear as sensors.

Options

Subaru integration options are set via:

Configuration -> Devices & Services -> Subaru (HACS) -> Configure.

All options involve remote commands, thus only apply to vehicles with Security Plus subscriptions:

Enable vehicle polling: Sensor data reported by the Subaru API only returns what is cached on Subaru servers, and does not necessarily reflect current conditions. The cached data is updated when the engine is shutdown, or when a location update is requested. This options enables automatic periodic updates.
- Disable [Default]: New sensor data is only received when the vehicle automatically pushes data (normally after engine shutdown). The user may still manually poll the vehicle anytime with the Locate button.
- Charging: For PHEVs, during charging, the integration will poll every 30 minutes to obtain updated charging status. Polling will only occur during charging.
- Enable: Every 2 hours, the integration will send a remote command (equivalent to pressing the Locate button), "waking" your vehicle obtain new sensor data.

Warning

Vehicle polling draws power from the 12V battery. Long term use without driving may drain the battery resulting in the inability to start your vehicle.

Lovelace UI notifications for remote commands: It takes 10-15 seconds for remote commands to be processed by the Subaru API and transmitted over the cellular network to your vehicle. Some users may desire UI feedback that the integration is working. This option provides three levels of increasing verbosity:
- Disable [Default]: Lovelace notifications are disabled. Errors will still be logged.
- Failure : Only notify when the remote command has failed.
- Pending: Failure + temporary notification that the command is "working" that will automatically disappear when the Subaru API confirms success (10 to 15 seconds).
- Success: Pending + persistent notification of success in Lovelace. This is the same behavior as v0.5.1 and earlier releases.

Services

The following Subaru entities use built-in Home Assistant services:

Lock
Button (Remote Start/Stop, Lights/Horn, Locate, Refresh)
Select (Climate Control Preset)

The Lock entity's "Unlock" will unlock all doors. The Subaru API supports selecting a specific door to unlock. Users that wish to use this functionality may call an integration specific service which allows the user to choose the door to unlock. See the Services UI in Developer Tools for usage. Example YAML for this service is:

service: subaru.unlock_specific_door
target:
  entity_id: lock.subaru_door_locks
data:
  # Valid values for door are 'all', 'driver', 'tailgate' (note that 'tailgate' is not supported by all vehicles)
  door: driver

Events

subaru_command_sent

This event is fired when a command is called.

Field	Description
`command`	The command that was called. See Command list
`car_name`	The name of the vehicle

subaru_command_successful

This event is fired when a command is successful.

Field	Description
`command`	The command that was called. See Command list
`car_name`	The name of the vehicle

subaru_command_failed

This event is fired when a command fails.

Field	Description
`command`	The command that was called. See Command list
`car_name`	The name of the vehicle
`message`	The message returned from the failed command

Command List

This is a list of possible commands for the above events.

fetch, update, lock, unlock, lights, lights_stop, horn, horn_stop, remote_start, remote_stop, charge_start, preset_name

G-Two / homeassistant-subaru