Skip to content

Homebridge Opener Config Options

brchri edited this page Dec 7, 2023 · 1 revision

If your smart garage door opener is controlled by Homebridge, Tesla-GeoGDO can use homebridge to execute opener events. Use the attributes defined here for this purpose.

type

  • Type: string
  • Default: undefined
  • Required: true
  • Permitted Values: homeassistant, homebridge, ratgdo, http, mqtt
  • Description: The type of opener to be defined. For the settings described in this page, homebridge should be used. For the other types, see their respective Config Options pages

settings.connection.host

  • Type: string
  • Default: undefined
  • Required: true
  • Description: IP, DNS, or container name (if on the same docker network) of homebridge

settings.connection.port

  • Type: integer
  • Default: 8581
  • Required: false
  • Description: Port on which homebridge accepts traffic

settings.connection.user

  • Type: string
  • Default: undefined
  • Required: true
  • Description: Username to authenticate to Homebridge

settings.connection.pass

  • Type: string
  • Default: undefined
  • Required: true
  • Description: Password to authenticate to Homebridge

settings.connection.use_tls

  • Type: boolean
  • Default: false
  • Required: false
  • Description: Instructs Tesla-GeoGDO to communicate with homebridge over TLS

settings.connection.skip_tls_verify

  • Type: boolean
  • Default: false
  • Required: false
  • Description: If communicating with homebridge over TLS, instructs Tesla-GeoGDO to skip certificate validation (useful for self-signed certificates, but lowers security)

settings.timeout

  • Type: integer
  • Default: 30
  • Required: false
  • Description: Number of seconds to wait for successful execution of garage door command before timing out

settings.accessory

  • Type: accessory definition
  • Default: undefined
  • Required: true
  • Description: Defines the accessory of the garage door as configured in Homebridge. To obtain this information, add /swagger to your Homebridge URL, click Authorize on the top right and enter your username and password. Then go to the Accessories section and expand /api/accessories, click Try it out, then Execute, and look for your garage door and copy the uniqueId listed. Then expand GET /api/accessories/{uniqueId}, click Try it out, paste the uniqueId in the field, and click Execute. Use the values here to determine how to configure the Homebridge opener in this section.

settings.accessory.unique_id

  • Type: string
  • Default: undefined
  • Required: true
  • Description: Unique ID of the garage door accessory in Homebridge

settings.accessory.characteristics.status

  • Type: string
  • Default: undefined
  • Required: false
  • Description: Defines which characteristic returns status information about the garage door (e.g. CurrentDoorState)

settings.accessory.characteristics.command

  • Type: string
  • Default: undefined
  • Required: true
  • Description: Defines which characteristic controls the garage door (e.g. TargetDoorState)

settings.accessory.values.open

  • Type: string or integer
  • Default: undefined
  • Required: true
  • Description: Defines which value should be sent to the command characteristic to open the door

settings.accessory.values.close

  • Type: string or integer
  • Default: undefined
  • Required: true
  • Description: Defines which value should be sent to the command characteristic to close the door

Example (make sure to include leading spaces):

    opener:
      type: homebridge
      settings:
        connection:
          host: homebridge.local
          port: 8581
          user: my_username
          pass: my_password
          use_tls: false
          skip_tls_verify: false
        timeout: 30
        accessory:
          unique_id: some_long_id
          characteristics:
            status: CurrentDoorState
            command: TargetDoorState
            values:
              open: 0
              close: 1

Config Options

Geofence Config Options

Opener Config Options

Clone this wiki locally