Garage Door Config Options - brchri/tesla-geogdo GitHub Wiki
Each garage door to be controlled by Tesla-GeoGDO must have a config defined in the garage_doors
section. garage_doors
is a list of doors, each with its own configuration. Any geofence
type can be used with any opener
type.
To make a list in yaml, a -
should be used when beginning a new door definition in the list. Each door should have the following attributes configured:
geofence
- Type: geofence
- Default:
undefined
- Required: true
- Description: Configuration of a supported geofence type
opener
- Type: opener
- Default:
undefined
- Required: true
- Description: Configuration of a supported opener type
trackers
- Type: list of
tracker
- Default:
undefined
- Required: true
- Description: List of
tracker
s, which provide information about how to retrieve latitude and longitude information from an MQTT broker for tracking
trackers.id
- Type: integer or string
- Default:
undefined
- Required: true
- Description: Arbitrary ID used to identify the tracker internally and for logging purposes. Can be a string or integer, but must be unique from all other trackers.
trackers.lat_topic
- Type: string
- Default:
undefined
- Required: false
- Description: MQTT topic to retrieve latitude for a tracker. Expects a simple payload type of "float". Required if not using
trackers.complex_topic
.
trackers.lng_topic
- Type: string
- Default:
undefined
- Required: false
- Description: MQTT topic to retrieve longitude for a tracker. Expects a simple payload type of "float". Required if not using
trackers.complex_topic
.
trackers.complex_topic
- Type: complex topic
- Default:
undefined
- Required: false
- Description: Defines a complex topic that expects a json payload with configurable latitude and longitude keys as top-level keys in the json. Required if not using
trackers.lat_topic
ortrackers.lng_topic
.
trackers.complex_topic.topic
- Type: string
- Default:
undefined
- Required: false
- Description: MQTT topic that provides json payload for latitude and longitude. Required if defining
trackers.complex_topic
trackers.complex_topic.lat_json_key
- Type: string
- Default:
undefined
- Required: false
- Description: Top-level json key to retrieve latitude information from complex topic payload. Required if defining
trackers.complex_topic
trackers.complex_topic.lng_json_key
- Type: string
- Default:
undefined
- Required: false
- Description: Top-level json key to retrieve longitude information from complex topic payload. Required if defining
trackers.complex_topic
Here is an abbreviated example of what the structure of the garage_doors
config should look like. Please refer to the respective geofence
and opener
config pages for more information on how to configure those sections.
garage_doors:
# first garage door
- geofence:
<geofence config>
...
opener:
<opener config>
...
trackers:
- id: 1
lat_topic: teslamate/cars/1/latitude
lng_topic: teslamate/cars/1/longitude
# second garage door
- geofence:
<geofence config>
...
opener:
<opener config>
...
trackers:
- id: 2
lat_topic: teslamate/cars/2/latitude
lng_topic: teslamate/cars/2/longitude
- id: my_user
complex_topic:
topic: owntracks/my_user
lat_json_key: lat
lng_json_key: lon