Wialon para desarrolladores Manual de usuario Documentación de API core get_hw_cmds

get_hw_cmds

Para obtener la lista de comandos disponibles para una unidad o un tipo de dispositivo, o para obtener las plantillas de comandos, utilice el método core/get_hw_cmds.

Copied!
svc=core/get_hw_cmds&params={
  "deviceTypeId": <long>,
  "unitId": <long>,
  "template": <bool>,
  "lang": "<text>"
}

Parámetros

Parámetro Descripción
deviceTypeId ID del tipo de dispositivo.
unitId ID de la unidad.
template Flag. Si se establece en 1, la respuesta contiene un JSON con los datos de la plantilla del comando. El parámetro es opcional.
lang Idioma al que se traducen los valores de title y label. El parámetro es opcional.

Puede indicar solo uno de los parámetros deviceTypeId y unitId o ambos. La búsqueda comienza por el ID del tipo de dispositivo y, si falla, continúa por el ID de la unidad. Si desea omitir un parámetro, establézcalo en 0.

Respuesta

Si template es 0 o no se indica, la respuesta contiene la lista de comandos disponibles:

Copied!
{
  "<text>": [   /* Tipo de conexión: GSM, TCP, UDP, VRT. */
    "<text>",   /* Tipo de comando. */
    ...
  ],
  ...
}

Si template es 1, se devuelve la plantilla del comando. Puede contener un conjunto personalizado de campos. A continuación se muestra un ejemplo de JSON:

Copied!
{
  "<cmd_template_name>": {   /* Nombre. */
    "icon": <text>,          /* Icono. */
    "props": [               /* Propiedades. */
      {
        "label": <text>,     /* Etiqueta de la propiedad. */
        "type": <text>,      /* Tipo. */
        "validate": <text>,  /* Regla de validación. */
        "value": [           /* Array de pares clave-valor. */
          {
            "n": <text>,     /* Clave. */
            "v": <text>      /* Valor. */
          },
          ...
        ],
        "default": <text>,   /* Valor predeterminado (por ejemplo, el puerto de la dirección IP). */
        "title": <text>,     /* Título. */
        "maxlength": <uint>  /* Longitud máxima. */
      },
      ...
    ]
  },
  ...
}

Si la solicitud falla, se devuelve un código de error.

Códigos de error

Código de error Descripción
4 Uno de los siguientes errores:
  • Parámetros de entrada incorrectos.
  • No se pudo obtener el tipo de dispositivo por deviceTypeId ni por unitId.
  • El tipo de dispositivo no está disponible en el plan de facturación.
  • El tipo de dispositivo no tiene plantillas de comandos (si template es 1).
6 No se pudo obtener el usuario actual.

Si nota un error en el texto, por favor resáltelo y presione Ctrl+Intro.