Add sensor.nsw_fuel_station component #14757

nickw444 · 2018-06-02T04:49:53Z

Description:

Adds a new component, sensor.nsw_fuel_station to show fuel prices from fuel stations in NSW, Australia.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#5477

Example entry for `configuration.yaml` (if applicable):

sensor:
  - platform: nsw_fuel_station
    station_name: 'Caltex Woolworths Blakehurst'
    station_id: 530
    fuel_types:
      - E10
      - P95
  - platform: nsw_fuel_station
    station_id: 675
    station_name: Caltex Woolworths Peakhurst
    fuel_types:
      - E10
      - P95

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New or updated dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

houndci-bot · 2018-06-02T04:50:04Z

homeassistant/components/sensor/nsw_fuel_station.py

+    @property
+    def name(self) -> str:
+        """Return the name of the sensor."""
+        return 'NSW Fuel Station {} {}'.format(self._station_data.station_name, self._fuel_type)


line too long (96 > 79 characters)

houndci-bot · 2018-06-02T04:50:05Z

homeassistant/components/sensor/nsw_fuel_station.py

+    station_data = StationPriceData(client, station_id, station_name)
+    station_data.update()
+
+    add_devices([StationPriceSensor(station_data, fuel_type) for fuel_type in fuel_types])


line too long (90 > 79 characters)

houndci-bot · 2018-06-02T04:50:05Z

homeassistant/components/sensor/nsw_fuel_station.py

+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_STATION_ID): cv.positive_int,
+    vol.Required(CONF_STATION_NAME): cv.string,
+    vol.Required(CONF_FUEL_TYPES, default=[]): vol.All(cv.ensure_list, [cv.string]),


line too long (84 > 79 characters)

dgomes · 2018-06-02T23:00:24Z

homeassistant/components/sensor/nsw_fuel_station.py

