Skip to content

Latest commit

 

History

History
206 lines (172 loc) · 11.4 KB

README.md

File metadata and controls

206 lines (172 loc) · 11.4 KB
Raw

New Project

Due to the deprecation of MyQ (see Notice of Deprecation below), this project has been forked to the new app, Tesla-GeoGDO. This new project continues the work of automatically controlling smart garage door openers based on the location of Tesla vehicles. It deprecates MyQ support and adds support for other smart garage door openers, such as ratgdo and MQTT/HTTP-controlled openers, with a refactored codebase to make it easier to add support for additional opener types in the future (such as Meross).

Notice of Deprecation

MyQ has, unfortunately, amped up their efforts to restrict 3rd party integration access to their APIs. Because of this, Tesla-YouQ, along with other 3rd party integrations for MyQ such as Home Assistant and Homekit, will no longer function. As such, this app will no longer be developed.

Tesla-YouQ

A lightweight app that will operate your MyQ connected garage doors based on the location of your Tesla vehicles, automatically closing when you leave, and opening when you return. Supports multiple vehicles and MyQ devices.

Prerequisite

This app uses the MQTT broker bundled with TeslaMate. You must be running TeslaMate and have the MQTT broker exposed for consumption to use this app. TeslaMate has done a lot of work in scraping API data while minimizing vampire drain on vehicles from API requests, and TeslaMate has many other features that make it more than worthwhile to use in addition to this app.

How to use

Docker

This app is provided as a docker image. You will need to download the config.example.yml file (or the simplified config.simple.example.yml), edit it appropriately (make sure to preserve the leading spaces, they are important), and then mount it to the container at runtime. For example:

# see docker compose example below for parameter explanations
docker run \
  --user 1000:1000 \
  -e [email protected] \
  -e MYQ_PASS=my_super_secret_pass \
  -e TZ=America/New_York \
  -v /etc/tesla-youq:/app/config \
  brchri/tesla-youq:latest

Or you can use a docker compose file like this:

version: '3.8'
services:
  tesla-youq:
    image: brchri/tesla-youq:latest
    container_name: tesla-youq
    user: 1000:1000 # optional, sets user to run in container; must have read access to mounted config volume (+ write if using token caching)
    environment:
      - [email protected] # optional, can also be saved in the config.yml file
      - MYQ_PASS=my_super_secret_pass # optional, can also be saved in the config.yml file
      - TZ=America/New_York # optional, sets timezone for container
    volumes:
      - /etc/tesla-youq:/app/config # required, mounts folder containing config file(s) into container
    restart: unless-stopped

Supported Environment Variables

The following Docker environment variables are supported but not required.

Variable Name Type Description
CONFIG_FILE String (Filepath) Path to config file within container
MYQ_EMAIL String Email to authenticate to MyQ account. Can be used instead of setting myq_email in the config.yml file
MYQ_PASS String Password to authenticate to MyQ account. Can be used instead of setting myq_pass in the config.yml file
MQTT_USER String User to authenticate to MQTT broker. Can be used instead of setting mqtt_user in the config.yml file
MQTT_PASS String Password to authenticate to MQTT broker. Can be used instead of setting mqtt_pass in the config.yml file
DEBUG Bool Increases output verbosity
TESTING Bool Will perform all functions except actually operating garage door, and will just output operation would've happened
TZ String Sets timezone for container

Notes

Serials

The serial displayed in your MyQ app may not be the serial used to control your door (e.g. it may be the hub rather than the opener). You can run this app with the -d flag to list your device serials and pick the appropriate one (listed with type: garagedooropener). Example:

docker run --rm \
  -e [email protected] \
  -e MYQ_PASS=supersecretpass \
  brchri/tesla-youq:latest \
  tesla-youq -d

Geofence Types

You can define 3 different types of geofences to trigger garage operations. You must configure one and only one geofence type for each garage door. Each geofence type has separate open and close configurations (though they can be set to the same values). This is useful for situations where you might want a smaller geofence that closes the door so you can visually confirm it's closing, but you want a larger geofence that opens the door so it will start sooner and be fully opened when you actually arrive.

Note you do not need to define both open and close for a geofence, you may only define one or the other if you don't wish to have Tesla-YouQ both open and close your garage.

Circular Geofence

