Skip to content

Commit b71498d

Browse files
nickw444arsaboo
authored andcommitted
NSW Fuel Station Price Sensor (home-assistant#5477)
* NSW Fuel Station Price Sensor * . * . * update doc * update doc * quote correctly * Update doc * Add headings and minimize configuration sample
1 parent d5babc0 commit b71498d

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: page
3+
title: "NSW Fuel Station Price Sensor"
4+
description: "Instructions on how to integrate NSW fuel station prices into Home Assistant."
5+
date: 2018-06-02 18:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
ha_category: Fuel
11+
ha_release: 0.72
12+
ha_iot_class: "Cloud Polling"
13+
---
14+
15+
The `nsw_fuel_station` sensor platform uses the [NSW Fuel Check App](https://www.fuelcheck.nsw.gov.au/app) data as a source for current fuel price data.
16+
17+
## {% linkable_title Setup %}
18+
19+
To get the station ID for any NSW fuel station you will need to:
20+
21+
- Visit the [Fuel Check App](https://www.fuelcheck.nsw.gov.au/app).
22+
- Open the developer console of your browser (for Chrome, click View -> Developer -> Developer Tools). Click the "Network" tab in the developer console.
23+
- In the Fuel Check App, search for your postcode or click "Fuel Near Me".
24+
- In the developer console, you should see a request to `/FuelCheckApp/v1/fuel/prices/bylocation`. Open this request and preview the response. Find the station you wish to add, and copy down the `ServiceStationID` field.
25+
26+
## {% linkable_title Configuration %}
27+
28+
To add the NSW fuel station price sensor to your installation, add the following to your `configuration.yaml` file:
29+
30+
```yaml
31+
sensor:
32+
- platform: nsw_fuel_station
33+
station_id: 291
34+
```
35+
36+
{% configuration %}
37+
station_id:
38+
description: The ID of the station to track
39+
required: true
40+
type: string
41+
fuel_types:
42+
description: A list of fuel types to track for the station. Must be one of `["E10", "U91", "E85", "P95", "P98", "DL", "PDL", "B20", "LPG", "CNG", "EV"]`. Descriptions of fuel types can be found [here](https://www.fuelcheck.nsw.gov.au/App/Home/FuelTypes).
43+
required: false
44+
default: "`['E10', 'U91']`"
45+
type: list
46+
{% endconfiguration %}

0 commit comments

Comments
 (0)