Skip to content

plmilord/Hass.io-custom-component-superior-propane

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hacs_badge GitHub release HA integration usage

Home Assistant custom component - Superior Propane

A custom Home Assistant integration for monitoring Superior Propane tanks with automatic consumption tracking for the Energy Dashboard. Seamlessly integrate your propane tank monitoring with your smart home automation.

Compatible with Superior Propane's mySuperior customer portal - Monitor your propane tanks directly in Home Assistant using the same data from your mySuperior account.

About Superior Propane

Superior Propane has been serving customers since 1922 in Canada. Their mySuperior customer portal provides 24/7 access to:

  • View fuel levels and tank percentages
  • Schedule deliveries
  • Manage your account
  • Make payments
  • Track delivery history

This integration brings all that tank monitoring data directly into your Home Assistant dashboard.

Features

  • Multi-Tank Support: Automatically discovers and monitors all tanks on your Superior Propane account
  • Real-Time Monitoring: Track tank level %, current volume, capacity, reading dates, and delivery history
  • Energy Dashboard Integration: Built-in consumption tracking with proper state_class: total_increasing for Home Assistant's Energy Dashboard
  • Smart Analytics: Monitor consumption rates, calculate days since last delivery, and track usage patterns
  • Native HA Integration: No external scripts, automations, or additional hardware required
  • HACS Compatible: Easy installation and automatic updates
  • Secure Authentication: Uses your existing mySuperior portal credentials

Tank Data Tracked

For each propane tank on your Superior Propane account, the integration provides:

Key Indicators

  • Level (%) - Current tank fill percentage according to the monitoring system
  • Current Volume - Exact volume currently in the tank in your unit system

Delivery and Maintenance Information

  • Last SMART Tank Update - Date of last level measurement by Superior Propane
  • Last Delivery - Date of last propane delivery
  • Number of Days Since Delivery - Automatically calculated number of days since last refill

Energy Dashboard Integration

  • Total Consumption - Cumulative gas consumption with the "total_increasing" status class
  • Consumption Rate - Current consumption rate for trend analysis
  • Average Price Paid - Average price paid for propane deliveries from your account

What you need

  • Active Superior Propane account with propane service
  • Registered mySuperior account
  • Email address and password for your mySuperior account

Installation

You can install this integration via HACS or manually.

HACS

Search for the Superior Propane integration and choose install. Reboot Home Assistant and configure the Superior Propane integration via the integrations page or press the blue button below.

Open your Home Assistant instance and start setting up a new integration.

Manual

Copy the custom_components/superior_propane to your custom_components folder. Reboot Home Assistant and configure the Superior Propane integration via the integrations page or press the blue button below.

Open your Home Assistant instance and start setting up a new integration.

Task List

To do

  • Ability to configure this custom component via entries in the configuration.yaml file
  • Adjust refresh rates based on reading frequency
  • Validated proper operation when there is more than one tank in the customer account
  • Add delivery switch when 'adds_delivery_date' is not declared

Inspiration / Credits

About

A custom Home Assistant integration for propane level tracking from Superior Propane

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%