Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 3.59 KB

README.md

File metadata and controls

82 lines (60 loc) · 3.59 KB
Raw

GasBuddy

GitHub Release GitHub Activity License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Component to integrate with GasBuddy fuel price tracker.

This component will set up the following platforms.

Platform Description
sensor Show info from an GasBuddy listed station.

Installation via HACS (recommended)

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  1. Follow the link here
  2. Use the custom repo link https://github.com/firstof9/ha-gasbuddy
  3. Select the category type integration
  4. Then once it's there (still in HACS) click the INSTALL button
  5. Restart Home Assistant
  6. Once restarted, in the HA UI go to Configuration (the ⚙️ in the lower left) -> Devices and Services click + Add Integration and search for GasBuddy

Manual (non-HACS)

Instructions
You probably do not want to do this! Use the HACS method above unless you know what you are doing and have a good reason as to why you are installing manually
  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called gasbuddy.
  4. Download all the files from the custom_components/gasbuddy/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. Once restarted, in the HA UI go to Configuration (the ⚙️ in the lower left) -> Devices and Services click + Add Integration and search for GasBuddy

Configuration is done in the UI

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

TODO

  • Add tests