Awesome

monitor-hafas-cli

Monitor any HAFAS endpoint from the command line.

ISC-licensed minimum Node.js version

Installation

npm install -g monitor-hafas-cli

Or use npx. ✨

Getting started

As an example, we're going to monitor the VBB HAFAS endpoint, using vbb-hafas@7.

# make an empty project to play around
mkdir vbb-monitoring
cd vbb-monitoring
npm init --yes

# set up HAFAS client
npm install vbb-hafas@7
echo 'const createHafas = require("vbb-hafas")' >>hafas.js
echo 'const hafas = createHafas("vbb monitoring example")' >>hafas.js
changes, 2.0.0
echo 'module.exports = hafas' >>hafas.js

# set up monitoring
events='departure'
stations='900000100001,900000100003'

# run monitor-hafas-cli using npx
npx monitor-hafas-cli@2 ./hafas.js $events stations $stations
# or install & run monitor-hafas-cli manually
npm install monitor-hafas-cli@2
./node_modules/.bin/monitor-hafas ./hafas.js $events stations $stations

Use record-hafas-data to store to record this data into a LevelDB.

Note: If you want to monitor by bounding box (bbox mode), you need a running Redis server.

Usage

Monitoring stations:
	monitor-hafas <hafas-client> <list of events> stations <list of stations>
	monitor-hafas <hafas-client> <list of events> stations --file <file with stations>
	available events: departure, stopover, stats
Monitoring trips in a bounding box:
	monitor-hafas <hafas-client> <list of events> bbox <north> <west> <south> <east>
	available events: trip, new-trip, trip-obsolete, stopover, position, stats
Options:
	--file          -f  Read the list of stations from a JSON file.
	--pretty-print  -f  Pretty print data instead of JSON.
	--interval      -i  Query interval in seconds. Default: 30
	--show-stats    -s  Always show request stats.
Examples:
	monitor-hafas vbb-hafas departure stations 900000100001,900000100003
	monitor-hafas ./my-hafas-client.js departure,stopover stations --file stations.json
	monitor-hafas some-package/my-hafas-client.js stopover,position bbox 52.6 13.3 52.3 13.6

record-hafas-data – CLI tool to record data from monitor-hafas-cli into a LevelDB.
hafas-monitor-trips – Using a HAFAS endpoint, watch all trips in a bounding box.
hafas-monitor-departures – Pass in a HAFAS client, fetch all departures at any set of stations.
hafas-gtfs-rt-feed – Generate a GTFS Realtime feed by monitoring a HAFAS endpoint.
observe-hafas-client – Observe all departures/arrivals/etc. returned by hafas-client.
hafas-monitor-trips-server – A server that manages HAFAS monitors.

Contributing