Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Управление проектом через командную строку

CLI-утилита (Интерфейс командной строки) alpha.hmi.cli входит в состав Alpha.HMI и предназначена для управления проектами Alpha.HMI через командную строку. CLI-утилита предоставляет возможность автоматизировать различные задачи, такие как компиляция проекта и выгрузка метаинформации. В данном разделе рассмотрены ключевые аспекты работы с Alpha.HMI через командную строку.

Подготовка к работе

Перед использованием команд alpha.hmi.cli убедитесь, что вы находитесь в директории установки Alpha.HMI. Для этого выполните следующую команду (пример для ОС Windows):

cd C:\"Program Files"\Automiq\Alpha.HMI

Структура командной строки

Общий формат командной строки выглядит следующим образом:

alpha.hmi.cli COMMAND [OPTIONS]
  • alpha.hmi.cli: Название утилиты.

  • COMMAND: Команда для выполнения определенной операции.

  • OPTIONS: Дополнительные параметры и настройки для команды.

Команды

CLI-утилита alpha.hmi.cli предоставляет две основные команды для управления процессом работы с проектами Alpha.HMI.

  • compile. Команда compile предназначена для компиляции проекта.

  • extract. Команда extract позволяет выгрузить метаинформацию (метаописания из модулей и проектов).

Компиляция проекта

Для компиляции проекта используйте команду compile. Команда compile запускает процесс компиляции проекта Alpha.HMI. Во время компиляции все необходимые файлы и ресурсы проекта обрабатываются и преобразуются в исполняемые компоненты, готовые к работе.

Для использования вместе с командой compile доступны следующие опции:

  • --solution-path: Путь к файлу проекта Alpha.HMI.

  • --output-format: Опция для указания формата вывода информации о компиляции. Может быть Plain (текстовый формат) или формат JSON.

  • --export-binom: Опция экспорта проекта Alpha.HMI в формат binom.

Выполнить компиляцию проекта Alpha.HMI с использованием CLI-утилиты alpha.hmi.cli с выводом информации о компиляции в json формате.

alpha.hmi.cli --solution-path C:\Projects\Project_HMI\Test_HMI.hmi --output-format json compile

Выполнить компиляцию и экспорт проекта Alpha.HMI в формат binom с использованием CLI-утилиты alpha.hmi.cli.

alpha.hmi.cli --solution-path C:\Projects\Project_HMI\Test_HMI.hmi --output-format json compile --export-binom

Выгрузка метаинформации

Для выгрузки метаинформации (метаописаний из модулей и проектов) используйте команду extract. Команда extract предназначена для выгрузки текстового описания встроенных и нативных юнитов в формате JSON или Plain.

Для использования вместе с командой extract доступны следующие опции:

  • --language: Указывает язык локализации, используемый в ходе работы команды и язык выгружаемых метаописаний. Допустимые значения: ru_RU (русский), en_US (английский).

  • --solution-path: Путь к проекту Alpha.HMI. Если не задано, метаописания извлекаются только из загруженных нативных и встроенных модулей. Если задано, то в том числе из проекта Alpha.HMI.

  • --output-format: Указывает формат отображения вывода. Доступные значения: plain, json. Значение по умолчанию: plain.

  • --output-file: Путь к выходному JSON-файлу метаописаний. Этот параметр является обязательным.

  • --exclude-unit <UUID>: Опция для исключения указанного юнита с помощью его уникального идентификатора.

Выполнить выгрузку метаинформации проекта Alpha.HMI с использованием CLI-утилиты alpha.hmi.cli с выводом информации в json формате.

alpha.hmi.cli extract --solution-path C:\Projects\Project_HMI\Test_HMI.hmi --output-format json --output-file  C:\Projects\Project_HMI\Test.json

Форматы вывода

CLI-утилита alpha.hmi.cli предоставляет возможность выбора формата вывода информации: формат Plain и формат JSON.

Формат Plain

Опция --output-format plain активирует простой текстовый формат. В этом формате сообщения выводятся следующим образом:

[SOURCE] MESSAGE-TYPE: UNIT, ELEMENT, TEXT

Где:

  • SOURCE - источник сообщения, например, сама команда (compile или extract).

  • MESSAGE-TYPE - тип сообщения: error, warning, info или hint.

  • UNIT - наименование юнита.

  • ELEMENT - полный путь (относительно юнита) к элементу, ассоциированному с сообщением.

  • TEXT - текст сообщения.

Выполнить компиляцию проекта Alpha.HMI с использованием CLI-утилиты alpha.hmi.cli с выводом информации о компиляции в plain формате.

Введем в командной строке следующую команду:

alpha.hmi.cli --solution-path C:\Projects\Project_HMI\Test_HMI.hmi --output-format plain compile

Результат вывода в plain формате:

[compile] info: < Компиляция началась >
[compile] info: < Время компиляции: 0.029 секунд >
[compile] info: < Компиляция завершилась успешно >

Формат JSON

Опция --output-format json активирует формат вывода в виде JSON-объектов. Каждое сообщение представлено отдельным объектом со следующей json-структурой:

{
"source": "источник сообщения",
"message": {
"type": "тип сообщения",
"unit": "наименование юнита",
"element": "полный путь к элементу",
"text": "текст сообщения"
⠀⠀⠀⠀⠀⠀⠀ ⠀}
}

Выполнить компиляцию проекта Alpha.HMI с использованием CLI-утилиты alpha.hmi.cli с выводом информации о компиляции в json формате.

Введем в командной строке следующую команду:

alpha.hmi.cli --solution-path C:\Projects\Project_HMI\Test_HMI.hmi --output-format json compile

Результат вывода в json формате:

{"source":"compile","message":{"type":"info","text":"< Компиляция началась >"}}
{"source":"compile","message":{"type":"info","text":"< Время компиляции: 0.019 секунд >"}}
{"source":"compile","message":{"type":"info","text":"< Компиляция завершилась успешно >"}}

Возврат кодов

При взаимодействии с CLI-утилитой alpha.hmi.cli возможны различные коды возврата, которые указывают на результат выполнения операции. Основные коды возврата и их значения:

  • 0: Операция выполнена успешно.

  • 1 и выше: Операция завершилась с ошибкой.

После выполнения команды compile или extract, вы можете использовать %errorlevel%, чтобы узнать, как завершилась операция.

Выполнить компиляцию проекта и получить код завершения операции:

REM Компилируем проект
alpha.hmi.cli compile --solution-path C:\Projects\Project_HMI\Test_HMI.hmi --output-format plain
REM Проверяем значение %errorlevel%
echo Exit code = %errorlevel%