A custom component for linktap tap and watering valve controllers.
Install this Integration via the Home Assistant Community Store (HACS)
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.
In short, its designed to replicate the "Instant Watering" functionality of the Linktapp app. Ie water for x minutes, or until y volume is reached.
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.
How do I use this integration?
Set the Watering Volume number entity and the Watering Duration number entity to your desired limits, and turn on the switch/valve. Whichever value is reached first will turn the switch/valve off.
If you set the Watering Volume to 0, then the setting is ignored and the switch/valve will turn off when the Watering Duration is reached.
binary sensors:
| Binary Sensor Name | Description |
|---|---|
| Is Linked | Is the tap linked to the gateway? |
| Has a fall alert | Has an alert been raised due to a detected fall? |
| Has a cutoff alert | Has something happened to the tap and it failed to shut off? |
| Is leaking | Has the tap detected a leak? |
| Is clogged | Has the tap detected it is clogged? |
| Is broken | Is the tap in an otherwise broken state? |
| Is Manual Mode | Has the tap been triggered manually (via physical button)? |
| Is Paused | Has the tap been paused? |
| Is Watering | Is the tap currently watering? |
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.
Other than the alerts, the binary sensors are information about a tap, and are not controlled by the integration.
sensors:
| Sensor Name | Description |
|---|---|
| Signal | Strength of the signal between the tap and gateway |
| Battery | Battery level of the tap device |
| Total Duration | Watering duration of the current watering job. Should match the number entity, converted to seconds. |
| Remain Duration | Remaining watering duration, of the current watering job |
| Speed | Water flow speed |
| Volume | Total water volume used for the current watering job. Resets to 0 upon completion to support the energy dashboard |
| Volume Limit | The volume limit set on the current watering job. Should match the number entity if set. |
| Failsafe Duration | The failsafe duration set for the tap - This is not configurable via this integration. |
| Plan Mode | Current watering plan mode. A numerical identifier. |
| Plan Mode String | A translation of the plan mode into the terms matching the app |
| Plan SN | Serial number of the watering plan. A numerical identifier. |
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 by Home Assistant (ignored if ANY OTHER mechanism is used to start watering, iethe manual button, the mobile app, or MQTT).
The water will turn off when either the Watering Duration or Watering Volume is reached (whichever comes first), unless the Watering Volume is set to 0, in which case it is ignored and only Watering Duration is considered.
switch:
The tap controller itself. The switch has a number of attributes. In general these can be ignored, as they have matching sensors and binary_sensors, but are helpful in debugging.
There are 3 additional attributes set by the integration itself.
| Attribute Name | Description |
|---|---|
| Duration Entity | The entity the integration is using to control duration |
| Default time | Is the time being sent set to the default? This will be true if either the number entity has never been changed, OR if the number enttiy cannot be found (eg because its been renamed -- dont do this!) |
| Watering by Volume | Has a volume value been sent to the api when the switch/value was turned on |
valve:
A wrapper for the switch -- a valve for each tap
Using the switch and the valve are functionally equivalent, and the entities should always remain in sync.
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.
Why don't my volume or speed values update? They always show 0.Chances are you have a G1 device. The G1 devices do not have an inbuilt flow meter. To my knowledge there is no way to retrofit one within the linktap ecosystem.
https://www.link-tap.com/#!/faq/en/What-is-the-difference-between-the-G1S-and-G2S-water-timers
Why do my taps always water for 15 mins, rather than the value defined by the duration number entity?
This is likely due to a mapping issue with the integration. Each switch has an attribute called duration_entity. This should match the entity created for duration. If not, please lodge an issue.
There is also an attribute called Default Time. If the duration entity matches, and has been changed from the default, this should be set to false. If not, again please lodge an issue.
This can also occur if you have renamed entities, as it uses some fuzzy logic name matching in order to get the duration. If you have renamed entities in HA, delete the integration, change the names as desired in the Linktap app, and re-add the integration again.
I added a new taplinker or valvelinker to my gateway, and changed the names of them in the app. Why are they called TapLinker 1 and TapLinker 2 in Home Assistant?
There can be a slight delay of up to 30 moinutes between devices being renamed on the mobile app and those changes being sycned with the local API. You can reload the integration later and the name changes should get picked up. Note that this will create all new entities, so dont setup any automations etc until the name change has come in.
What do I do if i have more than 1 gateway?
If you have more than 1 gateway, ensure the local HTTP API is enabled on each one, and set them up separately via its IP address or hostname. The integration has been tested and is known to work with multiple gateways. There should be no limitation on how many gateways can be added, and in theory you should be able to add gateways that are connected to different linktap accounts, as long as they are directly accessible via HTTP.