Wialon для разработчиков Руководство пользователя Документация API core get_hw_cmds

get_hw_cmds

Чтобы получить список команд, доступных для объекта или типа устройства, или получить шаблоны команд, используйте метод core/get_hw_cmds.

Copied!

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

Параметры

Параметр	Описание
deviceTypeId	ID типа устройства.
unitId	ID объекта.
template	Флаг. Если указано значение 1, ответ содержит JSON с данными шаблона команды. Необязательный параметр.
lang	Язык, на который переводятся значения `title` и `label`. Необязательный параметр.

Можно указать только один из параметров deviceTypeId и unitId или оба. Поиск начинается с ID типа устройства, а в случае неудачи продолжается по ID объекта. Если необходимо пропустить параметр, укажите в нем 0.

Ответ

Если значение template равно 0 или параметр не указан, ответ содержит список доступных команд:

Copied!

{
  "<text>": [   /* Тип связи: GSM, TCP, UDP, VRT. */
    "<text>",   /* Тип команды. */
    ...
  ],
  ...
}

Если значение template равно 1, возвращается шаблон команды. Он может содержать произвольный набор полей. Ниже приведен пример JSON:

Copied!

{
  "<cmd_template_name>": {   /* Имя. */
    "icon": <text>,          /* Иконка. */
    "props": [               /* Свойства. */
      {
        "label": <text>,     /* Название свойства. */
        "type": <text>,      /* Тип. */
        "validate": <text>,  /* Правило валидации. */
        "value": [           /* Массив пар «ключ — значение». */
          {
            "n": <text>,     /* Ключ. */
            "v": <text>      /* Значение. */
          },
          ...
        ],
        "default": <text>,   /* Значение по умолчанию (например, порт IP-адреса). */
        "title": <text>,     /* Заголовок. */
        "maxlength": <uint>  /* Максимальная длина. */
      },
      ...
    ]
  },
  ...
}

В случае неудачного выполнения запроса возвращается код ошибки.

Коды ошибок

Код ошибки	Описание
4	Одна из следующих ошибок: Неверные входные параметры. Не удалось получить тип устройства по `deviceTypeId` или `unitId`. Тип устройства недоступен в тарифном плане. У типа устройства нет шаблонов команд (если `template` равен 1).
6	Не удалось получить текущего пользователя.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.