https://github.com/derhuerst/sncf-wifi-portal-client
Query information from the SNCF WiFi portal in French TGV trains.
https://github.com/derhuerst/sncf-wifi-portal-client
public-transport sncf
Last synced: 2 months ago
JSON representation
Query information from the SNCF WiFi portal in French TGV trains.
- Host: GitHub
- URL: https://github.com/derhuerst/sncf-wifi-portal-client
- Owner: derhuerst
- License: isc
- Created: 2019-09-14T13:58:53.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-19T08:24:47.000Z (over 2 years ago)
- Last Synced: 2025-03-28T16:21:18.463Z (3 months ago)
- Topics: public-transport, sncf
- Language: JavaScript
- Homepage: https://github.com/derhuerst/sncf-wifi-portal-client#sncf-wifi-portal-client
- Size: 9.77 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# sncf-wifi-portal-client
**Query information from the [SNCF WiFi portal](https://en.oui.sncf/en/tgv/services/wifi-onboard) in French TGV trains.**
[](https://www.npmjs.com/package/sncf-wifi-portal-client)
[](https://github.com/sponsors/derhuerst)
[](https://twitter.com/derhuerst)
## Installation
```shell
npm install sncf-wifi-portal-client
```
## Usage
```js
const portal = require('sncf-wifi-portal-client')
portal.connectionStatus()
.then(console.log, console.error)
```
```js
{
active: true,
status_code: 200,
status_description: 'ip has active grant',
service_class: 5,
granted_bandwidth: 100000,
remaining_data: 75453,
consumed_data: 1346,
next_reset: 1568471384091,
profileId: 'AUTO-LOGIN-PROFILE-ID'
}
```
## Related
- [`record-tgv-movement`](https://github.com/derhuerst/record-tgv-movement) – Record the movement of any TGV using the on-board WiFi.
- [`wifi-on-ice-portal-client`](https://github.com/derhuerst/wifi-on-ice-portal-client) – Query information from the WifiOnICE portal in German ICE trains.
- [`digital-im-regio-portal-client`](https://github.com/derhuerst/digital-im-regio-portal-client) – Query information from the Digital im Regio portal in German Regio trains.
- [`cd-wifi-client`](https://github.com/derhuerst/cd-wifi-client) – A client for the onboard WiFi portal of České dráhy (Czech Railways) trains.
- [`portale-regionale-wifi-position`](https://github.com/derhuerst/portale-regionale-wifi-position) – Query information from the *Portale Regionale* WiFi portal in Trenitalia (Italian Railways) trains.
- [`live-icomera-position`](htttps://github.com/derhuerst/live-icomera-position) – Live vehicle geolocation, taken from the on-board Icomera WiFi system.
- [`live-gomedia-position`](htttps://github.com/derhuerst/live-gomedia-position) – Live vehicle geolocation, taken from the GoMedia on-board WiFi entertainment system.
## Contributing
If you have a question or need support using `sncf-wifi-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](https://github.com/derhuerst/sncf-wifi-portal-client/issues).