Intégration Prix Carburant pour Home-Assistant

This a custom component for Home Assistant. The prix_carburant integration allows you to get information and prices from gouv API.

❗ README complet en français 🇫🇷 ❗

Installation

HACS

HACS > Integrations > Explore & Download Repositories > Prix Carburant > Download this repository with HACS

Manually

Copy the directory prix_carburant in config/custom_components of your Home-Assistant.

Configuration

From UI

Search Prix Carburant in Integration.

From configuration.yaml

sensor:
  - platform: prix_carburant
    # IDs from https://www.prix-carburants.gouv.fr/
    stations:
      - 12345678
      - 34567890

Contributing

Stations Data

The stations_name.json file contains information about gas stations with their IDs, names, and brands. If you want to contribute by adding or updating station information:

1. Fork the repository
2. Edit the custom_components/prix_carburant/stations_name.json file
3. Create a pull request

A GitHub workflow will automatically validate the JSON structure and format. If the PR only modifies the stations_name.json file and passes validation, it will be automatically approved and merged.

Commit messages

When contributing to the codebase, please follow the Conventional Commits format for commit messages. This helps maintain a clear and consistent commit history, and is used to automatically generate release notes.

Crédits

Thanks to https://github.com/max5962/prixCarburant-home-assistant for base code.