config.example.yml

# This is an example config file with all available options and explanations for anything that isn't necessarily obvious.
# For a simpler example, please refer to the config.simple.example.yml file. Please also refer to the README for more information.

# In this config example, there are three garage doors we wish to control that are connected to the same account.
# The first garage door houses 2 Tesla vehicles, while the second and third garage doors house a single Tesla vehicle each.
# Anytime a garage door is operated by this app, it will wait the configured 5 minutes "cooldown" before allowing
# further operations on that specific garage door.

## NOTE ##
# Spacing is very important in this file, particularly the leading spacing (indentations). Failure to properly indent may cause config parsing to fail silently

global:
  mqtt_host: localhost # dns, container name, or IP of teslamate's mqtt host
  mqtt_port: 1883
  mqtt_client_id: tesla-youq # optional, arbitrary client name for MQTT connection; must not be the same as any other MQTT client name, will use random uuid if omitted
  mqtt_user: mqtt_user # optional, only define if your mqtt broker requires authentication, can also be passed as env var MQTT_USER
  mqtt_pass: mqtt_pass # optional, only define if your mqtt broker requires authentication, can also be passed as env var MQTT_PASS
  mqtt_use_tls: false # optional, instructs app to connect to mqtt broker using tls (defaults to false)
  mqtt_skip_tls_verify: false # optional, if mqtt_use_tls = true, this option indicates whether the client should skip certificate validation on the mqtt broker
  cooldown: 5 # minutes to wait after operating garage before allowing another garage operation
  myq_email: myq@example.com # email to auth to myq account; can also be passed as env var MYQ_EMAIL
  myq_pass: super_secret_password # password to auth to myq account; can also be passed as env var MYQ_PASS
  cache_token_file: config/token_cache.txt # location to cache myq auth token; omit to disable caching token; useful to prevent generating too many myq auth requests, especially when testing
  # WARNING: using cache_token_file will store your auth token in plaintext at the specified location!

garage_doors:
  - # main garage example
    circular_geofence: # circular geofence with a center point, open and close distances (radii)
      center:
        lat: 46.19290425661381
        lng: -123.79965087116439
      close_distance: .013 # distance in kilometers car must travel away from garage location to close garage door
      open_distance: .04 # distance in kilometers car must be in range of garage location while traveling closer to it to open garage door
    myq_serial: myq_serial_1 # serial number of garage door opener; see README for more info
    cars: # list of cars that use this garage door
      - teslamate_car_id: 1 # id used for the first vehicle in TeslaMate's MQTT broker
      - teslamate_car_id: 2 # id used for the second vehicle in TeslaMate's MQTT broker
  
  - # 3rd car garage example
    teslamate_geofence: # uses geofences defined in teslamate; this method is less reliable and not recommended; see Notes section in the README for details
      close_trigger: # define which geofence changes trigger a close action (e.g. moving from `home` geofence to `not_home`)
        from: home
        to: not_home
      open_trigger: # define which geofence changes trigger an open action (e.g. moving from `not_home` geofence to `home`)
        from: not_home
        to: home
    myq_serial: myq_serial_2 # serial number of garage door opener; see README for more info
    cars:
      - teslamate_car_id: 3 # id used for the third vehicle in TeslaMate's MQTT broker
  
  - # 4th car detached garage example
    polygon_geofence: # custom defined polygonal geofence
      kml_file: ../../resources/polygon_map.kml # optional, path to kml file to load polygon geofences; define this OR the `open` and `close` definitions below
      open: # when vehicle moves from outside to inside this geofence, garage will 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: # when vehicle moves from inside to outside this geofence, garage will 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_3 # serial number of garage door opener; see README for more info
    cars:
      - teslamate_car_id: 4 # id used for the third vehicle in TeslaMate's MQTT broker