diff --git a/source/_integrations/subaru.markdown b/source/_integrations/subaru.markdown index c9f396a143f..152c88c591f 100644 --- a/source/_integrations/subaru.markdown +++ b/source/_integrations/subaru.markdown @@ -3,6 +3,7 @@ title: Subaru description: Instructions on how to setup your Subaru account with Home Assistant. ha_category: - Car + - Lock - Sensor ha_release: 2021.3 ha_iot_class: Cloud Polling @@ -11,14 +12,15 @@ ha_codeowners: - '@G-Two' ha_domain: subaru ha_platforms: + - lock - sensor --- -The Subaru integration retrieves information provided by Subaru connected vehicle services. Before using this integration, you must first register and have login credentials to [MySubaru](https://www.mysubaru.com). +This integration retrieves vehicle information and actuates remote services provided by [Subaru STARLINK](https://www.subaru.com/engineering/starlink/safety-security.html) (currently only available in USA and Canada). -This integration requires an active vehicle subscription to the [Subaru STARLINK](https://www.subaru.com/engineering/starlink/safety-security.html) service (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](https://www.mysubaru.com). -Currently, this integration only provides the Sensor platform. Subaru has deployed two generations of telematics, Gen 1 and Gen 2. The latter offers much more vehicle information. Use the tables below to determine which sensors are available to your vehicle. +Subaru has deployed two generations of telematics, Gen 1 and Gen 2. The latter offers more vehicle sensor information and additional remote capabilities. Use the table below to determine your vehicle's telematics generation and capabilities. | Model | Gen 1 | Gen 2 | |-----------|-----------|-------| @@ -30,6 +32,18 @@ Currently, this integration only provides the Sensor platform. Subaru has deploy | Outback | 2016-2019 | 2020+ | | WRX | 2017+ | | +In addition to the telematics generational differences, there are two levels of STARLINK subscriptions, "Safety Plus" and "Security Plus". All remote services (such as locks) require a "Security Plus" level subscription. + +{% include integrations/config_flow.md %} + +

+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. +

+ +## Sensors + +Available sensors will vary by model, year, and subscription type. The integration will add all supported sensors for your vehicle. Sensor data is usually only updated when the vehicle is turned off unless the [polling option](#options) is enabled. + | Sensor | Gen 1 | Gen 2 | |--------------------------|---------|---------| | 12V battery voltage | | ✓ | @@ -44,10 +58,11 @@ Currently, this integration only provides the Sensor platform. Subaru has deploy \* Gen 1 odometer only updates every 500 miles
-{% include integrations/config_flow.md %} +## Lock +This integration supports remote locking and unlocking of vehicle doors.

-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. +The current lock status is always unknown due to the fact that the Subaru API does not report this data.

## Options @@ -56,9 +71,7 @@ Subaru integration options are set via: **Configuration** -> **Devices & Services** -> **Subaru** -> **Options**. -The only option is: - -- **Enable vehicle polling *[Default: off]*:** When enabled, vehicle polling will send a remote command to your vehicle every 2 hours to obtain new sensor data. This involves "waking" your vehicle and requesting that it send new data to Subaru servers. Without vehicle polling, new sensor data is only received when the vehicle automatically pushes data (normally after engine shutdown). This option only applies to Gen 2 vehicles with Security Plus subscriptions. +- **Enable vehicle polling *[Default: off]*:** When enabled, vehicle polling will send a remote command to your vehicle every 2 hours to obtain new sensor data. This involves "waking" your vehicle and requesting that it send new data to Subaru servers. Without vehicle polling, new sensor data is only received when the vehicle automatically pushes data (normally after engine shutdown). This option only applies to Gen 2 vehicles with Security Plus subscriptions because it uses a "locate" command to request the data.

Vehicle polling draws power from the 12V battery. Long term use without driving may drain the battery resulting in the inability to start. @@ -66,20 +79,20 @@ Vehicle polling draws power from the 12V battery. Long term use without driving ## FAQ - Troubleshooting -**Q:** I have a Subaru STARLINK Security Plus subscription. How do I use the locator, remote lock and remote horn features in Home Assistant? +**Q:** I have a Subaru STARLINK Security Plus subscription. How do I use the locator, and remote light/horn features in Home Assistant? -**A:** Those features are supported by the underlying `subarulink` Python package, and will be integrated into Home Assistant soon. Both Gen 1 and Gen 2 will be supported. +**A:** Those features are supported by the underlying [subarulink](https://github.com/G-Two/subarulink) Python package, and will be integrated into Home Assistant soon. Both Gen 1 and Gen 2 will be supported. --- **Q:** Will remote start ever be supported? -**A:** Yes, Gen 2 remote start and climate settings are supported by the underlying `subarulink` Python package, and will be integrated into Home Assistant soon. +**A:** Yes, Gen 2 remote start and climate settings are supported by the underlying [subarulink](https://github.com/G-Two/subarulink) Python package, and will be integrated into Home Assistant soon. --- **Q:** Why do I need to enter my PIN during configuration? -**A:** The PIN is saved to your configuration to support vehicle polling, since a remote update command is being sent to your vehicle. In addition, the PIN will be used to support remote locator, lock, lights/horn in the future. +**A:** The PIN is saved to your configuration to support vehicle polling, since a remote update command is being sent to your vehicle. In addition, the PIN is used to support the lock platform and will be used for the remote start, locator, and lights/horn functions in the future. --- @@ -97,4 +110,4 @@ Vehicle polling draws power from the 12V battery. Long term use without driving **Q:** Should I enable the vehicle polling option? -**A:** Probably not. One use case is if you have a PHEV and want to monitor your charging progress. Another use case is if you want to use your vehicle as a temperature sensor. Otherwise, the data isn't going to change much after you've shutdown your vehicle. A future revision will expose vehicle polling as a service to enable incorporation into automations. +**A:** Probably not. One use case is if you have a PHEV and want to monitor your charging progress. Another use case is if you want to use your vehicle as a temperature sensor. Otherwise, the data isn't going to change much after you've shutdown your vehicle. A future revision will expose vehicle polling as a service to enable incorporation into automations.