wifi-on-ice-portal-client
v1.2.0
Published
Query information from the WifiOnICE portal in German ICE trains.
Downloads
17
Maintainers
Readme
wifi-on-ice-portal-client
Query information from the WifiOnICE portal in German ICE trains.
A lot of the features of the portal are not covered yet.
Installing
npm install wifi-on-ice-portal-client
Usage
const portal = require('wifi-on-ice-portal-client')
portal.status()
.then(console.log)
.catch(console.error)
{
serviceLevel: 'AVAILABLE_SERVICE',
internet: 'HIGH',
latitude: 51.2719795,
longitude: 13.4613135,
tileY: 141,
tileX: 275,
series: '411',
serverTime: 1635252079700,
speed: 0,
trainType: 'ICE',
tzn: 'Tz1178',
wagonClass: 'FIRST',
connectivity: {
currentState: 'HIGH',
nextState: 'UNSTABLE',
remainingTimeSeconds: 3600
},
bapInstalled: true,
ok: true,
gpsOk: true
}
API
portal.status()
Returns a Promise.
portal.journey()
Returns a Promise that resolves with a Friendly Public Transport Format 1.2.1
journey
leg, similar to db-hafas
. It looks like this:
{
public: true,
mode: 'train',
line: { type: 'line', id: 'ice-1556', name: 'ICE 1556' },
traveledDistance: 44502,
distanceToPreviousStop: 62523,
totalDistance: 436961,
next: {
type: 'station',
id: '8010205_00',
name: 'Leipzig Hbf',
location: { type: 'location', latitude: 51.345471, longitude: 12.382064 }
},
scheduledNext: {
type: 'station',
id: '8010205_00',
name: 'Leipzig Hbf',
location: { type: 'location', latitude: 51.345471, longitude: 12.382064 }
},
previous: {
type: 'station',
id: '8010297_00',
name: 'Riesa',
location: { type: 'location', latitude: 51.309654, longitude: 13.287734 }
},
last: {
type: 'station',
id: '8070003_00',
name: 'Frankfurt (M) Flughafen Fernbf',
location: { type: 'location', latitude: 50.053167, longitude: 8.570185 }
},
passed: [
{
station: {
type: 'station',
id: '8010085_00',
name: 'Dresden Hbf',
location: { type: 'location', latitude: 51.040563, longitude: 13.732035 }
},
arrival: null,
arrivalDelay: null,
arrivalPlatform: '3',
departure: '2021-10-26T14:16:00+02:00',
departureDelay: 300,
departurePlatform: '3',
passed: true,
kmFromStart: 0,
delayReasons: null
},
{
station: {
type: 'station',
id: '8010089_00',
name: 'Dresden-Neustadt',
location: { type: 'location', latitude: 51.065899, longitude: 13.740701 }
},
arrival: '2021-10-26T14:20:00+02:00',
arrivalDelay: 300,
arrivalPlatform: '6',
departure: '2021-10-26T14:22:00+02:00',
departureDelay: 300,
departurePlatform: '6',
passed: true,
kmFromStart: 2.882,
delayReasons: [ { code: '36', text: 'Reparatur am Zug' } ]
},
// ...
{
station: {
type: 'station',
id: '8000105_00',
name: 'Frankfurt (Main) Hbf',
location: { type: 'location', latitude: 50.107145, longitude: 8.663789 }
},
arrival: '2021-10-26T18:38:00+02:00',
arrivalDelay: 120,
arrivalPlatform: '7',
departure: '2021-10-26T18:44:00+02:00',
departureDelay: 120,
departurePlatform: '7',
passed: false,
kmFromStart: 427.979,
delayReasons: [ { code: '36', text: 'Reparatur am Zug' } ]
},
{
station: {
type: 'station',
id: '8070003_00',
name: 'Frankfurt (M) Flughafen Fernbf',
location: { type: 'location', latitude: 50.053167, longitude: 8.570185 }
},
arrival: '2021-10-26T18:57:00+02:00',
arrivalDelay: 120,
arrivalPlatform: 'Fern 7',
departure: null,
departureDelay: null,
departurePlatform: 'Fern 7',
passed: false,
kmFromStart: 436.961,
delayReasons: [ { code: '36', text: 'Reparatur am Zug' } ]
}
]
}
Related
- Was das neue Bahn-Wifi über seine Nutzer ausplaudert
wifi-on-ice-position-stream
– A stream of ICE positions, taken from the on-board WiFi.record-ice-movement
– Record the movement of any ICE using the on-board WiFi.sncf-wifi-portal-client
– Query information from the SNCF WiFi portal in French TGV trains.digital-im-regio-portal-client
– Query information from the Digital im Regio portal in German Regio trains.cd-wifi-client
– A client for the onboard WiFi portal of České dráhy (Czech Railways) trains.
Contributing
If you have a question or have difficulties using wifi-on-ice-portal-client
, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to the issues page.