Overview
With the release of 2.8, Droplet is now capable of streaming data over your local network to Home Assistant (or any MQTT-capable device). The following articles will help get you up and running with Droplet's new API.
Introduction - Setting up MQTT with Home Assistant
Introduction - Setting up MQTT with Home Assistant
Droplet is now capable of streaming data over your local network to Home Assistant (or any MQTT-capable device). It sends the following data:
Real-time flow rate
Network connection status (e.g. connected to Hydrific servers or local only)
Signal quality received by the ultrasonic sensor
Configuring your Home Assistant for Droplet
To configure your Home Assistant to receive Droplet’s data, you will need to configure the MQTT integration. If you already have the MQTT integration installed, you can skip this step.
On your Home Assistant, navigate to Settings > Devices & services.
Select ADD INTEGRATION:
Search for MQTT then select MQTT:
Select the first option "MQTT".
You will be prompted to choose how you want to connect to the MQTT broker. Select the first option to use the official Mosquitto MQTT Broker add-on. It will be installed for you:
Once the installation is complete, click Finish.
Configuring your Droplet
Configuring your Droplet
Configuring your Droplet for Home Assistant requires Bluetooth pairing. Connection information is shared directly between your phone and Droplet device, so you will need to be close to your Droplet to complete these steps.
Navigate to Settings in your Droplet app and select API Integration.
Tap MQTT Authentication and the follow the prompts to pair with your Droplet over Bluetooth.
After the Bluetooth pairing is successful, enter your configuration information. The following fields are required:
Hostname: Enter the hostname or IP address at which your Home Assistant can be reached.
Port Number: Enter the port on which your MQTT broker is listening. If you followed the instructions above, leave the default of 1883.
Username and Password: Any user that already exists on your Home Assistant will be able to connect to the MQTT broker. Or, see the Home Assistant documentation for instructions on how to create a new user for your add-on.
Discovery Prefix: If you followed the instructions above, leave the default of homeassistant. See the Home Assistant documentation for more information.
Status Topic: If you followed the instructions above, leave as the default of homeassistant/status. See the Home Assistant documentation for more information.
And that’s it! Once you’ve configured your Droplet, it should show up shortly on your Home Assistant under Settings > Devices & services > Devices.
Click on the Droplet device. From here, you can rename your Droplet, assign it to an area or label, view diagnostic information, or create a card to add it to your dashboard.
Customizing in Home Assistant
Customizing in Home Assistant
Changing Units
Your Home Assistant may show the Droplet’s flow rate in liters per minute by default. To change the unit to gallons per minute, open the Droplet device page and click on Flow Rate. From there, click the settings wheel at the top right. You can then select your desired unit of measurement. Home Assistant will automatically perform the conversion.
Adding Droplet to your Home Assistant Dashboard
Once the droplet device is available in your Home Assistant, you can create cards to display its data on your dashboard. Here are two options we think you might like.
Graph: Last 30 minutes of water flow
From your Home Assistant dashboard, click the pencil in the top right corner to edit. Click the Add card button at the bottom right corner of the edit view. Select History graph.
Select Droplet Flow Rate as the entity.
Give your graph a title, set it to show 0.5 hours, and choose a minimum and maximum value for the Y-axis based on your home’s typical water usage.
Save the card and your dashboard. You’re done! The graph will update automatically as your Droplet sends flows.
Gauge: Quick look at current water flow
From your Home Assistant dashboard, click the pencil in the top right corner to edit. Click the Add card button at the bottom right corner of the edit view. Select Gauge.
Select Droplet Flow Rate as the entity. Set minimum and maximum values based on your home’s typical water usage. If you want, you can add a needle to the gauge and set severity levels to see how your home’s water flow is at a glance.
Save the card and your dashboard. You’re done! The gauge will update automatically as your Droplet sends flows.
Setting up Notifications
You can configure Home Assistant notifications based on flows that Droplet reports. From the Droplet device page, select Automations. This example uses the first option, Use device as trigger.
Add triggers for notifications. For example, this block will trigger a notification when water flow is above 100 gal/min for 10 minutes. You can add multiple triggers in this section.
Under the next section, And if, you can add other conditions that must also be true for the notification to trigger. For example, only trigger a notification if someone is not at home.
In the last section, Then do, select Add action > Notifications > Send a persistent notification. This will send a notification that is visible in the notifications panel.
Save your notification. You’re all set!
Have more questions, need help, or want to request a feature? Please reach out to our team at [email protected] or via chat in the lower right hand corner!