Marquee Français

Settings

Every variable the screen's service reads, and every route it exposes: the full reference, alongside the chapters that explain them one by one.

The environment variables

Set in /etc/ecran-atelier.env (Installing the screen chapter), in mode 600: they win over the ones in the systemd unit.

VariableDefaultRole
ADRESSE:8099Where the service listens.
MUSIC_ASSISTANThttp://127.0.0.1:8095Music Assistant's API.
MUSIC_ASSISTANT_JETON(empty)The access token: required since Music Assistant 2.10.
METEO50.85,4.35The weather location: “lat,lon”, or the name of a town.
VISUALISEUR_DECALAGE_MS0The lag between the sound and the spectrum: your speaker's latency (Installing the screen chapter).
ADRESSE_MACHINES:8098Where the machines' services (ecran-agent) connect: set and empty, the port stays closed.
JETONS_MACHINES(empty)“Name=token;Other name=other token”, one token per machine; empty, the machines' port stays closed.

Always set METEO to your own town or coordinates. The service's internal default isn't meant to be used in practice: leaving it aside shows weather that isn't yours.

The routes

“Reserved to the screen” means: the service only answers calls coming from the host machine itself; seen from the network, it answers 403.

RouteRole
GET /The page, full screen.
POST /etatgproj — or any other tool — pushes the window state here (Projects chapter).
GET /fluxThe event stream the page opens: it's notified the moment the state changes, rather than re-polling / every five seconds.
POST /musiqueA music key: play, pause, previous, next, volume, or starting a favorite. Reserved to the screen.
GET /visualiseurThe token and address of the MilkDrop relay, for the spectrum. Reserved to the screen.
POST /toucheA press on a machine key. Reserved to the screen.
GET /icone/<empreinte>.pngA machine key's icon, immutable.
TCP 8098The machines' services (ecran-agent) connect here.
GET /essai/tramesOne second of real frames, for /?essai=spectre.
GET /api/vueThe same content as the page, in JSON: for diagnosing without looking at the screen.
GET /santeWhether the service answers: {"etat":"ok"}.