Skip to content

Polygon Geofence Config Options

brchri edited this page Dec 7, 2023 · 2 revisions

These options define a polygon geofence type, and should be used in the garage_doors section of the config. Each garage door listed in this section must have a geofence type defined.

type

  • Type: string
  • Default: undefined
  • Required: true
  • Permitted Values: circular, teslamate, polygon
  • Description: The type of geofence to be defined. For the settings described in this page, polygon should be used. For the other types, see their respective Config Options pages

settings.kml_file

  • Type: string (file path)
  • Default: undefined
  • Required: false
  • Description: The location of the KML file used to define the geofence. This can be used instead of listing out the latitude and longitudes directly in the config file. Because Tesla-GeoGDO runs in a docker container, the file must be accessible to the container and the file path must be relative to the container's mount points. The user defined for the container must also have read access to the file.

settings.open

  • Type: list of lat and lng pairs (float types)
  • Default: undefined
  • Required: false
  • Description: List of latitude and longitude pairs to define the polygon geofence. Omit if you do not wish to automatically open your garage or if using a KML file

settings.open

  • Type: list of lat and lng pairs (float types)
  • Default: undefined
  • Required: false
  • Description: List of latitude and longitude pairs to define the polygon geofence. Omit if you do not wish to automatically close your garage or if using a KML file

Example (make sure to include leading spaces):

    geofence:
      type: polygon
      settings:
        kml_file: ../../resources/polygon_map.kml
        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

Config Options

Geofence Config Options

Opener Config Options

Clone this wiki locally