+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_STATION_ID): cv.positive_int,
+    vol.Required(CONF_STATION_NAME): cv.string,
+    vol.Required(CONF_FUEL_TYPES, default=[]): vol.All(


if it is required there is no point in having a default, maybe make it option and have the default a non empty list ?

Great suggestion - I have changed the default to now be the full set of available fuel types and have updated the platform setup to only create sensors where there is an available fuel type to match in the station data (some stations don't supply every type of fuel)

dgomes · 2018-06-02T23:02:55Z

homeassistant/components/sensor/nsw_fuel_station.py

+        """Return the price of the given fuel type."""
+        if self._data is None:
+            return None
+        return next((x for x in self._data if x.fuel_type == fuel_type), None)


maybe renaming x to price ?

dgomes · 2018-06-03T18:40:01Z

Can you work the test to use MockDependency ?

This would enable for the removal of the dependency from requirements_test_all.txt

dgomes · 2018-06-03T23:20:12Z

I think it is good to go!

Just remove your dependency from script/gen_requirements_all.py and requirements_test_all.txt

nickw444 · 2018-06-04T08:51:07Z

Looks like the tests are failing due to the missing dependency, since setup_platform does from nsw_fuel import FuelCheckClient.

Is there a proper way for me to patch the module so that the tests will still run even if the package isn't installed.?

dgomes · 2018-06-04T08:54:17Z

That's where MockDependency I mentioned you some comments above comes in.

Just look into other tests that already use MockDependency

houndci-bot · 2018-06-04T08:57:25Z

tests/components/sensor/test_nsw_fuel_station.py

+
+from homeassistant.components import sensor
+from homeassistant.setup import setup_component
+from tests.common import get_test_home_assistant, assert_setup_component, MockDependency


line too long (88 > 79 characters)

nickw444 · 2018-06-04T08:58:25Z

Ah perfect, I must have overlooked that. Thanks for the review 👍

dgomes

LGTM

fabaff · 2018-06-07T14:11:04Z

homeassistant/components/sensor/nsw_fuel_station.py

+Component to display the current fuel prices at a NSW fuel station.
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/nsw_fuel_station/


URL is wrong. Should be https://home-assistant.io/components/sensor.nsw_fuel_station/.

fabaff · 2018-06-07T14:11:18Z

homeassistant/components/sensor/nsw_fuel_station.py

+"""
+Component to display the current fuel prices at a NSW fuel station.
+
+For more details about this component, please refer to the documentation at


It's a platform and not a component. nsw_fuel_station is a sensor platform.

fabaff · 2018-06-07T14:12:17Z

homeassistant/components/sensor/nsw_fuel_station.py

+"""
+import datetime
+from typing import Optional
+import voluptuous as vol


Please keep the import ordered -> https://developers.home-assistant.io/docs/en/development_guidelines.html

fabaff · 2018-06-07T14:24:30Z

homeassistant/components/sensor/nsw_fuel_station.py

+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up the NSW Fuel Station component."""


Use sensor instead of component please.

fabaff · 2018-06-07T14:40:30Z

homeassistant/components/sensor/nsw_fuel_station.py

+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_STATION_ID): cv.positive_int,
+    vol.Required(CONF_STATION_NAME): cv.string,


Must this really be required. station_id is used to retrieve the data incl. the station name. Best would be to let the users set their own name (CONF_NAME) and fall-back to the name which the request returns.

Unfortunately the response from the API does not return the fuel station name:

https://api.onegov.nsw.gov.au/FuelCheckApp/v1/fuel/prices/station/2119

An alternative to this could be to just use the station id as the component name? What do you think is a better user experience?

Hmm, I just checked one station from https://www.fuelcheck.nsw.gov.au and the name seems to be there.

[{ "ServiceStationID":1706, "Name":"BP Edgecliff", "Lat":-33.876974, "Long":151.231099, [...]

Let the users have the option to name a sensor according their needs in the configuration will avoid that they have to use customize:. I personally prefer if the default name let me identify the sensor quickly, thus I would just use Fuel Price + fuel type. Station Id is not that useful, IMHO.

Gotcha, I thought you were implying I obtained the station name by using the same request/endpoint. I will update the setup_platform to make an addition request during setup to find the name of the station using another endpoint. Definitely makes sense to make this easier to configure

Let the users have the option to name a sensor according their needs in the configuration will avoid that they have to use customize:

I'll remove the need for a name in the config entirely

thus I would just use Fuel Price + fuel type. Station Id is not that useful, IMHO.

Just double checking, I think you mean Name + fuel type?

fabaff · 2018-06-07T14:49:47Z

homeassistant/components/sensor/nsw_fuel_station.py

+        for fuel_type in fuel_types
+        if fuel_type in available_fuel_types
+    ])
+    return True


Not needed.

fabaff · 2018-06-07T14:49:49Z

homeassistant/components/sensor/nsw_fuel_station.py

+    def __init__(self, client, station_id: int, station_name: str) -> None:
+        """Initialize the sensor."""
+        self.station_id = station_id
+        self.station_name = station_name


Not needed. Thus no need to pass it.

fabaff · 2018-06-07T14:55:53Z

homeassistant/components/sensor/nsw_fuel_station.py

+    @property
+    def name(self) -> str:
+        """Return the name of the sensor."""
+        return 'NSW Fuel Station {} {}'.format(


Remove NSW Fuel Station because this will create very long identifier and makes it not very handy to use in templates. Limit it to station name and fuel type. With CONF_NAME can the still add NSW Fuel Station if needed.

Entity ID: sensor.nsw_fuel_station_caltex_woolworths_peak
Friendly name: NSW Fuel Station Caltex Woolworths Peakhurst P95

fabaff · 2018-06-07T14:56:37Z

homeassistant/components/sensor/nsw_fuel_station.py

+        """Return the state attributes of the device."""
+        attr = {}
+        attr['Station ID'] = self._station_data.station_id
+        attr['Station Name'] = self._station_data.station_name


Please add an attribution for the source of the data.

fabaff · 2018-06-07T15:04:22Z

homeassistant/components/sensor/nsw_fuel_station.py

+    fuel_types = config[CONF_FUEL_TYPES]
+
+    client = FuelCheckClient()
+    station_data = StationPriceData(client, station_id, station_name)


The setup of the platform should fail if the station ID is wrong/not available and an error logged (log file and/or persistent notification). Otherwise will be users end up with a non-functional platform.

Added persistent notification with error message:

MartinHjelmare · 2018-06-07T16:48:12Z

homeassistant/components/sensor/nsw_fuel_station.py

+        """Return the state of the sensor."""
+        price_info = self._station_data.for_fuel_type(self._fuel_type)
+        if price_info:
+            return price_info.price


Please return None explicitly if no price is found.

fabaff · 2018-06-07T17:53:50Z

Also, nickw444/nsw-fuel-api-client#1 should be addressed and the requirements updated.

MartinHjelmare · 2018-06-10T05:48:38Z

homeassistant/components/sensor/nsw_fuel_station.py

+            message,
+            title=NOTIFICATION_TITLE,
+            notification_id=NOTIFICATION_ID)
+        return False


Just return.

MartinHjelmare · 2018-06-10T05:51:01Z

homeassistant/components/sensor/nsw_fuel_station.py

+                self.station_id)
+        except FuelCheckError as exc:
+            self.error = str(exc)
+            _LOGGER.exception(


Use error level.

houndci-bot · 2018-06-11T07:35:48Z

homeassistant/components/sensor/nsw_fuel_station.py

+            except FuelCheckError as exc:
+                self.error = str(exc)
+                _LOGGER.error(
+                    'Failed to fetch NSW Fuel station reference data', exc_info=exc)


line too long (84 > 79 characters)

MartinHjelmare · 2018-06-11T07:51:14Z

homeassistant/components/sensor/nsw_fuel_station.py

+                self.error = str(exc)
+                _LOGGER.error(
+                    'Failed to fetch NSW Fuel station reference data',
+                    exc_info=exc)


Just pass the exception as a string formatting parameter to the logging string message. Don't use exc_info kwarg.

_LOGGER.error("bla bla %s", exc)

MartinHjelmare · 2018-06-11T07:51:42Z

homeassistant/components/sensor/nsw_fuel_station.py

+        except FuelCheckError as exc:
+            self.error = str(exc)
+            _LOGGER.error(
+                'Failed to fetch NSW Fuel station price data', exc_info=exc)


MartinHjelmare

Looks good!

MartinHjelmare · 2018-06-11T08:50:41Z

@fabaff should approve. But looks mergeable when build passes.

@MartinHjelmare

* Add sensor.nsw_fuel_station component * bump dependency * PR Changes * flake8 * Use MockPrice * Fix requirements * Fix tests * line length * wip * Handle errors and show persistent notification * update tests * Address @MartinHjelmare's comments * Fetch station name from API * Update tests * Update requirements * Address comments

homeassistant added cla-signed new-platform platform: sensor.nsw_fuel_station labels Jun 2, 2018

houndci-bot reviewed Jun 2, 2018

View reviewed changes

homeassistant added the cla-signed label Jun 2, 2018

nickw444 mentioned this pull request Jun 2, 2018

NSW Fuel Station Price Sensor home-assistant/home-assistant.io#5477

Merged

2 tasks

Add sensor.nsw_fuel_station component

93d08e5

nickw444 force-pushed the nwhyte/nsw-fuel-station-price branch from b8761a3 to 93d08e5 Compare June 2, 2018 07:00

homeassistant added the cla-signed label Jun 2, 2018

bump dependency

fc22abb

dgomes reviewed Jun 2, 2018

View reviewed changes

nickw444 added 2 commits June 3, 2018 12:30

PR Changes

835305f

flake8

74ce4dc

Use MockPrice

627fc8e

Fix requirements

282ef94

Fix tests

02ed7a6

houndci-bot reviewed Jun 4, 2018

View reviewed changes

line length

b5b7e70

dgomes approved these changes Jun 7, 2018

View reviewed changes

dgomes added the Ready for review label Jun 7, 2018

fabaff requested changes Jun 7, 2018

View reviewed changes

MartinHjelmare reviewed Jun 7, 2018

View reviewed changes

balloob removed the Ready for review label Jun 7, 2018

wip

8ca9f0e

homeassistant added the cla-signed label Jun 9, 2018

ghost added the in progress label Jun 9, 2018

Handle errors and show persistent notification

877f47f

homeassistant added the cla-signed label Jun 9, 2018

update tests

eb041a3

MartinHjelmare reviewed Jun 10, 2018

View reviewed changes

nickw444 added 2 commits June 11, 2018 08:26

Address @MartinHjelmare's comments

2320fa3

Fetch station name from API

b7433a1

houndci-bot reviewed Jun 11, 2018

View reviewed changes

nickw444 added 2 commits June 11, 2018 17:44

Update tests

8c5899f

Update requirements

9f9f23a

MartinHjelmare reviewed Jun 11, 2018

View reviewed changes

Address comments

8f942ab

MartinHjelmare approved these changes Jun 11, 2018

View reviewed changes

MartinHjelmare added the almost-done label Jun 11, 2018

fabaff approved these changes Jun 14, 2018

View reviewed changes

fabaff merged commit cdd111d into home-assistant:dev Jun 14, 2018

ghost removed the in progress label Jun 14, 2018

DavidFW1960 mentioned this pull request Jun 20, 2018

NSW Fuel Sensor home-assistant/home-assistant.io#5555

Closed

balloob mentioned this pull request Jun 22, 2018

0.72 #15088

Merged

home-assistant locked and limited conversation to collaborators Dec 10, 2018

ghost added integration: nsw_fuel_station and removed platform: sensor.nsw_fuel_station labels Mar 21, 2019



		def setup_platform(hass, config, add_devices, discovery_info=None):
		"""Set up the NSW Fuel Station component."""

Uh oh!

Add sensor.nsw_fuel_station component #14757

Add sensor.nsw_fuel_station component #14757

Uh oh!

Conversation

nickw444 commented Jun 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dgomes commented Jun 3, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dgomes commented Jun 3, 2018

Uh oh!

nickw444 commented Jun 4, 2018

Uh oh!

dgomes commented Jun 4, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nickw444 commented Jun 4, 2018

Uh oh!

dgomes left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fabaff commented Jun 7, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

nickw444 commented Jun 2, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

dgomes commented Jun 3, 2018 •

edited

Loading