Skip to content

NSW Fuel Station Price Sensor #5477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 16, 2018

Conversation

nickw444
Copy link
Contributor

@nickw444 nickw444 commented Jun 2, 2018

Description:
Add documentation for sensor.nsw_fuel_station component

Pull request in home-assistant (if applicable): home-assistant/core#14757

Checklist:

  • Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
  • The documentation follow the standards.

@fabaff
Copy link
Member

fabaff commented Jun 7, 2018

The docs should contain a hint there is a limit of 2500 requests per months. If one starts to use multiple sensors and overwrites the update interval then she/he will hit the limit.

@nickw444
Copy link
Contributor Author

nickw444 commented Jun 7, 2018

The docs should contain a hint there is a limit of 2500 requests per months. If one starts to use multiple sensors and overwrites the update interval then she/he will hit the limit.

Where did you find this information about 2500 requests? The client does not actually use the official API, since this requires each home-assistant user creating API credentials, waiting to be approved, and subsequently configuring them in home-assistant.

Instead, the client library nsw-fuel-api-client piggybacks on the API exposed for the FuelCheck App, which does not require any authentication and doesn't appear to have any limits (however usage of this API is possibly questionable, but I don't think it differs from many of the other unofficial 3rd party platforms available on home-assistant.)

@fabaff
Copy link
Member

fabaff commented Jun 9, 2018

Where did you find this information about 2500 requests?

At https://api.nsw.gov.au/price

@nickw444
Copy link
Contributor Author

nickw444 commented Jun 9, 2018

I'm aware of the limit imposed by the official API, but as I mentioned in the previous comment, the underlying library uses an unofficial API exposed by the FuelCheck App, which I expect has higher limits since it is the underlying API for a web and mobile application used to show fuel information.

The main reason for using the unofficial API is that it does not require any authentication - using the official API requires consumers to apply for an API key, a process that took a week for me (which is why I resorted to the unofficial API).

Copy link
Member

@fabaff fabaff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 🐦

@fabaff fabaff added the new-integration This PR adds documentation for a new Home Assistant integration label Jun 14, 2018
@arsaboo arsaboo merged commit b71498d into home-assistant:next Jun 16, 2018
@fabaff fabaff added this to the 0.72 milestone Jun 20, 2018
@balloob balloob added the cherry-picked This PR has been manually picked and merged into the current branch label Jun 21, 2018
balloob pushed a commit that referenced this pull request Jun 21, 2018
* NSW Fuel Station Price Sensor

* .

* .

* update doc

* update doc

* quote correctly

* Update doc

* Add headings and minimize configuration sample
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherry-picked This PR has been manually picked and merged into the current branch new-integration This PR adds documentation for a new Home Assistant integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants