Cómo usar esta página con tus herramientas de AI
Para qué sirve. Esta página es la referencia oficial del contrato de WebApps v1. Úsala para que cualquier asistente de AI genere paquetes válidos para la plataforma Tekus.
En cualquier herramienta. Pega el link de esta página, o su contenido, como contexto o conocimiento del proyecto. Luego dale una instrucción explícita, por ejemplo:
Usa como referencia obligatoria el contrato en la guía oficial para generar la WebApp; respeta la estructura del paquete, los ParameterTypes v1 y las reglas de scripts.
Claude. Agrega esta página como conocimiento o como instrucciones de un Project.
Grok. Agrega el link de esta página y la instrucción de arriba en las instrucciones personalizadas, o en el contexto del proyecto o workspace.
Buenas prácticas.
-
Toma siempre la versión vigente de esta página; no trabajes con copias viejas.
-
Si algo choca con otra fuente, manda esta página.
-
Antes de subir el paquete, valídalo contra las reglas de empaquetado: las de esta página y la lista de verificación del Manual de Construcción (ver "Reglas de construcción relacionadas" al final).
Contrato de WebApps (v1)
Definición del contrato de WebApps de señalización digital Tekus, lista para publicar.
Este documento define solo el contrato del paquete para la primera versión soportada (los tipos de parámetro marcados como versión 1). No describe flujos de la interfaz de administración, matrices de firmware de los players ni nombres de repositorios internos.
Qué es una WebApp
Una WebApp es una aplicación HTML estática (HTML/CSS/JS, opcionalmente generada con un build estático de AngularJS, Vue, React o similares) que un player Tekus ejecuta como contenido de una lista de reproducción o como capa fija superpuesta.
Contenido del paquete
Obligatorio:
-
webapp.config: manifiesto JSON. -
HTML de entrada:
index.html, o el archivo indicado enEntryPoint.
Opcional:
-
webapp.current.config: valores actuales de los parámetros, en pares Key/Value. -
preview.jpg: miniatura de vista previa.
El HTML de entrada debe estar en la raíz del ZIP (no dentro de una carpeta contenedora).
webapp.config
{
"Id": "uuid",
"Version": "1.0.0",
"Name": "My Custom App",
"Description": "Show last records from internal system",
"Parameters": [
{
"Key": "Key1",
"Name": "Name",
"Description": "Description",
"ParameterType": "string",
"DefaultValue": "example"
}
],
"EntryPoint": "index.html",
"DefaultTime": 15
}
|
Campo |
Regla |
|---|---|
|
|
UUID/GUID único por WebApp. Nunca se reutiliza al clonar una WebApp para crear una nueva. |
|
|
De uno a tres segmentos numéricos separados por |
|
|
Nombre que se muestra en el catálogo (máximo 200 caracteres). |
|
|
Descripción en el catálogo. |
|
|
Arreglo de definiciones de parámetros con el que se construyen los formularios de configuración. |
|
|
Opcional; por defecto |
|
|
Duración en segundos cuando la WebApp es un elemento de la lista de reproducción. |
Objeto de parámetro
|
Campo |
Regla |
|---|---|
|
|
Identificador (normalmente en camelCase). |
|
|
Etiqueta legible. |
|
|
Texto de ayuda corto. |
|
|
Uno de los tipos de v1 listados abajo. |
|
|
No puede estar vacío. Usa un valor centinela (por ejemplo |
|
|
Obligatorio para |
Valores de ParameterType soportados (solo versión 1)
Un paquete v1 emite solo los tipos de esta tabla.
|
Tipo |
Ejemplo |
Notas |
|---|---|---|
|
|
texto |
|
|
|
|
|
|
|
|
Punto como separador decimal |
|
|
|
|
|
|
|
Color web |
|
|
|
|
|
|
|
Ancho/alto |
*_option = una sola opción de Options. *_multiple = selección múltiple de Options.
Fuera de la versión 1
Estos tipos existen en el catálogo de la plataforma y se listan solo como referencia. Un paquete v1 no los emite.
|
Familia de tipos |
Versión de plataforma |
Estado en este contrato |
|---|---|---|
|
|
2 |
Solo referencia; no se emite en paquetes v1 |
|
Tablas de información dinámica |
3 |
Fuera de alcance para paquetes v1 |
webapp.current.config
Arreglo opcional con los valores actuales. Los key corresponden a los identificadores de cada parámetro:
[
{ "Key": "Key1", "Value": "Value1" },
{ "Key": "Key2", "Value": "Value2" }
]
Modos de ejecución (resumen)
-
Elemento de lista de reproducción: se reproduce como un video o una imagen durante la duración del elemento o
DefaultTime. Es el camino principal actual. -
Continuo: configuración a nivel de player.
-
Plantilla de diseño personalizado: controles
<webapp/>embebidos en una plantilla. Es una capacidad aparte; no la asumas sin confirmarla.
Asignación de parámetros (informativo)
-
Paquetes independientes o generados con IA: leen los valores del query string de la URL (
URLSearchParams) y, si no vienen, usan elDefaultValuede cada parámetro, para que la página se vea bien con el query string vacío. -
Instaladas en la plataforma: los operadores definen los valores en formularios del CMS generados a partir de
Parameters; los valores actuales pueden aparecer enwebapp.current.config. Las WebApps fijas deben definir su tamaño y posición en CSS (unidades relativas); no esperes que el CMS inyecte coordenadas de diseño.
Reglas de construcción relacionadas
Las reglas de empaquetado y de seguridad para el player (ES2015; el script principal no usa type="module" ni crossorigin, y defer es obligatorio; separadores POSIX en el ZIP; fuentes locales; DefaultValue no vacío; un solo ZIP para todos los sistemas operativos) están documentadas en el Manual de Construcción complementario y no se repiten aquí.