Skip to content

leak Device

Erik Baauw edited this page Apr 16, 2021 · 3 revisions

leak Device

A leak device exposes a water leak sensor connected to a GPIO pin. Homebridge RPi configures the GPIO pin for input. By default, Homebridge RPi configures the internal pull-up resister for the GPIO pin. Homebridge RPi configures pigpiod to send real-time notifications when the GPIO state changes. Homebridge RPi debounces the input signal; currently this is hard-coded to 20 msec.

The device is exposed as a separate HomeKit accessory, with a Leak Sensor service. Through this service, you can monitor the motion sensor state in HomeKit, or even configure HomeKit push notifications.

The leak device uses the following config.json keys:

key type Description
name string The name for the device in HomeKit.
gpio integer The GPIO pin.
pull string The configuration of the internal pull-up/pull-down resistor for the GPIO pin: off, down, or up (default).
reversed boolean The device state is reversed, i.e. report leak detected when the GPIO pin is high instead of on low.