Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derhuerst/live-icomera-position
Live vehicle geolocation, taken from the on-board Icomera WiFi system.
https://github.com/derhuerst/live-icomera-position
flixbus geolocation icomera
Last synced: 6 days ago
JSON representation
Live vehicle geolocation, taken from the on-board Icomera WiFi system.
- Host: GitHub
- URL: https://github.com/derhuerst/live-icomera-position
- Owner: derhuerst
- License: isc
- Created: 2020-02-23T18:41:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T21:44:46.000Z (9 months ago)
- Last Synced: 2024-10-03T23:56:31.347Z (about 1 month ago)
- Topics: flixbus, geolocation, icomera
- Language: JavaScript
- Homepage: https://github.com/derhuerst/live-icomera-position#live-icomera-position
- Size: 33.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# live-icomera-position
**Live vehicle geolocation, taken from the on-board Icomera WiFi system.**
[](https://www.npmjs.com/package/live-icomera-position)
[](https://gitter.im/derhuerst)
[](https://patreon.com/derhuerst)
## Installation
```shell
npm install live-icomera-position
```
## Usage
### command-line interface (CLI)
```
Usage:
live-icomera-postion
Options:
--interval -i How often to fetch the current position.
Default: 3000
--timeout -t How long to wait when fetching a position.
Default: 2500
Examples:
live-icomera-postion -i 5000 >>positions.ndjson
```
### as a library
`asStream()` returns a [readable stream](https://nodejs.org/api/stream.html#stream_class_stream_readable) in [object mode](https://nodejs.org/api/stream.html#stream_object_mode).
```js
import {pipeline} from 'node:stream/promises'
import {asStream} from 'live-icomera-position'
import ndjson from 'ndjson'
await pipeline(
asStream(),
ndjson.stringify(),
process.stdout,
)
```
An individual data point will look like this:
```js
{
latitude: 50.9069,
longitude: 7.0649,
altitude: 36.9,
speed: 97, // km/h
nrOfSatellites: 8,
mode: '3' // see below
}
```
You can also use the [`EventEmitter`](https://nodejs.org/api/events.html#events_class_eventemitter)-based API:
```js
import {asEventEmitter} from 'live-icomera-position'
const positions = asEventEmitter()
positions.on('error', console.error)
positions.on('data', data => console.log(data))
```
### Mode
The mode value in a datapoint appears familiar with the one a widespread gps client called GPSD uses.
We don't have any confirmation that the icomera system uses GPSD, but if it did the mode values would mean following:
| Value | State |
|-------|--------------------------------|
| 0 | no value seen. |
| 1 | no position. |
| 2 | 2D position, no altitude. |
| 3 | 3D position, altitude present. |
source: [GPSD Documentation](https://gpsd.gitlab.io/gpsd/gpsd_json.html)
## Related
- [`live-cd-wifi-position`](htttps://github.com/derhuerst/live-cd-wifi-position) – Live vehicle geolocation of Czech Railways trains, taken from the on-board WiFi system.
- [`live-gomedia-position`](htttps://github.com/derhuerst/live-gomedia-position) – Live vehicle geolocation, taken from the GoMedia on-board WiFi entertainment system.
- [`wifi-on-ice-position-stream`](https://github.com/derhuerst/wifi-on-ice-position-stream) – A stream of positions of German Railways ICE trains, taken from the on-board WiFi.
- [`sncf-wifi-portal-client`](https://github.com/derhuerst/sncf-wifi-portal-client) – Query information from the SNCF WiFi portal in French TGV 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.
## Contributing
If you have a question or need support using `live-icomera-position`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, use [the issues page](https://github.com/derhuerst/live-icomera-position/issues).