Mensajes Cliente → Servidor

Formato de los mensajes

Cada mensaje es un objeto JSON con una única clave de primer nivel que identifica el comando. El valor es un objeto cuya estructura depende del comando.

Todas las claves de comandos de cliente están en MAYÚSCULAS (ej. DU, SV, SA, GC).

Índice de comandos

Todos los mensajes dirigidos a un módulo o a una propiedad usan la siguiente envoltura:

{
  "COMANDO": {
    "m": {
      "NombreDelModulo": {
        "p": {
          "nombreDeLaPropiedad": { ... }
        }
      }
    }
  }
}

donde m designa modules y p designa properties.

Gestión de sesión

DU — Solicitar el dump completo

Debe enviarse inmediatamente tras la conexión. El servidor responde con un mensaje d que contiene todos los módulos.

{ "DU": { "language": "es" } }

XX — Heartbeat

Enviar cada 30 segundos para mantener la conexión activa. El servidor responde con xx.

{ "XX": {} }

LO — Conexión

Requerido cuando el servidor tiene activado el control de acceso (grant-client vale "-1" en la respuesta dump).

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

IL — Cambiar el idioma

Modifica el idioma de las etiquetas traducidas sin reconectar.

{ "IL": { "language": "es" } }

Actualización de los valores de propiedad

SV — Enviar el valor de un solo elemento

A usar cuando directedit es true en el elemento — envía inmediatamente el valor de un solo elemento. Sobre un elemento con directedit: false el backend lo rechaza (error en el log del módulo, no se aplica nada): usar SA en su lugar.

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

e contiene un único par nombreElemento: valor.

SA — Enviar todos los valores de elementos

Usado para enviar todos los elementos editables de una propiedad de una vez (ej. desde un formulario). También usado cuando directedit es false.

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

DP — Solicitar el dump de una propiedad

Pide al servidor que reenvíe el estado completo de una propiedad, como si acabara de (re)cargarse — útil para forzar la actualización de una propiedad que un cliente sospecha desincronizada, sin recargar todo el módulo. El servidor responde con un mensaje ap para esa sola propiedad.

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

Sin campo e: DP afecta a toda la propiedad, no a un elemento concreto.

Acciones sobre los iconos

preicon1/preicon2/posticon1/posticon2 (propiedades) y preicon/posticon (elementos, ver Modelo de datos) no son decoraciones: cada una es una acción clicable. Un valor no vacío es el nombre del icono de Google Fonts (Material Icons) a mostrar; al hacer clic en el icono mostrado se envía el comando correspondiente de abajo, sin ningún valor ni parámetro — un payload vacío que simplemente apunta a la propiedad (o al elemento). Lo que la acción hace realmente en el servidor (guardar un perfil, cargar un perfil, lanzar un proceso…) depende enteramente del módulo; la única tarea del cliente es mostrar el icono y reenviar el clic tal cual.

Una cadena vacía significa que no hay ningún icono en ese lugar — nada que mostrar, y por tanto nada que hacer clic ni que enviar. No mostrar un marcador de posición ni conectar un manejador de clic para un campo de icono vacío.

I1 — Clic en preicon1 de propiedad

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

I2 — Clic en preicon2 de propiedad

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

I3 — Clic en posticon1 de propiedad

Misma estructura que I1 / I2.

I4 — Clic en posticon2 de propiedad

Misma estructura que I1 / I2.

J1 — Clic en preicon de elemento

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

J2 — Clic en posticon de elemento

Misma estructura que J1.

Gestión de perfiles

PL — Cargar un perfil

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

El servidor responde con un mensaje fl (perfil cargado) y luego envía los valores de propiedades actualizados.

PS — Guardar un perfil

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

El servidor responde con un mensaje fs (perfil guardado).

Operaciones sobre cuadrículas

Los comandos de cuadrícula apuntan a una propiedad específica dentro de un módulo. Todos usan la envoltura m / p.

GC — Crear una línea de cuadrícula

Añade una nueva línea a la cuadrícula con los valores de elementos proporcionados.

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

El servidor responde con un mensaje gc confirmando el índice de la nueva línea.

GU — Actualizar una línea de cuadrícula

Actualiza una línea específica (índice base cero i) con nuevos valores de elementos.

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

GD — Eliminar una línea de cuadrícula

Elimina la línea en el índice i (base cero).

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

GF — Seleccionar una línea de cuadrícula

Solicita al servidor que cargue una línea de la cuadrícula en los elementos editables de la propiedad (usado al hacer clic en una línea para editarla).

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

GH — Subir una línea de cuadrícula

Desplaza la línea en el índice i una posición hacia arriba.

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

GB — Bajar una línea de cuadrícula

Desplaza la línea en el índice i una posición hacia abajo.

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

GR — Restablecer la cuadrícula

Vacía por completo la cuadrícula de una propiedad (todas las filas eliminadas) — no una sola fila como GD. El servidor difunde gr en respuesta.

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

Sin campo i: GR afecta a toda la cuadrícula, no a una fila concreta.

Ciclo de vida de los módulos

CL — Cargar una configuración

Carga todos los módulos de una configuración guardada (lista en controllerdata.availableconfs, ver Controlador).

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

CS — Guardar la configuración actual

Registra el conjunto de módulos actualmente cargados con el nombre indicado (GlobalDatastore nunca se incluye).

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

ML — Cargar un módulo

Pide al servidor que cargue dinámicamente un módulo. Estos comandos se dirigen al controlador: el payload no usa la envoltura 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 — Descargar un módulo

Pide al servidor que descargue un módulo en ejecución, designado por su nombre.

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

GlobalDatastore no puede descargarse: la petición se rechaza (mensaje de error en los logs).

Consultar un módulo

QY — Consultar un módulo

Mecanismo genérico de consulta/respuesta propio de cada módulo: hacer a un módulo una pregunta con nombre y parámetros, recibir una respuesta con nombre vía qa. Qué nombres de consulta entiende realmente un módulo (si entiende alguno) depende enteramente de ese módulo — el protocolo solo define el sobre. Nótese: sin envoltorio p aquí, QY apunta al propio módulo, no a una de sus propiedades.

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

Sistema de archivos

FS — Elegir la carpeta vigilada

Designa la carpeta cuya lista de archivos publica el servidor (ver Sistema de archivos). La ruta es relativa al webroot; la cadena vacía designa la raíz.

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

El cambio es global en el servidor (todos los clientes ven la nueva lista). La ruta no se valida: una carpeta inexistente da una lista vacía.

Control del servidor INDI embebido

Estos comandos solo están disponibles cuando el servidor dispone de una instancia INDI embebida.

YA y YZ no tienen payload ({"YA": {}}). Para YL, YR, YS, YC y YD, driver es el campo binary de una entrada de controllerdata.indidrivers. Para YK, name es una clave de controllerdata.indiconfigurations (ver Controlador) — inicia todos los drivers guardados bajo ese nombre, independientemente de CL/CS, que en cambio agrupan los drivers activos en una configuración de módulos.

Resumen del control de acceso

Los comandos enviados sin permisos suficientes son ignorados silenciosamente por el servidor.