Wialon para desarrolladores Manual de usuario Documentación de API unit update_command_definition

update_command_definition

Para crear, modificar o eliminar un comando, utilice el método unit/update_command_definition.

Endpoint

Copied!

svc=unit/update_command_definition&params={
  "itemId": <long>,
  "id": <long>,
  "callMode": "<text>",
  "n": "<text>",
  "c": "<text>",
  "l": "<text>",
  "p": "<text>",
  "a": <long>,
  "f": <uint>,
  "jp": "<text>"
}

Parámetros

La solicitud debe contener los siguientes parámetros:

Parámetro	Descripción
`itemId`	ID de la unidad.
`id`	ID del comando. Al crear un comando, especifique 0. El sistema ignora este valor y asigna el ID por sí mismo.
`callMode`	Acción: `create`, `update` o `delete`.

Para crear o modificar un comando, especifique también los siguientes parámetros:

Parámetro	Descripción
`n`	Nombre del comando.
`c`	Tipo de comando (ver Tipos de comandos).
`l`	Tipo de enlace (ver Tipos de enlace).
`p`	Parámetros.
`a`	Derechos de acceso que el usuario debe tener para ejecutar este comando (ver check_items_billing).

Los siguientes parámetros son opcionales:

Parámetro	Descripción
`f`	Flags del comando. El valor predeterminado es 0. El flag 0x4 indica que el comando tiene un archivo adjunto. Se establece automáticamente si carga un archivo con la solicitud.
`jp`	Parámetros JSON del comando como texto. Si no especifica este parámetro al actualizar un comando, sus parámetros JSON se borran.

Tipos de comandos

Valor	Tipo de comando
`block_engine`	Bloquear motor
`unblock_engine`	Desbloquear motor
`custom_msg`	Enviar mensaje personalizado
`driver_msg`	Enviar mensaje al conductor
`download_msgs`	Descargar mensajes
`query_pos`	Solicitar ubicación
`query_photo`	Solicitar foto
`query_photo_cam`	Solicitar foto de cámara concreta
`query_ddd`	Solicitar archivo DDD del tacógrafo
`output_on`	Activar salida
`output_off`	Desactivar salida
`send_position`	Enviar ubicación
`send_route`	Enviar ruta
`send_waypoints`	Enviar puntos de ruta
`set_report_interval`	Definir intervalo de transferencia de datos
`request_configuration`	Solicitar configuración
`upload_cfg`	Actualizar configuración
`upload_sw`	Cargar firmware
`wiatag_service`	Iniciar/Detener WiaTag (para el tipo de dispositivo WiaTag)
`secoon`	Activar la función SECO (corte seguro del motor)
`secooff`	Desactivar la función SECO (corte seguro del motor)

La lista no es exhaustiva: los tipos de dispositivos pueden definir otros tipos de comandos.

En Wialon Local, los tipos de comandos secoon y secooff están disponibles a partir de la versión 2504.

Tipos de enlace

Valor	Tipo de enlace
Cadena vacía	Automático
`tcp`	TCP
`udp`	UDP
`vrt`	Virtual
`gsm`	SMS

Copia del archivo adjunto

Para copiar el archivo adjunto a un comando de otra unidad, especifique el flag 0x4 en f y los siguientes parámetros, además de los necesarios para crear o modificar un comando:

Parámetro	Descripción
`oldItemId`	ID de la unidad de la que desea copiar el archivo.
`oldCmdId`	ID del comando cuyo archivo desea copiar.

Solo se copia el archivo. Las demás propiedades del comando se toman de la solicitud. Si p está vacío, se utilizan los parámetros del comando de origen. Para copiar el archivo, el usuario debe tener el derecho de acceso Ver comandos a la unidad de origen.

Respuesta

Si un comando se crea o se modifica correctamente, se devuelve una respuesta en el siguiente formato:

Copied!

[
  <long>,          /* ID del comando */
  {
    "id": <long>,  /* ID del comando */
    "n": "<text>", /* Nombre del comando */
    "c": "<text>", /* Tipo de comando */
    "l": "<text>", /* Tipo de enlace */
    "p": "<text>", /* Parámetros */
    "a": <long>,   /* Derechos de acceso necesarios para ejecutar el comando */
    "f": <uint>,   /* Flags */
    "jp": "<text>",/* Parámetros JSON; solo si están especificados */
    "ct": <uint>,  /* Hora de creación (marca de tiempo Unix) */
    "mt": <uint>   /* Hora de la última modificación (marca de tiempo Unix) */
  }
]

En Wialon Local, los campos ct y mt están disponibles a partir de la versión 2304.

Si un comando se elimina correctamente, se devuelve una respuesta en el siguiente formato:

Copied!

[
  <long>,          /* ID del comando */
  null
]

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

Códigos de error

Código de error	Descripción
4	Parámetros de entrada incorrectos: falta un parámetro obligatorio o tiene un tipo incorrecto, `callMode` tiene un valor no admitido, no se pudo crear o actualizar el comando, o la unidad, el comando o el archivo de origen para la copia no están disponibles.
6	El comando con el `id` especificado no existe (al actualizar y eliminar) o no se pudo eliminar el comando.
7	La unidad no existe o el usuario no tiene los derechos de acceso Ver comandos y Crear, modificar y eliminar comandos a ella.

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