HACS custom component for monitoring your AmeriGas propane account. Track tank levels, deliveries, payments, and integrate with the Energy Dashboard.
The automatic pre-delivery level capture now correctly handles cases where the AmeriGas portal updates last_delivery_date and last_delivery_gallons in separate API responses. Previously, if the date updated first, the capture would fire using the stale gallons figure from the prior delivery, producing a badly wrong pre-delivery level that cascaded into incorrect values for Used Since Delivery, Daily Average Usage, Days Until Empty, Cost Since Delivery, and Days Remaining Difference.
The date-change trigger now defers capture until both values have updated in the same poll. A second, telemetry-first level-jump trigger fires immediately when the tank monitor reports a ≥ 10 gallon increase between coordinator polls, capturing pre-fill and post-fill directly from the tank monitor — entirely independent of portal lag.
sensor.propane_cost_per_gallon now correctly reflects the current delivery cost immediately after a fill, without waiting for the invoice to be paid. If last_payment_date predates last_delivery_date, the sensor uses account_balance (preferred) or amount_due as the cost basis. It reverts to the standard last_payment_amount calculation automatically once payment is recorded.
You can now update your AmeriGas username or password directly from the integration's Configure dialog — no need to delete and re-add the integration. Go to Settings → Devices & Services → AmeriGas → Configure and enter your updated credentials. The change takes effect on the next data refresh with no restart required and no loss of historical data.
sensor.propane_daily_average_usage now uses gal/d (gallons per day) with SensorDeviceClass.VOLUME_FLOW_RATE, the correct HA representation for a flow rate.
Migration note: If you had this sensor tracked in the Statistics database before v3.1.0, Home Assistant will show a one-time unit-change prompt under Developer Tools → Statistics. Accepting it is safe and expected.
sensor.amerigas_last_payment_date now correctly uses SensorDeviceClass.TIMESTAMP end-to-end. sensor.amerigas_amount_due gains a payment_terms_days integer attribute available for automations.
- Tank Level — current percentage and gallons remaining
- Days Remaining — estimated days until empty based on your actual usage
- Delivery Tracking — last and next delivery dates and amounts
- Cost Tracking — cost per gallon, cost since last delivery, estimated refill cost
- Automatic Pre-Delivery Capture — 100% accurate for any delivery size, zero configuration
- Lifetime Consumption — total propane used since installation, protected against data loss
- Daily Average Usage — your average consumption per day
- Energy Dashboard Integration — track propane alongside electricity and other utilities
- Lifetime sensors never reset to 0 on HA restart (race condition fixed)
- Data persists through API outages and integration reloads
- Energy Dashboard historical data permanently protected
- All sensors share the same pre-delivery level; changing it updates everything instantly
- Days Until Empty works correctly for any usage rate, including vacation homes
- Calculation transparency via sensor attributes
-OR-
- Open HACS → Integrations
- Search for "AmeriGas Propane"
- Install and restart Home Assistant
- Download the latest release from GitHub Releases
- Copy
custom_components/amerigasto yourconfig/custom_components/directory - Restart Home Assistant
- Settings → Devices & Services → + Add Integration
- Search "AmeriGas" and select it
- Enter your MyAmeriGas account credentials and click Submit
If your password changes, go to Settings → Devices & Services → AmeriGas → Configure and re-enter your credentials. No restart needed and no historical data is lost.
API sensors (15): tank level, tank size, days remaining, amount due, account balance, last/next delivery date and gallons, last payment date/amount, last tank reading, auto-pay status, paperless billing, account number, service address
Calculated sensors (11): gallons remaining, used since last delivery, energy consumption (display), daily average usage, days until empty, days since last delivery, cost per gallon, cost per cubic foot, cost since last delivery, estimated refill cost, days remaining difference
Lifetime sensors (2): Propane Lifetime Gallons, Propane Lifetime Energy (for Energy Dashboard)
Diagnostic entity (1): Pre-Delivery Tank Level number entity — auto-captured on each delivery, manually adjustable
- Settings → Dashboards → Energy → Add Gas Source
- Select Propane Lifetime Energy (
sensor.propane_lifetime_energy) - Click Save
Update to v3.0.8 or later before using the Energy Dashboard to ensure historical data is never lost to the startup race condition.
The integration uses two independent triggers to detect a delivery:
Trigger 1 — Level-jump (telemetry-first): Fires immediately when the tank monitor reports an increase ≥ 10 gallons between consecutive coordinator polls. Captures both pre-fill and post-fill directly from the tank monitor — the most accurate baseline, independent of portal lag.
Trigger 2 — Date-change (API confirmation): Fires when last_delivery_date changes. If the level-jump trigger already captured the fill, this path confirms and skips re-capture. Otherwise it calculates pre_delivery = current_level - last_delivery_gallons. Capture is deferred if last_delivery_gallons hasn't updated yet in the same poll, firing on a subsequent poll once both values are current.
The captured pre-delivery level is stored in number.amerigas_pre_delivery_level and used by all consumption sensors. All sensors recalculate immediately when this value changes.
Example (level-jump path):
Pre-fill (tank monitor): 145 gal ← captured at delivery time
Post-fill (tank monitor): 420 gal ← captured at delivery time
Used since delivery: 420 - 395 (current) = 25 gal ✅ (accuracy: 100%, tank monitor)
Example (API fallback path):
Post-delivery level: 420 gal
Delivery amount: 255.9 gal
Pre-delivery level: 164.1 gal ← auto-captured once portal updates
Used since delivery: 420 - 395 (current) = 25 gal ✅ (accuracy: ~95%, API)
Manually set the pre-delivery level — useful for deliveries that occurred before v3.0.5 or if auto-capture failed.
service: amerigas.set_pre_delivery_level
data:
gallons: 145.0Force an immediate API fetch instead of waiting for the next scheduled refresh.
service: amerigas.refresh_dataData refreshes automatically at 00:00, 06:00, 12:00, and 18:00 daily, plus immediately on HA startup. Use amerigas.refresh_data to trigger an on-demand update.
Sensors show wrong values right after a delivery — If the integration was not running at delivery time (e.g. you just installed v3.1.1), the level-jump trigger could not fire. Set the pre-delivery level manually: amerigas.set_pre_delivery_level with the tank level in gallons immediately before the delivery. Sensors correct immediately.
Cost per gallon looks wrong after a delivery — Expected until the invoice is paid. v3.1.1 automatically uses account_balance or amount_due as the cost basis when last_payment_date predates last_delivery_date. Once payment is recorded, it reverts to the standard calculation.
Need to update your password? — Use Settings → Devices & Services → AmeriGas → Configure (v3.1.0+). No reinstall required.
Daily Average Usage unit change prompt in Statistics — Expected after upgrading to v3.1.0. Go to Developer Tools → Statistics, find propane_daily_average_usage, and accept the unit fix. Safe to confirm.
Date sensors showing the wrong day (one day early) — Fixed in v3.0.11. Update and restart.
Next delivery date entity missing / HA prompting you to delete it — Fixed in v3.0.11. Update and restart; the entity will be recreated automatically.
Lifetime sensors reset to 0 on restart — Fixed in v3.0.8. Update immediately. After updating, check logs for State restoration complete. Lifetime total: XXX.XX gal.
Sensors not updating after setting pre-delivery level — Fixed in v3.0.7. Verify you are on v3.0.7+ and restart.
Daily Average Usage shows 0.0000 gal/day — Fixed in v3.0.7. Check that the pre-delivery level entity has a non-zero value and that the calculation_method attribute shows auto_captured or tank_monitor.
Days Until Empty shows a very large number — Expected for low-usage installations (e.g. vacation homes). The sensor caps at 9,999 days for usage below 0.001 gal/day. Check the calculation attribute for the exact math.
API timeouts / sensors unavailable — Timeout is 45 seconds (raised in v3.0.8). If timeouts persist, use amerigas.refresh_data to retry manually.
Finding the pre-delivery level entity — Developer Tools → States → search pre_delivery.
type: entities
title: Propane Tank
entities:
- entity: sensor.amerigas_tank_level
name: Tank Level
- entity: sensor.amerigas_tank_gallons_remaining
name: Gallons Remaining
- entity: sensor.amerigas_used_since_last_delivery
name: Used Since Delivery
secondary_info: attribute:accuracy
- entity: sensor.amerigas_daily_average_usage
name: Daily Average
- entity: sensor.amerigas_days_until_empty
name: Days Until Empty
secondary_info: attribute:calculation
- type: divider
- entity: sensor.amerigas_estimated_refill_cost
name: Est. Refill Cost
- entity: sensor.amerigas_cost_since_last_delivery
name: Cost Since Delivery
- entity: sensor.amerigas_last_delivery_date
name: Last Delivery
- entity: sensor.amerigas_next_delivery_date
name: Next DeliveryNo breaking changes. Update via HACS and restart. All sensors, entities, and automations continue working without modification.
See MIGRATION.md for detailed instructions.
See CONTRIBUTING.md. Bug reports and PRs welcome via GitHub Issues and Discussions.
MIT License — see LICENSE
Unofficial integration, not affiliated with AmeriGas. Use at your own risk. Always verify propane levels manually. May break if AmeriGas changes their website.
Built for Home Assistant. Thanks to all contributors (@Ricket and others) and to the community for testing and feedback.
If this integration helped you, please ⭐ star the repo!
Made with ❤️ for the Home Assistant community