Web publishing: SatMe-PC pushes to your site

Version française

SatMe-PC can push items to an outside web site: SSTV and SSDV pictures, planches, event reports, contacts, the journal's videos, FT8 / FT4 passes, and as an option live data (auto-pilot, QO-100 spectrum, DATV picture, station, FT8 / FT4), your favourite satellites and your awards. Your site receives them as it likes — a PHP file on shared hosting, a WordPress plugin, a small Python or Node server, anything that can answer an HTTP request. This page covers the setting in SatMe-PC and the wire format (API v1), stable and versioned, with ready-to-use receivers.

With no server at all, SatMe-PC can also write into a folder (see No server: a folder).

SatMe-PC always does the sending: it works from behind a home router, and nothing is opened on the station (the site never connects to the PC).

Contents: Setup · API v1 · Types · Responses · Queue and retries · Live data · Security · Examples · Displaying · Folder

The settings' names below are the French ones shown by SatMe-PC.

Setup in SatMe-PC#

1. Réglages › Modules: tick Publication web. The module is off by default and no profile switches it on: while it is unticked, SatMe-PC sends nothing to anyone (no queue, no test, no live data) and shows no 🌐 button.
2. Réglages › Services en ligne › Envoyer vers un site web:
   • Où envoyer (where): Adresse web (HTTPS) or Dossier sur ce PC (a folder).
   • The address that receives. Two ways:
     • with {type} in it, replaced by each request's type: https://example.org/api/satme/{type} → …/api/satme/sstv-image, …/api/satme/ping;
     • without {type}: everything goes to that one address (webhook style), the type in the X-SatMe-Type header (and the form's type field): https://example.org/satme/receive.php.
   • The token (optional, advised): a secret you make up (for instance openssl rand -hex 32) and your site checks; sent as Authorization: Bearer <token>. It stays on this PC and is never shown again.
   • Tester (test): SatMe-PC sends a ping (nothing is published). Sending is ready only after a test that passes; another address, token or folder is tested again.
   • Quoi envoyer (what to send): each type Sur clic (at a click: the 🌐 button of each item), Automatique (as it comes) or Jamais (never). Everything starts at « Sur clic »: nothing goes by itself until you choose « Automatique ».
3. The 🌐 buttons appear: SSTV viewer, log lines, Planche page (planche and report), videos made by the journal's editor, SSDV pictures (Télémesure › Images SSDV), the passes of the « Passages FT8/FT4 sur le site » card (FT8/FT4 tab), and Envoyer le diplôme reçu (send the award received; Agenda › Diplômes).

http:// (no S) is accepted only towards this machine or the local network (127.0.0.1, 192.168.…, 10.…, 172.16–31.…, ….local, a name without a dot); elsewhere https:// is required. Redirects are not followed: give the final address.

API v1#

Every request is one POST to the address set.

Headers, always#

The version changes only if a receiver written for v1 would stop working: adding a type or a field does not change it. Ignore the fields you do not know.

Media: multipart/form-data#

The types sstv-image, ssdv-image, planche, rapport, qso, journal-video (and the live pictures) arrive like an HTML file-upload form, three fields in this order:

In PHP: $_POST['type'], json_decode($_POST['meta'], true), $_FILES['fichier']. In Python: any multipart reader.

The meta JSON#

Always there:

Depending on the type, when SatMe-PC knows them:

SSTV: passes, auto-pilot, planches (optional)#

All optional: an older SatMe-PC does not send them, and a receiver may ignore them. Times are ISO 8601 UTC strings. A pass id is the satellite's NORAD number and its AOS to the minute ("25544-20261003T1349Z"): the same pass has the same id in every item that names it, as long as it is worked out from the same elements (when in doubt, compare the satellite and the times). A key ("sstv:…", "journal:…", "rapport:…", "planche:…") is another item's cle: it may name an item not published (yet) on your site.

sstv-image and journal-video:

planche:

meilleures[]: {"diapo": 3, "image": "sstv:<file>.png", "utc": "…", "note": 82, "copies": 4, "estimee": true} (note: SatMe's mark 0–100 when known; estimee: the slide number was estimated from the timetable). passages[]: {"id": "25544-20261003T1349Z", "aos": "…", "los": "…", "elMax": 62.4, "images": 5, "diapos": [3, 4], "autopilote": true, "campagne": "ARISS série 34", "video": "journal:<file>.mp4"}.

ssdv-image (an SSDV picture: numbered packets of a JPEG, received over one pass or several — SO-127 and other satellites):

passages[]: {"id": "68446-20261030T0910Z", "aos": "…", "los": "…", "elMax": 48.2, "paquets": 21, "premier": "…", "dernier": "…", "source": "radio", "autopilote": true, "campagne": "SO-127 octobre"} (id, aos, los, elMax when the pass is known; source: radio, or the recording or file the packets were read from).

An SSDV picture grows: missing blocks are grey in the JPEG sent. When more packets arrive (later in the pass, or on another pass), SatMe-PC sends it again with the same cle ("ssdv:<key>"), a minute after its last packet or as soon as it is complete — in Automatique, and in Sur clic once the owner has sent it by hand. Replace the earlier version.

rapport: planche (the planche's key), satellite, catnum, evenementId, evenementGenre, campagne, campagneId, premiere, derniere, as above.

Lists and objects are small (a series has a few dozen passes at most); a receiver that keeps only flat fields loses nothing else.

A whole example (sstv-image):

POST /api/satme/sstv-image HTTP/1.1
Host: example.org
User-Agent: SatMe-PC/2026.10.34 (+https://github.com/f4ioz/SatMe)
X-SatMe-Version: 1
X-SatMe-Type: sstv-image
X-SatMe-Id: 0b6f7c1e-3d0a-4c9e-9a51-6f4f0c2b8e21
Authorization: Bearer 3f9a…
Content-Type: multipart/form-data; boundary=SatMe-5c1e…

--SatMe-5c1e…
Content-Disposition: form-data; name="type"
Content-Type: text/plain; charset=utf-8

sstv-image
--SatMe-5c1e…
Content-Disposition: form-data; name="meta"
Content-Type: application/json; charset=utf-8

{"satellite":"ISS","utc":"2026-10-03T13:51:19Z","mode":"PD120","station":"F4XYZ · JN18FS","evenement":"ARISS octobre 2026","titre":"ISS · PD120","version":1,"type":"sstv-image","id":"0b6f7c1e-3d0a-4c9e-9a51-6f4f0c2b8e21","cle":"sstv:ISS_20261003_135119.png","fichier":{"nom":"ISS_20261003_135119.png","type":"image/png","taille":48213,"sha256":"9f86d0…"}}
--SatMe-5c1e…
Content-Disposition: form-data; name="fichier"; filename="ISS_20261003_135119.png"
Content-Type: image/png

<the PNG's bytes>
--SatMe-5c1e…--

Data only: application/json#

ping, retrait and the live data are a JSON, which carries type and version too.

Types#

ping: {"type":"ping","version":1,"logiciel":"SatMe-PC/…","types":["sstv-image","planche",…]} (types: those not set to « Jamais »). The receiver answers any 2xx. If it answers a JSON, SatMe-PC optionally reads nom or indicatif and site (shown: « ok : site de F4XYZ (https://…) »), and refuses (a list of types the site does not take, named on the card).

retrait: {"type":"retrait","version":1,"typeRetire":"sstv-image","cle":"sstv:…","id":"<the id the site gave back when publishing, or empty>"}. 2xx or 404: withdrawn.

Idempotency#

• X-SatMe-Id identifies a delivery: if it comes again (the network dropped after you stored it, before SatMe-PC read the answer), it is the same one. Simplest: if you already have an item with this id, answer 200 without storing it again.
• cle identifies the item: the same item sent again later (a planche redone) has a new X-SatMe-Id but the same cle; replace the old one.

Responses#

An {"erreur": "…"} in the response is shown as is on the card: write it for a human.

Queue and retries#

Nothing goes from the page itself: each item is first copied into a queue on disk (SatMe-PC's data folder, site/: file.json and envois/; a video is read where it is). A sender thread wakes every 5 seconds and sends what is due, one at a time, in order.

• No answer, 408, 429 or 5xx: tried again after 30 s, 1 min, 2 min, 4 min, 8 min, 16 min, 32 min, then every hour, with the same X-SatMe-Id; each item keeps its own pace.
• The queue survives a restart; 300 items at most (the oldest go).
• The same item asked again while it waits: only the new version stays.
• On the card: what waits, the last try, the last answers, Réessayer maintenant (retry now), Vider la file (empty the queue).

Live data (optional)#

Under En direct, each part is ticked on its own (nothing by default). No queue: what the site does not take is dropped, and the next try waits (30 s, 1 min… 5 min; 2 min after a 403, 10 min after a 401). Only names, times, measurements, a spectrum and pictures — never an address, a pairing code, a password or a key.

pilote: {"maitre": bool, "prochain": {"campagne","sat","aos","los","el"}, "enCours": {…, "phase","mode","images","elMaintenant","azMaintenant","image": {"phase","progression","mode","prochaine"}}, "derniere": {"sat","utc","mode"}} (times in UTC ms). datv: {"verrouille","cielKhz","srKs","service","fournisseur","modcod","mer","marge"}.

A receiver that does not want live data answers 403 (or 404) to these types.

Favourite satellites#

Under En direct, the Satellites favoris line (unticked by default) sends the list of the satellites marked ★ in SatMe-PC, for instance for a home page to feature them. It goes as soon as the list changes, otherwise at most once an hour, and only while the module is on and the target tested.

{"type":"favoris","version":1,"satellites":[{"nom":"ISS","norad":25544},{"nom":"SO-50","norad":27607}],"t":1798000000000}

satellites is the whole list (sorted by name; empty when there is no favourite left): it replaces the previous one. t: when it was sent, UTC ms. To a folder: favoris.json at the root, same content.

A receiver that does not know this type answers 400, 404 or 415: SatMe-PC shows « non pris en charge par le site », without an error, and tries again only the next day (or when the line is ticked again).

Awards#

Under En direct, the Diplômes line (unticked by default) sends the awards followed in Agenda › Diplômes (which must be active), for instance for an « Awards » page on your site: as soon as they change (looked at once a minute), otherwise once a day, only when the module is on and the target tested.

{"type":"diplomes","version":1,"t":1798000000000,"diplomes":[
 {"id":"cat:vucc","nom":"VUCC Satellite","emetteur":"ARRL","sorte":"permanent","statut":"en_cours",
  "libelle":"En cours : 37/100 locators","progression":{"actuel":37,"objectif":100,"unite":"locators"},
  "reglement":"https://www.arrl.org/vucc"},
 {"id":"cat:amsat-scc","nom":"AMSAT Satellite Communicators Club","emetteur":"AMSAT","sorte":"permanent",
  "statut":"recu","recu":1790000000000,"progression":{"actuel":1,"objectif":1,"unite":"contacts"},"image":true},
 {"id":"pzk:75-2","nom":"ARISS SSTV …","emetteur":"ARISS (géré par le PZK)","sorte":"evenement","statut":"a_venir",
  "debut":1798100000000,"fin":1798300000000,"limite":1800500000000,"satellite":"ISS","mode":"PD120",
  "reglement":"https://ariss.pzk.org.pl/sstv/"}]}

diplomes is the whole list and replaces the previous one. Per award: id (stable), nom (name), emetteur (issuer), sorte (permanent: counted from the log; evenement: pictures received during a window), statut (en_cours in progress, obtenable goal reached, to ask for, demande asked, recu received, a_venir to come, pendant the event is on), libelle (SatMe's sentence, in French), progression (actuel, objectif, unite; standing awards), debut, fin, limite (deadline to ask), demande, recu (UTC ms), reglement (rules, https), satellite and mode (events), image (true once the received award's picture was sent). Ignore an unknown field; a missing one has no value.

Never sent: what was counted (locators, entities, states, callsigns worked), the pictures' names, the notes, the name and e-mail of « Pour les demandes », the forms, and the awards hidden, missed, expired or « to check ».

The picture of an award received (diplome-image) goes only on a click: in Agenda › Diplômes, Envoyer le diplôme reçu on an award whose picture is attached (the button shows only when web publishing is ready). Multipart like the media, meta: {"diplome": "<id>", …}, the file: the picture as kept (PNG or JPEG; made a JPEG of 3000 px at most when over 8 MB) or a PDF of 8 MB at most. No queue: when the site does not answer, the button says so; click again.

To a folder: diplomes.json at the root (same content) and diplomes/<id>.png|jpg|pdf. A receiver that does not know diplomes answers 400, 404 or 415: left alone until the next day, without an error.

The station#

Under En direct, the Station line (unticked by default) sends the station as it is now, for a live page to draw the satellite, the antennas and the receiving chain beside the pictures: type direct-station, JSON, about 1 KB. It goes when something changed, at most every 2 s (2 to 10 s, chosen on the line), and every 30 s when nothing changed — so a receiver can take a silence of a minute or two as « station off line ».

{"type":"direct-station","version":1,"t":1798000000000,
 "satellite":{"nom":"ISS","norad":25544,"geo":false,"az":212.4,"el":31.6,"distanceKm":812,"vitesseKmS":-5.84,
   "aos":1797999700000,"los":1798000300000,"elMax":61.3,"choisi":"Mode V/U FM",
   "emetteurs":[{"description":"Mode V/U FM","mode":"FM","descenteHz":437800000,"monteeHz":145990000}]},
 "antennes":{"rotor":{"connecte":true,"az":209.8,"el":30.9,"cibleAz":212.4,"cibleEl":31.6,"enMouvement":true,"horsPortee":false,"azSeul":false},
   "parabole":{"az":150.0,"el":29.7}},
 "reception":{"sdr":{"actif":true,"type":"RTL-SDR","frequenceHz":437800000},
   "datv":{"actif":true,"verrouille":true,"mer":7.4,"marge":2.1,"service":"F4XYZ","cielKhz":10494750},
   "poste":{"modele":"IC-9700","connecte":true,"descenteHz":437800000,"monteeHz":145990000,"mode":"FM"}},
 "enEmission":false,"mode":"phonie"}

Every key is optional except t and enEmission. Never in it: an address, a port, a serial device, a file path, a pairing code, a token, another setting. To a folder: direct/station.json, same content. A receiver that does not know the type answers 400, 404 or 415: SatMe-PC shows « non pris en charge par le site », without an error, and tries again ten minutes later.

The settings call, for a script (POST /api/site/direct, the same as the line's box), parameters in the query string: POST /api/site/direct?on_station=1 (or 0), &periode_station=2 (2 to 10 s).

FT8 / FT4#

Under En direct, the FT8/FT4 line (unticked by default) sends, while FT8 / FT4 listening is on, each slot once decoded (FT8 15 s, FT4 7.5 s; about 9 s, resp. 4.5 s, after its end, the decoder's time): type direct-ft8, JSON, 1 to 10 KB. Each slot goes once, empty ones too (so a live waterfall goes on); what the site does not take is dropped.

{"type":"direct-ft8","version":1,"t":1798000005000,"mode":"FT8","duree":15000,
 "satellite":{"nom":"RS-44","norad":44909,"geo":false,"aos":1797999700000,"los":1798000600000,"elMax":54.4},
 "dialHz":435640000,"transpondeur":"Mode V/U linear",
 "decodes":[{"df":1210,"dt":0.3,"snr":-8,"msg":"CQ EA4XYZ IM79","de":"EA4XYZ","grid":"IM79","cq":true,"toMe":false},
            {"df":1530,"dt":0.2,"snr":-12,"msg":"F4IOZ DL1ABC JO62","de":"DL1ABC","grid":"JO62","cq":false,"toMe":true}],
 "n":2,
 "cascade":{"basHz":200,"hautHz":3000,"bins":256,"lignes":8,"data":"<base64, 2048 bytes>"}}

Only messages heard over the air: no setting, address, path, sound card or anything else of the station. To a folder: direct/ft8.json (the last slot). A receiver that does not know the type answers 400, 404 or 415: left alone ten minutes, without an error. The settings call: POST /api/site/direct?on_ft8=1 (or 0).

A whole pass (ft8-passage, a kind of the queue: Sur clic by default, Automatique sends each pass of the journal when it ends, if it has messages): the 🌐 of the FT8 tab's card « Passages FT8/FT4 sur le site » (SatMe-PC lists the journal's last passes with messages). Multipart like the media: meta (titre, satellite, utc = AOS, mode, stations, carres, cle = ft8:<catnum>_<AOS ms>) and fichier, a JSON (application/json, up to a few hundred KB):

{"version":1,"satellite":{"nom":"RS-44","norad":44909},"aos":1797999700000,"los":1798000600000,"elMax":54.4,
 "transpondeur":"Mode V/U linear","dialHz":435640000,"modes":["FT4"],
 "tranches":[{"t":1797999707500,"mode":"FT4","decodes":[…],"n":3,"cascade":{…}}, …],
 "decodes":148,"stations":23,"carres":17,"dxcc":9}

tranches: each slot with messages (480 at most), its decodes as above (60 at most), cascade only for the slots SatMe-PC still had in memory (the last three hours). stations, carres, dxcc: how many callsigns (not the station's own), locators and DXCC entities were heard.

Security#

• HTTPS on the Internet (SatMe-PC refuses http:// outside the local network).
• A token, long and random, compared in constant time (hash_equals in PHP, hmac.compare_digest in Python). Never put it in a public page or a repository.
• Check the type and the size: an allow-list of types and extensions, a maximum size per type; refuse the rest (403, 413, 415).
• Never trust the file name: name files yourself (for instance after X-SatMe-Id), with no .. or /.
• Store outside the web root when you can, and serve the files through a script or a rule that does not execute them. Otherwise, forbid execution in the receiving folder (Apache: php_flag engine off / RemoveHandler .php .phtml / Options -ExecCGI in an .htaccess, or better Require all denied and a script serving the files). Never execute an uploaded file.
• Escape every text of meta when displaying it (it is free text).
• Rate-limit if your host allows it.

Ready-to-use receivers#

In docs/exemples/publication-web/ (GPL-2.0-or-later, like the rest of the repository: copy them, adapt them):

• recevoir.php — a single PHP file (7.4+) for shared hosting: checks the token and the type, stores the media and its JSON card in a folder, keeps index.json up to date, answers JSON. Set TOKEN and DIR at the top; in SatMe-PC, the address https://your-site/recevoir.php (no {type}). For videos, PHP's upload_max_filesize and post_max_size must follow.
• recevoir.py — Python 3, standard library only: the same, plus retrait and the live data (direct/direct.json, the pictures). It also serves the folder read-only (GET):

  SATME_JETON=$(openssl rand -hex 32) python3 recevoir.py --dossier ./satme-donnees --port 8765

  Address in SatMe-PC: http://127.0.0.1:8765/satme/{type} on the same machine (--ecoute 0.0.0.0 for the local network). On the Internet, put it behind an HTTPS server (nginx, Caddy).
• index.html — a plain HTML and JavaScript page that reads index.json and shows the pictures, videos, documents and contacts.

All three share the layout of the folder target: a page made for one works with the others.

Displaying what was received#

Everything is in the receiving folder:

satme-donnees/
├── index.json                         the latest items, newest first
├── sstv-image/2026/0b6f7c1e-….png     the file
├── sstv-image/2026/0b6f7c1e-….json    its card: the meta JSON + "chemin" + "ajoute"
├── qso/2026/….adi + ….json
├── favoris.json                       the favourite satellites (when ticked)
├── diplomes.json, diplomes/…          the awards (when ticked) and the pictures sent with a click
└── direct/direct.json, station.json, datv.jpg, sstv.jpg   (live data, rewritten in place)

index.json:

{
  "version": 1,
  "maj": "2026-10-03T13:52:02Z",
  "elements": [
    { "type": "sstv-image", "id": "0b6f7c1e-…", "cle": "sstv:ISS_20261003_135119.png",
      "titre": "ISS · PD120", "satellite": "ISS", "utc": "2026-10-03T13:51:19Z", "mode": "PD120",
      "chemin": "sstv-image/2026/0b6f7c1e-….png", "ajoute": "2026-10-03T13:52:02Z",
      "fichier": { "nom": "ISS_20261003_135119.png", "type": "image/png", "taille": 48213, "sha256": "9f86…" } }
  ]
}

• A static page: copy index.html beside index.json, or write your own (one fetch('index.json'), one loop).
• WordPress, a CMS: read index.json (or the cards) from a template or a plugin.
• A static site generator: Hugo reads JSON as data (resources.Get / transform.Unmarshal), Jekyll through _data/.

No server: a folder#

Choose Dossier sur ce PC at step 1 and give a full path (/home/me/Nextcloud/satme, C:\Users\me\Sync\satme). Tester checks it can be written. SatMe-PC then writes each item sent there, with the same queue, the same Sur clic / Automatique / Jamais choices and the same cards as the API:

• <folder>/<type>/<YYYY>/<id>.<ext> and <id>.json (the API's meta, plus chemin and ajoute); the year comes from utc;
• index.json: the last 500, newest first (a new version of the same item replaces the old one, files included);
• flux.xml: an Atom feed of the last 50 (links relative to the folder);
• direct/direct.json (rewritten in place), direct/station.json, direct/datv.jpg, direct/sstv.jpg when live data is ticked — no spectrum to a folder;
• direct/ft8.json (the last slot) when FT8/FT4 is ticked; a pass (ft8-passage) like any item, ft8-passage/<year>/<id>.data.json (its card <id>.json);
• favoris.json when Satellites favoris is ticked;
• diplomes.json when Diplômes is ticked, diplomes/<id>.<ext> for each picture sent with Envoyer le diplôme reçu.

Each file is written beside its place then renamed (atomic where the system allows): a reader never sees half a file, and the index never names a file not yet there.

What for:

• a static site (Hugo, Jekyll, HTML): the folder inside the site, then your usual publishing;
• a sync tool you already have: Nextcloud, Syncthing, an rsync or FTP mirror (lftp mirror -R), a shared folder. SatMe-PC never does FTP itself.

The folder is not available in the demonstration.