update mychevy component docs (#7745)

The mychevy component finally is working again due to someone finally
fixing their website to be more reliable. This component no longer
uses selenium web scraping, which makes it more useful to
others. Hopefully their website is more reliable this time around!
This commit is contained in:
Sean Dague 2018-12-06 07:16:38 -05:00 committed by Fabian Affolter
parent 5284931c8c
commit 8ac4f35d7d

View File

@ -13,7 +13,12 @@ ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
The `mychevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data.
The `mychevy` component communicates with
the [my.chevrolet](https://my.chevrolet.com) website using the
javascript API that the website uses (as of Dec 2018). The mychevy
website has been known to be both unstable (interfaces changing
somewhat willy nilly) and have substantial outages. So be forwarned in
using this component.
This component provides the following platforms:
@ -43,17 +48,13 @@ password:
{% endconfiguration %}
### {% linkable_title Installation %}
Because this uses selenium behind the scenes, installation is more complicated than merely `pip` install. See the [installation instructions](https://github.com/sdague/mychevy).
### {% linkable_title Limitations %}
The architecture of the GM automotive networking imposes some limitations on the functionality of the component.
The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the mychevy component only polls every 30 minutes to not overwhelms that connection.
The OnStar network (or more specifically the gateway used by the my.chevrolet website) appears to suffer more than most networks when the car is a) in a garage, and b) it's cold outside (like < 15 degrees F). One of the provided sensors is a status sensor which indicates if we got connectivity with the car on the last polling cycle or not.
The "API" for this is written by web scraping. As such, it only currently is known to work if you have a Chevy Bolt EV, and only 1 Chevy car connected to OnStar. Patches for extended support should go to the https://github.com/sdague/mychevy project first, then Home Assistant can be extended.
The OnStar network (or more specifically the gateway used by the my.chevrolet website) appears to suffer more than most networks when the car is a) in a garage, and b) it's cold outside (like < 15 degrees F). One of the provided sensors is a status sensor which indicates if we got connectivity with the car on the last polling cycle or not.
The "API" for this is written through using some existing API calls
from the javascript web ui. As such, it only currently is known to work if you have a Chevy Bolt EV, and only 1 Chevy car connected to OnStar. Patches for extended support should go to the https://github.com/sdague/mychevy project first, then Home Assistant can be extended.