mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-16 07:58:58 +00:00
59 lines
1.8 KiB
Markdown
59 lines
1.8 KiB
Markdown
---
|
|
layout: page
|
|
title: "Tank Utility Sensor"
|
|
description: "How to integrate Tank Utility sensors within Home Assistant."
|
|
date: 2017-08-24 08:21
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: tank_utility.png
|
|
ha_category: Energy
|
|
ha_release: "0.53"
|
|
---
|
|
|
|
Add [Tank Utility](https://www.tankutility.com/) propane tank monitors to Home Assistant.
|
|
|
|
## {% linkable_title Setup %}
|
|
|
|
### {% linkable_title Authentication %}
|
|
|
|
Authentication for the Tank Utility API is performed with the same email and password credentials used at [https://app.tankutility.com](https://app.tankutility.com).
|
|
|
|
### {% linkable_title Devices %}
|
|
|
|
Each item in the list of devices is a 24 character string. These values can be found by clicking on the **Usage Reports** link at the bottom of the graph on the [Tank Utility devices page](https://app.tankutility.com/#/devices).
|
|
|
|
The device item value is the last segment of the URL path, e.g., the URL
|
|
[https://app.tankutility.com/#/reports/000000000000000000000000](https://app.tankutility.com/#/reports/000000000000000000000000) would indicate `000000000000000000000000` as a device value.
|
|
|
|
## {% linkable_title Configuration %}
|
|
|
|
To enable the component, add the following lines to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
sensor:
|
|
- platform: tank_utility
|
|
email: YOUR_EMAIL_ADDRESS
|
|
password: YOUR_PASSWORD
|
|
devices:
|
|
- 000000000000000000000000
|
|
```
|
|
|
|
{% configuration %}
|
|
email:
|
|
description: "Your [https://app.tankutility.com](https://app.tankutility.com) email address."
|
|
required: true
|
|
type: string
|
|
password:
|
|
description: "Your [https://app.tankutility.com](https://app.tankutility.com) password."
|
|
required: true
|
|
type: string
|
|
unit_of_measurement:
|
|
description: All devices to monitor.
|
|
required: true
|
|
type: map
|
|
{% endconfiguration %}
|
|
|