Skip to content

bicycleboy/nsw_tas_fuel_station

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

108 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Current version

NSW Fuel Check Integration

Integration allowing fuel prices to be included in Home Assistant dashboards.

Feedback

Feedback, issues and feature requests are welcome and can be made here.

Features

  • Allows users to include NSW, ACT and Tasmanian fuel prices into their home assistant dashboards and automations. Currently only these Australian states are supported as other states offer different APIs.
  • This 2026 update to the existing core integration allows the user to configure the integration via the user interface (vs configuration.yaml) and adds a "cheapest E10/U91 today" sensor.

Example Cards for Your Home Assistant Dashboard

example cards

Example card yaml

User Guide

This user guide highlights the functionality and explains how to configure the integration once installed.

Sensors Created

  • Sensors for favorite fuel station(s) grouped by nickname/location e.g. home, work.
  • Sensors for cheapest fuel near nickname/location.

Installation

This integration is currently available as a HACS custom integration. (It does, however, pass the automated quality checks for a core integration.) If you are new to HACS don't panic, it is in widespread use. HACS will prompt you when integrations are updated with new features and fixes.

HACS Installation (recommended)

  1. If you don't already have it, install HACS, remembering to restart HA after installation.
  2. Follow the guide for installing custom repositories. In the repository field enter the address of this git repository "github.com/bicycleboy/nsw_tas_fuel_station".
  3. Restart HA.
  4. Go to Settings -> Integrations, Select NSW Fuel Check and follow the prompts to configure the integration (see also the user guide).
  5. Create dashboard cards (see user guide).

Manual Installation

A manual installation involves simply copying a few python files into your Home Assistant config/custom_components directory. You will need familiarity with the command line and one of the Apps that provide access to the command line such as terminal.

cd /tmp

git clone https://github.com/bicycleboy/nsw_tas_fuel_station.git

cd /config/custom_components

mv /tmp/nsw_fuel_station/custom_components/nsw_fuel_station.

You can of course inspect the files if you are concerned about anything.

Re-start Home Assistant.

Removing the existing NSW Fuel Station Integration

If you already have the NSW Fuel Station core integration delete the sensor configuration from configuration.yaml (ie using File Viewer) and then reboot home assistant. Delete lines that look like this:

sensor:
  - platform: nsw_fuel_station
    station_id: 18798
  - platform: nsw_fuel_station
    station_id: 18813

Sensor names will be similar but with a new prefix so dashboard cards will need updating.

Removing this integration

Remove the integration in the standard way from: Settings -> Devices and Services -> Select NSW Fuel Check Integration -> three dots -> Delete. Delete cards from dashboards for all users. Reboot home assistant.

Repository Overview

This repository contains:

File Purpose Documentation
.github/ISSUE_TEMPLATE Templates for the issue tracker Documentation
custom_components/nsw_tas_fuel_check/*.py Integration files required in your installation.
LICENSE The license file for the project. Documentation
pyproject.toml Python setup and configuration for this integration. Documentation
tests/*.py Unit test files for each .py file without calling any real APIs.
README.md The file you are reading now. Documentation
nsw_fuel_station.md User Guide. Documentation

Debugging

To assist with any issues, or determine if the API is returning unexpected results or there is a bug, you can turn on debugging in your configuration.yaml.

logger:
  logs:
    custom_components.nsw_tas_fuel_station: debug
    nsw_tas_fuel: debug

Contributing

Contributions and feedback welcome, please visit https://github.com/bicycleboy/nsw_tas_fuel_station, select Issues and choose either bug report or feature request.

Licence

This software is licensed under the MIT License. See the LICENCE file for details.

About

Include cheapest fuel prices and favourite station prices in your Home Assistant dashboard. For NSW, the ACT and Tasmania (Australia).

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors