catduckgnaf / linktap_local_http_component Goto Github PK

A custom component for linktap tap and watering valve controllers.

Linktap already have an MQTT implementation, but for home assistant users its support is rudimentary. They have a more advanced mode of operation via MQTT, but it involves complicated manual setup of switches and sensors. This custom component replaces both of those mechanisms, and uses the locally available HTTP API.

It requires just the configuration IP of your gateway. If you have more than 1 gateway, you can setup multiple instances of the integration.

A device is created for each tap found. Multi-valve TapLinkers or ValveLinkers will get a device created for each output.
Note: version x060820 (x is S or G, indicating that the firmware belongs to GW-01 or GW-02, respectively) is required on your Linktap Gateway in order for this component to work.

For each device, multiple entities are created:
binary sensors:

• Is Linked
• Has a fall alert
• Has a cutoff alert
• Is leaking
• Is clogged
• Is broken

Binary sensors also have some services registered:
dismiss_alerts: dismiss all alerts
dismiss_alert: dismisses a single alert. Takes an entity ID of one of the binary sensors.

sensors:

• Signal Strength
• Battery
• Total Duration
• Remaining Duration
• Speed
• Volume
• Volume Limit
• Failsafe Duration
• Plan Mode
• Plan SN

number:

• Watering Duration (Defaults to 15 minutes)
• Watering Volume (Defaults to 0)

Note:The volume unit is pulled from the gateway. It can either be in L or Gal.

These control the watering time and volume, when the switch for a tap is turned on.
If duration is 0 AND volume is 0, default time is applied (currently 15 mins)
If duration is 0 AND volume is >0, water by volume is used
If duration > 0 AND volume is 0, water by duration is used
If both duration AND volume > 0, both duration AND volume are used, and tap will turn off when either is reached

NOTE: WATER BY VOLUME IS CURRENTLY PENDING A NEW RELEASE FROM LINKTAP. Until this is released, the volume parameter will have no effect.

switch:
The tap/valve itself.

As yet there is no support for controlling scheduling. The API does have support for this, but unless there is demand for it, this is likely more clunky to manage in Home Assistant than the native app.