Skip to content

Commit

Permalink
Update to 1.0.6
Browse files Browse the repository at this point in the history
Remove some obsolete docs about yaml config.  This is no longer recommended, as it is not possible to automatically migrate if there are config changes.
  • Loading branch information
make-all committed Jul 7, 2022
1 parent 78dae54 commit a1cf50e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 18 deletions.
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,30 +24,14 @@ The integration can be added from the Integrations configuration screen.
API keys can be obtained by registering on the
[Metlink Developer Portal](https://opendata.metlink.org.nz/). **Be sure to subscribe to the "Metlink Open Data API".** Currently this is the only API they offer, and is free, but is still unsubscribed by default.

If you prefer to configure using yaml instead of the UI, add something like
the following to your `config/configuration.yaml`:

```
sensor:
- platform: metlink
api_key: abcdefg1234xzy
stops:
- stop_id: 9999
- stop_id: WELL
route: HVL
- stop_id: 5016
destination: 3451
num_departures: 3
```


`stop_id` for Train and Cable Car stops is a 4 character alphabetic
code, and for bus and ferry stops, is a 4 digit numeric code.
The IDs are on bus stop signs, or can be looked up on the
[Metlink](https://metlink.org.nz) main web site.


If your stop is busy with multiple routes, you can filter by route and/or destination. Currently exact matches are expected and only a single route or destination can be specified, though the destination does check the name as well as the stop id for a match, though some of the names that come through the API are abbreviated in ways that do not match the main web site so stop id will be more reliable. The destination filter is only available on the final destination, not any intermediate stops.
If your stop is busy with multiple routes, you can filter by route and/or destination. Currently exact matches are expected and only a single route or destination can be specified, though the destination does check the name as well as the stop id for a match, but some of the names that come through the API are abbreviated in ways that do not match the main web site so stop id will be more reliable. The destination filter is only available on the final destination, not any intermediate stops.


Each stop will create a sensor in Home Assistant, which will return the next departure time as its status.
Expand Down
2 changes: 1 addition & 1 deletion custom_components/metlink/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
"issue_tracker": "https://github.com/make-all/metlink-nz/issues",
"name": "Metlink Wellington Transport",
"requirements": ["isodate~=0.6.1"],
"version": "1.0.5"
"version": "1.0.6"
}

0 comments on commit a1cf50e

Please sign in to comment.