Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derhuerst/hafas-monitor-departures
Pass in a HAFAS client, fetch all departures at any set of stations.
https://github.com/derhuerst/hafas-monitor-departures
berlin bvg transit transport vbb
Last synced: 6 days ago
JSON representation
Pass in a HAFAS client, fetch all departures at any set of stations.
- Host: GitHub
- URL: https://github.com/derhuerst/hafas-monitor-departures
- Owner: derhuerst
- License: isc
- Created: 2016-06-16T15:12:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-03T15:53:37.000Z (over 4 years ago)
- Last Synced: 2024-05-01T23:29:38.638Z (7 months ago)
- Topics: berlin, bvg, transit, transport, vbb
- Language: JavaScript
- Homepage: https://github.com/derhuerst/hafas-monitor-departures
- Size: 82 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# hafas-monitor-departures ðŸ”
**Pass in a HAFAS client, fetch all departures at any set of stations.** (You may get blacklisted.)
If you want to monitor trips/departures in an area, use [`hafas-monitor-trips`](https://github.com/derhuerst/hafas-monitor-trips). It polls HAFAS more efficiently.
[](https://www.npmjs.com/package/hafas-monitor-departures)
[](https://travis-ci.org/derhuerst/hafas-monitor-departures)
[](https://gitter.im/derhuerst/vbb-rest)
[](https://patreon.com/derhuerst)
## Installing
```shell
npm install hafas-monitor-departures
```
## Usage
As an exampe, we're going to use [`vbb-hafas`, the HAFAS client for Berlin](https://www.npmjs.com/package/vbb-hafas).
```js
const createMonitor = require('hafas-monitor-departures')
const createHafas = require('vbb-hafas')
const stations = ['900000100003'] // array of station ids
const interval = 2 * 60 * 1000 // every two minutes
const duration = 10 // each time, fetch departures for the next 10 min
const hafas = createHafas('my-awesome-program')
const monitor = createMonitor(hafas, stations, {interval, duration})
monitor.on('error', console.error)
monitor.on('departure', console.log)
setTimeout(() => {
monitor.removeListener('departure', console.log)
}, interval * 3)
```
`hafas.departures()` must be compatible with the implementation [of `hafas-client@5`](https://github.com/public-transport/hafas-client/blob/5/docs/departures.md#departuresstation-opt) (or [of `hafas-client@^4`](https://github.com/public-transport/hafas-client/blob/4/docs/departures.md#departuresstation-opt)).
Once you listen to any of the `departure` or `stats` events, it will automatically start to watch, and stop once you stop listening.
To manually issue a *single* departures check at a station, use `monitor.manual(id)`. The result will be emitted in a data event like all others.
## API
```js
createMonitor(hafasClient, listOfStations, opt = {})
```
`opt` overrides the following default values:
```js
{
interval: interval || 60 * 1000,
step: step || Math.floor(interval / stations.length),
duration: duration || Math.ceil(interval / 60 / 1000)
}
```
## Related
- [`hafas-record-delays`](https://npmjs.com/package/hafas-record-delays) – Record delays from [`hafas-monitor-departures`](https://github.com/derhuerst/hafas-monitor-departures) into a [LevelDB](http://leveldb.org).
- [`record-vbb-delays`](https://npmjs.com/package/record-vbb-delays) – Record VBB departures from HAFAS.
- [`hafas-monitor-trips`](https://npmjs.com/package/hafas-monitor-trips) – Using a HAFAS endpoint, watch all trips in a bounding box.
- [`hafas-monitor-trips-server`](https://npmjs.com/package/hafas-monitor-trips-server) – A server that manages [`hafas-monitor-trips`](https://github.com/derhuerst/hafas-monitor-trips) instances.
- [`hafas-client`](https://github.com/public-transport/hafas-client) – JavaScript client for HAFAS public transport APIs.
## Contributing
If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/hafas-monitor-departures/issues).