Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tbouron/mmm-flighttracker
MagicMirror module that uses ADS-B systems to track nearby planes
https://github.com/tbouron/mmm-flighttracker
ads-b magic-mirror-modules magicmirror magicmirror2
Last synced: 3 months ago
JSON representation
MagicMirror module that uses ADS-B systems to track nearby planes
- Host: GitHub
- URL: https://github.com/tbouron/mmm-flighttracker
- Owner: tbouron
- License: apache-2.0
- Created: 2019-10-31T22:06:04.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T10:58:43.000Z (12 months ago)
- Last Synced: 2024-10-04T18:11:36.011Z (3 months ago)
- Topics: ads-b, magic-mirror-modules, magicmirror, magicmirror2
- Language: JavaScript
- Homepage:
- Size: 1.95 MB
- Stars: 13
- Watchers: 6
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MagicMirror² Module: Flight Tracker
`MMM-FlightTracker` is a module for [MagicMirror²](https://github.com/MichMich/MagicMirror) that allows you to display
real time information about gather from nearby planes transponders. The data is received over radio signals, coming from
nearby planes that is gather through an [ADS-B receiver](https://en.wikipedia.org/wiki/Automatic_dependent_surveillance_%E2%80%93_broadcast)
(this is how [FlightRadar24](https://www.flightradar24.com/) gets most of its data)
connected directly to server running MagicMirror², or over a TCP stream of SBS1 messages.
## Usage
### Prerequisites
This module requires that you have [librtlsdr](https://github.com/steve-m/librtlsdr) installed on your system.
Homebrew (macOS):
```
brew install librtlsdr
```
Debian based Linux distros:
```
apt-get install librtlsdr-dev
```
It also requires to have either:
- a ADS-B receiver plugged in to the server running MagicMirror². There are inexpensive to buy
and you can find [a lot of them on Amazon](https://www.amazon.co.uk/s?k=ads-b&ref=nb_sb_noss_2).
- a feeder from FlightAware or FlightRadar24 with [dump1090 configured to expose SBS1 messages over TCP](https://github.com/antirez/dump1090#port-30003).
### Setup
Clone this module into your MagicMirror's `modules` directory and install the dependencies:
```sh
cd modules
git clone https://github.com/tbouron/MMM-FlightTracker
cd MMM-FlightTracker
npm i
```
Then add the module to your MagicMirror's configuration. Here is an example:
```javascript
/* MagicMirror/config/config.js */
{
/* ...your other config here */
modules: [
/* ...your other modules here */
{
module: 'MMM-FlightTracker',
header: 'Nearby planes',
position: 'top_left',
config: {
interval: Number,
animationSpeed: Number,
passingByThreshold: Number,
orderBy: '(age|altitude|speed|distance):(asc|desc)',
limit: Number,
speedUnits: 'metric|imperial|knots',
altitudeUnits: 'metric|imperial',
latLng: [55.9411885, -3.2753781],
showAirline: Boolean,
showType: Boolean,
showSpeed: Boolean,
showAltitude: Boolean,
showHeading: Boolean,
client: {
mode: 'rtlsdr|network',
host: 'acme.com',
port: 30003
}
}
}
]
}
```
### Configuration options
| Configuration key | Description | Default | Required |
| --- | --- | --- | --- |
| interval | Interval to check if new planes are nearby. This value is in _seconds_. | `1` | Yes |
| animationSpeed | Animation speed to display/hide the module when planes come and go. This value is in _milliseconds_. | `1000` | No |
| passingByThreshold | The threshold altitude to determine if a plane is "at the window" or just "passing by". If no set (or negative) then all planes will be treated the same way. | `-1` | No |
| latLng | Your current coordinates, as an `Array` of `Number`. E.g. `[55.9411885, -3.2753781]`.
When defined, the distance and bearing, from your coordinates to the plane, will be displayed if available (requires the plane's coordinates to be known). | `undefined` | No |
| orderBy | The property to order the list of planes by. The syntax for this configuration option is as follow `:`.
Valid values for `` are:
- `age` (e.g. most recent or older plane tracked)
- `altitude`
- `speed`
- `distance` (available only if you supply `latLng` configuration and the plane broadcast its coordinates)
Valid values for `` are: `asc` or `desc` | `undefined` | No |
| limit | Limit the number of planes to display. If not set (or negative) then all tracked planes are displayed. | -1 | No |
| speedUnits | The unit to use for speed. By default, it will use the unit defined at the global config. Can be `metric`, `imperial` or `knots`. | Global unit config | No |
| altitudeUnits | The unit to use for altitude and distance to the plane (if `latLng` is defined). By default, it will use the unit defined at the global config. Can be `metric` or `imperial`. | Global unit config | No |
| showAirline | Whether or not show the airline for each flight, if available. | `true` | No |
| showType | Whether or not show the aircraft type for each flight, if available. | `true` | No |
| showSpeed | Whether or not show the aircraft speed for each flight, if available. | `true` | No |
| showAltitude | Whether or not show the aircraft altitude for each flight, if available. | `true` | No |
| showHeading | Whether or not show the aircraft heading for each flight, if available. | `true` | No |
| client | The configuration for the ADS-B client. By default, the mode is set to `rtlsdr` (not other options are needed in this mode). In case of `network` mode, options `host` and `port` are required. | `{mode: 'rtlsdr'}` | No |