Messages Client → Serveur

Format des messages

Chaque message est un objet JSON avec une seule clé de premier niveau identifiant la commande. La valeur est un objet dont la structure dépend de la commande.

Toutes les clés de commandes client sont en MAJUSCULES (ex. DU, SV, SA, GC).

Index des commandes

Tous les messages ciblant un module ou une propriété utilisent l’enveloppe suivante :

{
  "COMMANDE": {
    "m": {
      "NomDuModule": {
        "p": {
          "nomDeLaPropriété": { ... }
        }
      }
    }
  }
}

où m désigne modules et p désigne properties.

Gestion de session

DU — Demander le dump complet

Doit être envoyé immédiatement après la connexion. Le serveur répond avec un message d contenant tous les modules.

{ "DU": { "language": "fr" } }

XX — Heartbeat

À envoyer toutes les 30 secondes pour maintenir la connexion active. Le serveur répond avec xx.

{ "XX": {} }

LO — Connexion

Requis lorsque le serveur a le contrôle d’accès activé (grant-client vaut "-1" dans la réponse dump).

{
  "LO": {
    "user": "username",
    "pw": "password",
    "language": "fr"
  }
}

IL — Changer la langue

Modifie la langue des libellés traduits sans se reconnecter.

{ "IL": { "language": "fr" } }

Mise à jour des valeurs de propriété

SV — Envoyer la valeur d’un seul élément

À utiliser lorsque directedit est true sur l’élément — envoie immédiatement la valeur d’un seul élément. Sur un élément à directedit: false, le backend le rejette (erreur dans le log du module, rien n’est appliqué) : utiliser SA à la place.

{
  "SV": {
    "m": {
      "Focus": {
        "p": {
          "parameters": {
            "e": {
              "iterations": 7
            }
          }
        }
      }
    }
  }
}

e contient une seule paire nomÉlément: valeur.

SA — Envoyer toutes les valeurs d’éléments

Utilisé pour soumettre tous les éléments éditables d’une propriété en une fois (ex. depuis un formulaire). Également utilisé lorsque directedit est false.

{
  "SA": {
    "m": {
      "Focus": {
        "p": {
          "parameters": {
            "e": {
              "iterations": 7,
              "exposure": 3.5,
              "active": true
            }
          }
        }
      }
    }
  }
}

DP — Demander le dump d’une propriété

Demande au serveur de renvoyer l’état complet d’une propriété, comme si elle venait d’être (re)chargée — utile pour forcer le rafraîchissement d’une propriété qu’un client soupçonne d’être désynchronisée, sans recharger tout le module. Le serveur répond par un message ap pour cette seule propriété.

{
  "DP": {
    "m": {
      "Focus": {
        "p": {
          "parameters": {}
        }
      }
    }
  }
}

Pas de champ e : DP cible la propriété entière, pas un élément particulier.

Actions sur les icônes

preicon1/preicon2/posticon1/posticon2 (propriétés) et preicon/posticon (éléments, voir Modèle de données) ne sont pas des décorations : chacune est une action cliquable. Une valeur non vide est le nom de l’icône Google Fonts (Material Icons) à afficher ; cliquer sur l’icône affichée envoie la commande correspondante ci-dessous sans aucune valeur ni paramètre — un payload vide qui cible simplement la propriété (ou l’élément). Ce que fait réellement l’action côté serveur (sauvegarder un profil, charger un profil, lancer un processus…) dépend entièrement du module ; le seul rôle du client est d’afficher l’icône et de transmettre le clic tel quel.

Une chaîne vide signifie qu’il n’y a aucune icône dans cet emplacement — rien à afficher, et donc rien à cliquer ni à envoyer. Ne pas afficher de substitut ni brancher de gestionnaire de clic pour un champ icône vide.

I1 — Clic sur preicon1 de propriété

{
  "I1": {
    "m": {
      "Focus": {
        "p": {
          "saveprofile": {}
        }
      }
    }
  }
}

I2 — Clic sur preicon2 de propriété

{
  "I2": {
    "m": {
      "Focus": {
        "p": {
          "loadprofile": {}
        }
      }
    }
  }
}

I3 — Clic sur posticon1 de propriété

Même structure que I1 / I2.

I4 — Clic sur posticon2 de propriété

Même structure que I1 / I2.

J1 — Clic sur preicon d’élément

{
  "J1": {
    "m": {
      "Focus": {
        "p": {
          "devices": {
            "e": {
              "myDevice": {}
            }
          }
        }
      }
    }
  }
}

J2 — Clic sur posticon d’élément

Même structure que J1.

Gestion des profils

PL — Charger un profil

{
  "PL": {
    "m": {
      "Focus": {
        "profile": "myProfile"
      }
    }
  }
}

Le serveur répond avec un message fl (profil chargé) puis envoie les valeurs de propriétés mises à jour.

