Skip to content

About

TRMNL plugin: the plane flying over your home, live, with the real sky behind it

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

11 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FlightPoster

English · Français

FlightPoster on a color screen


English

Look up: FlightPoster tells you which plane is flying over your home.

Design heavily inspired by AvioFrame's superb work, rebuilt from scratch for the TRMNL ecosystem.

A TRMNL plugin that shows the plane flying over your home, with the real sky behind it: sun, dusk or night, and the current weather (clouds, rain, snow, fog, thunderstorms). It is the first plugin of the Poster suite, with WeatherPoster, GamePoster, MoviePoster, ShowPoster and BookPoster.

No server to install. Everything comes from free, community-run data sources:

Data Source
Live aircraft positions adsb.fi open data
Routes, airlines, aircraft adsbdb, with VRS standing data (via adsb.lol) as a fallback
Weather Open-Meteo (CC BY 4.0)

Features

  • E-ink and color: a pure black & white style built for 1-bit screens (TRMNL OG, TRMNL X), and a color style for LCD screens
  • Every layout: full screen, half horizontal, half vertical and quadrant (mashups)
  • Real sky: day, dusk or night from the sun's position, plus the current weather
  • Empty sky: when no plane is overhead, shows the weather, the temperature and the nearest plane outside your radius
  • English or French, metric or imperial units
  • Flights without a published route (private, business, military) show their operator or aircraft type instead

Screenshots

E-ink, day Color, thunderstorm
E-ink · clear day · imperial units Color · thunderstorm
TRMNL X, snowy night Color, no planes
TRMNL X · snowy night Color · no plane overhead
Half horizontal Quadrant
Half horizontal · rain Quadrant · night

Installation

Note

This plugin is built and tested on LaraPaper only. It should work on usetrmnl.com and other TRMNL servers, but it has not been tested there: feedback is welcome in the issues.

TRMNL (usetrmnl.com): create a Private Plugin with the Polling strategy, then copy:

  • both URLs from polling_url in recipe/src/settings.yml (one per line) into Polling URL;
  • the custom_fields from recipe/src/settings.yml into Custom fields (YAML);
  • recipe/src/shared.liquid into Shared markup, and each recipe/src/<layout>.liquid into the matching layout tab.

The recipe/src/ folder follows the trmnlp layout.

LaraPaper / BYOS: Plugins → Import recipe, pick flightposter-x.y.z.zip from the latest release (or zip the contents of recipe/src/), then fill in your settings.

Settings

Field Purpose
Latitude / Longitude Your home's position
Display name Shown in "The sky above …" (defaults to "home")
Language English or French
Units Metric (m, km/h, °C) or imperial (ft, mph, °F)
Radius How close a plane must be to count as overhead, in km or miles (default 25)
Prefer airliners Ignore light aircraft when an airliner is within the radius
Style E-ink (black & white) or Color

Notes

  • The screen is built with JavaScript at render time, so the renderer must run JavaScript.
  • Route lookups happen at render time. If adsbdb doesn't answer, the plane still shows with its callsign.
  • The data sources are free community services: please keep the refresh interval reasonable (5 minutes or more).

Français

Levez les yeux : FlightPoster vous dit quel avion survole votre maison.

Design grandement inspiré par le superbe travail d'AvioFrame, recodé de zéro pour l'écosystème TRMNL.

Un plugin TRMNL qui affiche l'avion qui passe au-dessus de chez vous, avec le vrai ciel derrière : soleil, crépuscule ou nuit, et la météo du moment (nuages, pluie, neige, brouillard, orage). C'est le premier plugin de la suite Poster, avec WeatherPoster, GamePoster, MoviePoster, ShowPoster et BookPoster.

Aucun serveur à installer. Toutes les données viennent de services gratuits et communautaires :

Données Source
Positions des avions en direct données ouvertes adsb.fi
Itinéraires, compagnies, appareils adsbdb, avec la base VRS standing data (via adsb.lol) en secours
Météo Open-Meteo (CC BY 4.0)