This is the simplist geofence to configure. You provide a latitude and longitude coordinate as the center point, and the distance from the center point to trigger the garage action (in kilometers). You can use a tool such as FreeMapTools to determine what the center latitude and longitude coordinates are, as well as how big your want your radius to be. An example of a garage door configured with this type of geofence would look like this:

garage_doors:
  - circular_geofence:
      center:
        lat: 46.19290425661381
        lng: -123.79965087116439
      close_distance: .013
      open_distance: .04
    myq_serial: myq_serial_1
    cars:
      - teslamate_car_id: 1

This would produce two circular geofences (open and close) that look like this:

image

Under this configuration, your garage would start to open when you entered the open_distance area, and would start to close as you exit the close_distance area.

TeslaMate Defined Geofence

You can choose to use geofences defined in TeslaMate. To define these geofences, go to your TeslaMate page and click Geo-Fences at the top, and create a new fence (or reference your existing fences). Some notes about using TeslaMate Defined Geofences:

  • TeslaMate does not update its geofence calculations in realtime. This will cause delays in your garage door operations.
  • You cannot define overlapping geofences in TeslaMate, as it will cause TeslaMate to behave unexpectedly as it cannot determine which Geofence you should be in when you're in more than one. This means you cannot define separate open and close geofences and should only use a single geofence.
  • You must configure TeslaMate to have a "default" geofence when no defined geofences apply. You do this by configuring an environment variable for TeslaMate, such as DEFAULT_GEOFENCE=not_home.
  • In general, it is not recommended to use this method as it is the least reliable due to how TeslaMate updates the Geofence data.

An example of a garage door configured with this type of geofence would look like this:

garage_doors:
  - teslamate_geofence:
      close_trigger:
        from: home
        to: not_home
      open_trigger:
        from: not_home
        to: home
    myq_serial: myq_serial_1
    cars:
      - teslamate_car_id: 1

Polygon Geofence

This is the most customizable method of defining a geofence, which allows you to specifically define a polygonal geofence using a list of latitude and longitude coordinates. You can use a tool like geojson.io to assist with creating a geofence and providing latitude and longitude points. NOTE: Using tools like this often specify longitude before latitude in the output, as defined by the KML spec. Be sure you're identifying the latitude and longitude correctly.

An example of a garage door configured with this type of geofence would look like this:

garage_doors:
  - polygon_geofence:
      open:
        - lat: 46.193245921812746
          lng: -123.7997972320742
        - lat: 46.193052416203386
          lng: -123.79991877106825
        - lat: 46.192459275200264
          lng: -123.8000342331126
        - lat: 46.19246067743231
          lng: -123.8013205208015
        - lat: 46.19241300151987
          lng: -123.80133064905115
        - lat: 46.192411599286004
          lng: -123.79997751491551
        - lat: 46.1927747765306
          lng: -123.79954200018626
        - lat: 46.19297669643191
          lng: -123.79953592323656
        - lat: 46.193245921812746
          lng: -123.7997972320742
      close:
        - lat: 46.192958467582514
          lng: -123.7998033090239
        - lat: 46.19279440766502
          lng: -123.7998033090239
        - lat: 46.19279440766502
          lng: -123.79950958978756
        - lat: 46.192958467582514
          lng: -123.79950958978756
        - lat: 46.192958467582514
          lng: -123.7998033090239
    myq_serial: myq_serial_1
    cars:
      - teslamate_car_id: 1

Or, using a tool referenced above or any other of your choosing, you can generate and download a KML file containing your polygon geofences instead of manually defining the points in your config file. Be sure that the KML file is in a mounted volume and accessible within the container. Within your KML file, you must define a name element within each Placemark element for each geofence, with the value open or close accordingly. Please see the polygon_map.kml file for an example.

An example of a garage door configured this way would look like this:

garage_doors:
  - polygon_geofence:
      kml_file: config/polygon_geofences.kml
    myq_serial: myq_serial_1
    cars:
      - teslamate_car_id: 1

Either of these configs would produce two polygonal geofences (open and close) that look like this:

image

Under this configuration, your garage would start to open when you entered the open area, and would start to close as you exit the close area.

Operation Cooldown

There's a configurable cooldown parameter in the config.yml file's global section that will allow you to specify how many minutes Tesla-YouQ should wait after operating a garage door before it attemps any further operations. This helps prevent potential flapping if that's a concern.

Credits