PS — Sauvegarder un profil

{
  "PS": {
    "m": {
      "Focus": {
        "profile": "myProfile"
      }
    }
  }
}

Le serveur répond avec un message fs (profil sauvegardé).

Opérations sur les grilles

Les commandes de grille ciblent une propriété spécifique au sein d’un module. Toutes utilisent l’enveloppe m / p.

GC — Créer une ligne de grille

Ajoute une nouvelle ligne à la grille avec les valeurs d’éléments fournies.

{
  "GC": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "e": {
              "target": "M31",
              "exposure": 120,
              "count": 10
            }
          }
        }
      }
    }
  }
}

Le serveur répond avec un message gc confirmant l’index de la nouvelle ligne.

GU — Mettre à jour une ligne de grille

Met à jour une ligne spécifique (index base zéro i) avec de nouvelles valeurs d’éléments.

{
  "GU": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 1,
            "e": {
              "target": "M42",
              "exposure": 60
            }
          }
        }
      }
    }
  }
}

GD — Supprimer une ligne de grille

Supprime la ligne à l’index i (base zéro).

{
  "GD": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 0
          }
        }
      }
    }
  }
}

GF — Sélectionner une ligne de grille

Demande au serveur de charger une ligne de la grille dans les éléments éditables de la propriété (utilisé lors du clic sur une ligne pour l’éditer).

{
  "GF": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 2
          }
        }
      }
    }
  }
}

GH — Monter une ligne de grille

Déplace la ligne à l’index i d’une position vers le haut.

{
  "GH": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 3
          }
        }
      }
    }
  }
}

GB — Descendre une ligne de grille

Déplace la ligne à l’index i d’une position vers le bas.

{
  "GB": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {
            "i": 2
          }
        }
      }
    }
  }
}

GR — Réinitialiser la grille

Vide entièrement la grille d’une propriété (toutes les lignes supprimées) — contrairement à GD qui ne supprime qu’une ligne. Le serveur diffuse gr en réponse.

{
  "GR": {
    "m": {
      "Sequencer": {
        "p": {
          "sequence": {}
        }
      }
    }
  }
}

Pas de champ i : GR cible la grille entière, pas une ligne particulière.

Cycle de vie des modules

CL — Charger une configuration

Charge tous les modules d’une configuration sauvegardée (liste dans controllerdata.availableconfs, voir Contrôleur).

{ "CL": { "name": "modules" } }

CS — Sauvegarder la configuration courante

Enregistre l’ensemble des modules actuellement chargés sous le nom donné (GlobalDatastore n’est jamais inclus).

{ "CS": { "name": "modules" } }

ML — Charger un module

Demande au serveur de charger dynamiquement un module. Ces commandes visent le contrôleur : le payload n’utilise pas l’enveloppe m/p.

{ "ML": { "lib": "focus", "label": "MyFocuser", "profile": "default" } }

{ "ML": { "lib": "libostdummy", "label": "MyDummy" } }

Error loading library MyDummy - Cannot load library libostlibostdummy: cannot open shared object file: No such file or directory

{ "ML": { "lib": "dummy", "label": "MyDummy" } }

MK — Décharger un module

Demande au serveur de décharger un module en cours d’exécution, désigné par son nom.

{ "MK": { "name": "MyFocuser" } }

GlobalDatastore ne peut pas être déchargé : la demande est refusée (message d’erreur dans les logs).

Interroger un module

QY — Interroger un module

Mécanisme générique de requête/réponse propre à chaque module : poser à un module une question nommée avec des paramètres, recevoir une réponse nommée en retour via qa. Les noms de requête qu’un module comprend réellement (s’il en comprend) dépendent entièrement de ce module — le protocole ne définit que l’enveloppe. À noter : pas d’enveloppe p ici, QY cible le module lui-même, pas une de ses propriétés.

{
  "QY": {
    "m": {
      "Sequencer": {
        "query": "profileduration",
        "params": { "profile": "default" }
      }
    }
  }
}

Système de fichiers

FS — Choisir le dossier surveillé

Désigne le dossier dont le serveur publie la liste de fichiers (voir Système de fichiers). Le chemin est relatif au webroot ; la chaîne vide désigne la racine.

{ "FS": { "folder": "/Sequencer/gam Cyg/LIGHT/Luminance" } }

Le changement est global au serveur (tous les clients voient la nouvelle liste). Le chemin n’est pas validé : un dossier inexistant donne une liste vide.

Contrôle du serveur INDI embarqué

Ces commandes ne sont disponibles que lorsque le serveur dispose d’une instance INDI embarquée.

YA et YZ n’ont pas de payload ({"YA": {}}). Pour YL, YR et YS, driver est le champ binary d’une entrée de controllerdata.indidrivers.

Récapitulatif du contrôle d’accès

Les commandes envoyées sans droits suffisants sont silencieusement ignorées par le serveur.