Fonctionnalités

  • E-ink et couleur : un style noir et blanc pensé pour les écrans 1 bit (TRMNL OG, TRMNL X), et un style couleur pour les écrans LCD
  • Tous les formats : plein écran, demi horizontal, demi vertical et quart d'écran (mashups)
  • Le vrai ciel : jour, crépuscule ou nuit selon la position du soleil, et la météo actuelle
  • Ciel vide : quand aucun avion ne passe, affiche la météo, la température et l'avion le plus proche hors du rayon
  • Français ou anglais, unités métriques ou impériales
  • Les vols sans itinéraire publié (privés, d'affaires, militaires) affichent leur opérateur ou leur modèle d'avion

Captures

Couleur, jour E-ink, crépuscule sous la pluie
Couleur · éclaircies E-ink · crépuscule sous la pluie
E-ink, brouillard, aucun avion Demi vertical
E-ink · brouillard, aucun avion Demi vertical

Installation

Note

Ce plugin est développé et testé uniquement sur LaraPaper. Il devrait fonctionner sur usetrmnl.com et les autres serveurs TRMNL, mais il n'y a pas été testé : les retours sont les bienvenus dans les issues.

TRMNL (usetrmnl.com) : créer un Private Plugin en stratégie Polling, puis recopier :

  • les deux URL de polling_url dans recipe/src/settings.yml (une par ligne) dans Polling URL ;
  • les custom_fields de recipe/src/settings.yml dans Custom fields (YAML) ;
  • recipe/src/shared.liquid dans Shared markup, et chaque recipe/src/<format>.liquid dans l'onglet du format correspondant.

Le dossier recipe/src/ suit l'organisation de trmnlp.

LaraPaper / BYOS : Plugins → Import recipe, choisir flightposter-x.y.z.zip dans la dernière release (ou zippez le contenu de recipe/src/), puis renseigner les réglages.

Réglages

Champ Rôle
Latitude / Longitude Position de votre domicile
Nom affiché Affiché dans « Le ciel au-dessus de … » (par défaut « chez moi »)
Langue Anglais ou français
Unités Métriques (m, km/h, °C) ou impériales (ft, mph, °F)
Rayon Distance maximale pour qu'un avion soit « au-dessus », en km ou en miles (25 par défaut)
Avions de ligne en priorité Ignore l'aviation légère quand un avion de ligne est dans le rayon
Style E-ink (noir et blanc) ou Couleur

Remarques

  • L'affichage est construit en JavaScript au moment du rendu : le moteur de rendu doit exécuter le JavaScript.
  • Les itinéraires sont récupérés au moment du rendu. Si adsbdb ne répond pas, l'avion s'affiche quand même avec son indicatif.
  • Les sources de données sont des services communautaires gratuits : merci de garder un intervalle de rafraîchissement raisonnable (5 minutes ou plus).

Les captures sont réalisées sur Lyon, avec des données de démonstration.


Développement / Development

Chemin Rôle
recipe/src/ Code du plugin (settings.yml, shared.liquid, un fichier par format)
recipe/screenshots/ Captures du README
dev/design/ Pistes de redesign explorées (Billet, Hublot, Radar), non retenues
dev/recipe_render.sh <dossier> Zippe la recette, l'importe dans LaraPaper en « FlightPoster (test) » et rapatrie les rendus de test
dev/recipe_test.php Cas de test rendus par dev/recipe_render.sh (formats, styles, météo, langues)
dev/migrate.php Applique la recette testée au plugin FlightPoster en place
dev/update_shared.php Met à jour uniquement le markup partagé du plugin en place
dev/palette_apply.php + dev/palette.json Palette 256 couleurs pour les écrans couleur sous LaraPaper

Les scripts visent un serveur LaraPaper en Docker joignable en SSH (conteneur larapaper-app-1), désigné par LARAPAPER_SSH (ex. root@mon-serveur), dans l'environnement ou dans dev/.env (ignoré par git). / The scripts target a LaraPaper server running in Docker over SSH (container larapaper-app-1), set with LARAPAPER_SSH (e.g. root@my-server) in the environment or in dev/.env (ignored by git).


Licence / License

Code sous licence MIT. Les données affichées appartiennent à leurs sources respectives. / Code released under the MIT license. The data shown belongs to its respective sources.

About

TRMNL plugin: the plane flying over your home, live, with the real sky behind it

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages