Skip to content

Latest commit

History

History
70 lines (49 loc) 路 8.87 KB

FeatureOptions.md

File metadata and controls

70 lines (49 loc) 路 8.87 KB

homebridge-ratgdo: Native HomeKit support for Ratgdo

Homebridge Ratgdo

Downloads Version Ratgdo@Homebridge Discord verified-by-homebridge

Ratgdo-enabled garage door opener support for Homebridge.

homebridge-ratgdo is a Homebridge plugin that makes Chamberlain, Liftmaster, and other garage door openers that utilize the Ratgdo hardware control board available to Apple's HomeKit smart home platform. You can determine if your garage door opener by checking the Ratgdo website.

Feature Options

Feature options allow you to enable or disable certain features in this plugin. These feature options provide unique flexibility by also allowing you to set a scope for each option that allows you more granular control in how this plugin makes features and capabilities available in HomeKit.

The priority given to these options works in the following order, from highest to lowest priority where settings that are higher in priority will override the ones below:

  • Device options that are enabled or disabled.
  • Global options that are enabled or disabled.

All feature options can be set at any scope level, or at multiple scope levels. If an option isn't applicable to a particular category of device, it is ignored. If you want to override a global feature option you've set, you can override the global feature option for the individual device, if you choose.

Important

It's strongly recommended that you use the Homebridge webUI](https://github.com/homebridge/homebridge-config-ui-x) to configure this plugin - it's easier to use for most people, and will ensure you always have a valid configuration.**

Feature Options Reference

Feature options provide a rich mechanism for tailoring your homebridge-ratgdo experience. The reference below is divided into functional category groups:

  • Device: Device feature options.
  • Opener: Opener feature options.
  • Light: Opener light feature options.
  • Motion: Opener motion feature options.

Device feature options.

Option Description
Device Make this device available in HomeKit. (default: enabled).

Opener feature options.

Option Description
Opener.ReadOnly Make this opener read-only by ignoring open and close requests from HomeKit. (default: disabled).
Opener.Dimmer Add a dimmer accessory to control the opener. This can be useful in automation scenarios where you want to set the door to a specific percentage. (default: disabled).
Opener.Switch Add a switch accessory to control the opener. This can be useful in automation scenarios where you want to work around HomeKit's security restrictions for controlling garage door openers. (default: disabled).
Opener.OccupancySensor Add an occupancy sensor accessory using the open state of the opener to determine occupancy. This can be useful in automation scenarios where you want to trigger an action based on the opener being open for an extended period of time. (default: disabled).
Opener.OccupancySensor.Duration<I>.Value</I> Duration, in seconds, to wait once the opener has reached the open state before indicating occupancy. (default: 300).
Opener.Switch.RemoteLockout Add a switch accessory to control the wireless remote lockout feature (if present) on your opener. This can be useful in automation scenarios where you want to work around HomeKit's security restrictions for controlling the lock state of garage door openers. (default: disabled).

Opener light feature options.

Option Description
Light Make the light on the opener available in HomeKit. (default: enabled).

Opener motion feature options.

Option Description
Motion Make the motion sensor on the opener available in HomeKit. (default: enabled).
Motion.OccupancySensor Add an occupancy sensor accessory using motion sensor activity to determine occupancy. (default: disabled).
Motion.OccupancySensor.Duration<I>.Value</I> Duration, in seconds, to wait without receiving a motion event to determine when occupancy is no longer detected. (default: 300).