Home Assistant integration for the Knoxville Utilities Board.
There are two main ways to install this custom component within your Home Assistant instance:
-
Using HACS (see https://hacs.xyz/ for installation instructions if you do not already have it installed):
Or
- From within Home Assistant, click on the link to HACS
- Click on Integrations
- Click on the vertical ellipsis in the top right and select Custom repositories
- Enter the URL for this repository in the section that says Add custom repository URL and select Integration in the Category dropdown list
- Click the ADD button
- Close the Custom repositories window
- You should now be able to see the KUB card on the HACS Integrations page. Click on INSTALL and proceed with the installation instructions.
- Restart your Home Assistant instance and then proceed to the Configuration section below.
-
Manual Installation:
- Download or clone this repository
- Copy the contents of the folder custom_components/kub into the same file structure on your Home Assistant instance
- Restart your Home Assistant instance and then proceed to the Configuration section below.
While the manual installation above seems like less steps, it's important to note that you will not be able to see updates to this custom component unless you are subscribed to the watch list. You will then have to repeat each step in the process. By using HACS, you'll be able to see that an update is available and easily update the custom component. Trust me, HACS is the worth the small upfront investment to get it setup.
There is a config flow for this integration. After installing the custom component and restarting:
- Go to Settings -> Devices & Services -> Integrations
- Click + ADD INTEGRATION to setup a new integration
- Search for KUB and select it
- You will now begin the configuration flow process
- Enter your KUB Username and Password into the prompt
- Submit
After the device is configured, the integration will expose 1 to 4 entities depending on the services available within your account:
- Sensors
- Electricity
- Gas
- Water
- Waste Water
KUB only updates their api data once a day so this integration is set to only poll once every 12 hours. However, once new data is retrieved, hourly statistics will also be back-loaded to be displayed on your energy dashboard.
Under the configure menu, you will find a single option to combine waste water usage and cost data into the water statistics. This is directed at those of us who only have a single point of water service and waste water is calculated via water consumption. This allows the statistics to better represent the total water cost for your residence. Even with this option enabled you will still have unique water and waste water summary sensors.
In an effort to improve startup times, you may notice upon restart that your KUB sensors are listed as Unknown. This is expected as usage/cost data retrieval has been delayed until after Home Assistant startup has completed. This delay significantly improves start times for the KUB integration.
As alluded to above, I only have a single line of water service and because of this I'm not able to determine what the api response looks like for those of you with multiple lines. This is most commonly seen when a residence has a pool or a large irrigation system. If this is you, could I ask a favor? On the KUB Devices screen there is a visit link and to the right an overflow menu. If you select it, you will see an option to download diagnostics data. Select it and the browser will save a diagnostics json file. Next go to my repo and create a new issue or discussion and provide that file to me. You can also email it my way as well. Thank you!
- Support multiple water lines
- No Notes
I am not associated with KUB and provide this custom component purely for your own enjoyment and home automation needs.