Перейти к содержимому

Скрипты: основы

Скрипты пишутся на JavaScript. Простые действия удобнее собрать из системных функций, а скрипт нужен, когда появляются условия, вычисления, циклы или работа с несколькими элементами сразу.

Скрипты бывают двух видов.

Клиентские Серверные
Где выполняются В программе оператора и в браузере, у каждого клиента свои На сервере, один экземпляр на весь проект
Где пишутся На событиях элементов и экранов, в модулях scripts/*.js В задачах и модулях serverscripts/*.js
Что умеют Теги, элементы экрана, окна, вопросы оператору Теги, базы данных, файлы, журнал, квитирование
Работают без оператора Нет Да
Предел времени одного запуска 2 секунды 5 секунд

Эта страница про клиентские скрипты. Подробности по каждому объекту: Справочник API экрана, Элементы из скриптов, Серверные скрипты, Отладка и ошибки, Примеры.

Редактор скриптов

Откройте вкладку События и выберите вместо списка функций скрипт. Код выполняется как тело функции:

  • return завершает скрипт досрочно;
  • var, let и const создают переменные, которые живут только в этом запуске;
  • переменная Item указывает на элемент, на событии которого идёт скрипт.
if (Tags("Line.Mode").Value !== 1) {
HMI.ShowMessage("Линия не в автомате");
return;
}
Tags("Line.Start").Write(true);

Файлы scripts/*.js — общие модули клиента. Объявленные в них функции и глобальные переменные видны всем скриптам событий.

scripts/Main.js
var lastStart = null;
function startLine(mode) {
if (Tags("Line.Fault").Value) {
HMI.ShowMessage("Линия в аварии");
return;
}
Tags("Line.Mode").Write(Number(mode));
Tags("Line.Start").Write(true);
lastStart = new Date();
}

Такую функцию вызывают из скрипта события напрямую (startLine(2);) или системной функцией RunScript с текстовым аргументом. Через RunScript аргумент всегда приходит строкой, поэтому числа приводите сами, как Number(mode) в примере.

У ламп, насосов и других элементов условие «работает» можно задать выражением с префиксом js:. В нём переменная value содержит значение тега элемента:

js: value == 3 || value == 5

Выражение должно быть коротким и без побочных действий: оно вычисляется при каждом изменении тега. Ошибка в выражении считается невыполненным условием.

Где задан скрипт Когда выполняется Чему равен Item
Событие элемента Щелчок, нажатие, наведение, ввод значения и т. д. Этот элемент
Открытие экрана Экран открылся, в том числе во всплывающем окне null
Закрытие экрана Переход на другой экран или закрытие окна null
Цикл экрана Периодически, пока открыт основной экран null
Функция модуля через RunScript Когда выполняется системная функция Элемент, на событии которого вызвана, или null
Условие js: При изменении тега элемента Недоступен, есть value

Период события Цикл задаётся в свойствах экрана: по умолчанию 1000 мс, минимум 100 мс. Цикл работает у основного экрана. У экранов во всплывающих окнах выполняются только события открытия и закрытия.

  • Переменные внутри скрипта события живут один запуск.
  • Глобальные переменные модулей создаются при первом скрипте сеанса и живут до выхода пользователя. У каждого клиента они свои: оператор в браузере и оператор за пультом не видят переменные друг друга.
  • Чтобы значение было общим для всех клиентов или пережило перезапуск, храните его во внутреннем теге с флагом Retain.

Важнее всего понимать, что происходит при запуске скрипта:

  1. Скрипт выполняется целиком и не ждёт сеть.
  2. Чтение тега возвращает последнее значение из подписки, которое у клиента уже есть.
  3. Изменения элементов экрана сразу видны следующим строкам скрипта. На экран они попадают одной перерисовкой после завершения.
  4. Записи в теги и системные функции (Write, HMI.SysFct, HMI.ActivateScreen, HMI.RunServerScript, Item.Raise) ставятся в очередь и выполняются по порядку после скрипта.
  5. Если одна из этих записей не удалась, например из-за нехватки прав, оператор видит сообщение, а следующие записи этого скрипта не выполняются.

Пример с последствиями этого порядка:

Tags("Counter").Write(5);
HMI.ShowMessage(Tags("Counter").Value); // старое значение: запись ещё не отправлена
var next = Tags("Counter").Value + 1; // так правильно: считаем в переменной
Tags("Counter").Write(next);
HMI.ShowMessage("Будет записано " + next);

Сообщения HMI.ShowMessage и вопросы HMI.Confirm показываются сразу, а не после скрипта.

Ограничение Значение Что происходит
Время одного запуска 2 секунды Скрипт останавливается с сообщением
Число операций 2 000 000 Скрипт останавливается: вероятно, вечный цикл
Глубина рекурсии 256 вызовов Ошибка «слишком глубокая рекурсия»
Память 64 МБ Ошибка «скрипт занял слишком много памяти»

Время ожидания ответа оператора на HMI.Confirm и HMI.ShowMessage в предел не входит. Остановленный скрипт не ломает клиент: следующие события работают как обычно.

Доступен стандартный язык: let, const, стрелочные функции, классы, шаблонные строки, деструктуризация, Math, JSON, Date, RegExp, методы массивов и строк.

Браузерных и системных средств нет: window, document, fetch, setTimeout, setInterval, require, import не определены. Скрипт не может обратиться к файлам, сети или программам компьютера. Для периодических действий используйте событие Цикл, а для работы с базами и файлами — серверные скрипты.

const pumps = ["Pump1", "Pump2", "Pump3"];
const running = pumps.filter(p => Tags(`${p}.Run`).Value === true);
HMI.ShowMessage(`Работают: ${running.length} из ${pumps.length}`);

Ошибка в скрипте показывается оператору сообщением «Ошибка скрипта: …» с номером строки. Записи, поставленные в очередь до ошибки, не выполняются: скрипт либо срабатывает целиком, либо не меняет ничего.

Ожидаемую ошибку можно перехватить:

try {
const pump = Screen.Items("Насос" + Tags("Line.Selected").Value);
pump.Fill = "#3C9A5F";
} catch (e) {
HMI.ShowMessage("Насос не найден на экране: " + e.message);
}

Синтаксические ошибки редактор показывает заранее, в панели проверки проекта. Частые сообщения и их причины собраны в разделе Отладка и ошибки.

Скрипт работает с правами вошедшего пользователя. Запись в тег проверяется дважды: в клиенте, чтобы сразу показать понятную причину, и на сервере. Скрипт не может записать то, что пользователь не смог бы записать вручную.