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

Справочник API экрана

Справочник всех объектов, доступных скриптам на экране оператора. Работа с элементами экрана (Screen, Item) подробно разобрана на странице Элементы из скриптов, здесь — краткая сводка.

Возвращает объект тега по имени. Регистр букв не важен, пробелы по краям отбрасываются, но для читаемости пишите имя как в таблице тегов. Если тега нет, скрипт завершается ошибкой «Тег «…» не найден».

const level = Tags("Tank1.Level");

Имя тега, строка.

Последнее значение, полученное клиентом по подписке.

Тип тега Что возвращает .Value
Bool true или false
Byte, Int16, UInt16, Int32, UInt32 Число
Float32, Float64 Число
String Строка
Значения ещё нет null

Для масштабированного тега значение приходит в инженерных единицах, а не в «сырых» единицах контроллера.

После потери связи .Value возвращает последнее известное значение, а не null. Если от значения зависит команда, проверяйте .Quality.

То же, что .Value. Удобно, когда вызов метода читается лучше:

if (Tags("Pump1.Fault").Read()) return;

Качество значения, строка:

Значение Смысл
Good Значение достоверно
Uncertain Значение есть, но источник не гарантирует достоверность (OPC UA)
Bad Связь есть, но контроллер отказал в чтении: нет блока, выход за границу
CommFailure Нет связи с устройством
ConfigError Ошибка настройки тега: адрес, тип
NoData Тег ещё ни разу не прочитан
const t = Tags("Tank1.Level");
if (t.Quality !== "Good") {
HMI.ShowMessage(`Уровень недостоверен: ${t.Quality}`);
return;
}

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

Передано Тег Bool Целый тег Вещественный или масштабированный тег Тег String
true / false Как есть 1 / 0 1 / 0 "true" / "false"
Число 0 — false, иначе true Округляется до целого, проверяется диапазон типа Как есть Число текстом
Строка 1, true, вкл, да или 0, false, выкл, нет Целое число текстом Число текстом, запятая или точка Как есть
null Ошибка Ошибка Ошибка Ошибка

Округление идёт до ближайшего целого, а ровно половина — к чётному: 2.5 даёт 2, 3.5 даёт 4. Если число не помещается в тип тега, например 70000 для Int16, скрипт завершается ошибкой «Допустимо от … до …».

Права проверяются по роли пользователя и защите тега («оператор», «инженер», «только чтение»). Если прав нет, оператор видит сообщение, а следующие действия этого скрипта не выполняются.

Объект с функциями клиента.

Имя вошедшего пользователя, строка.

Tags("Shift.Operator").Write(HMI.User);

Открывает экран проекта после завершения скрипта. Если экрана нет, оператор увидит ошибку.

Сразу показывает окно с текстом. Любое значение приводится к строке.

HMI.ShowMessage(JSON.stringify({ level: Tags("Tank1.Level").Value }));

Задаёт оператору вопрос с кнопками «Да» и «Нет» и возвращает true или false.

if (!HMI.Confirm("Остановить линию?")) return;
Tags("Line.Stop").Write(true);

В настольной программе скрипт ждёт ответа. Браузер так ждать не умеет, поэтому там скрипт прерывается на вопросе, а после ответа выполняется заново с начала, и HMI.Confirm сразу возвращает уже известный ответ. При этом:

  • записи и сообщения, сделанные до вопроса, не повторяются;
  • обычный код до вопроса выполняется ещё раз.

Поэтому задавайте вопросы в начале скрипта и не меняйте глобальные переменные модулей до них.

Возвращает текст из списка текстов проекта для числа. Если списка нет, скрипт завершается ошибкой.

Item.Text = HMI.TextList("Режимы", Tags("Line.Mode").Value);

Вызывает функцию серверного скрипта после завершения клиентского скрипта. Нужно право «Управление». Аргумент необязателен и передаётся строкой. Ошибку функции на сервере оператор увидит сообщением.

HMI.RunServerScript("startSequence", String(Tags("Recipe.Selected").Value));

Выполняет любую системную функцию после завершения скрипта. Параметры передаются по порядку, как в таблице ниже. Необязательные параметры в конце можно не указывать, а пропустить параметр в середине можно, передав null.

HMI.SysFct("IncreaseValue", "Tank1.Setpoint", 0.5, 10);
HMI.SysFct("ShowPopupScreen", "TankDetails", null, null); // по центру
HMI.SysFct("ShowGeniePopup", "PumpControl", "Tag=Pump1; Title=Насос 1");
Функция Параметры по порядку
ActivateScreen Screen
ActivatePreviousScreen —
ActivateHomeScreen —
ShowPopupScreen Screen, X?, Y?
ShowGeniePopup Genie, Substitutions?, Title?
ClosePopup —
ShowAlarms —
ShowAlarmJournal —
ShowTrend Tag
ShowTrendGroup Group
ShowTagOverview —
SetBit, ResetBit, InvertBit Tag
SetBitInTag, ResetBitInTag, InvertBitInTag Tag, Bit
SetValue Tag, Value
IncreaseValue, DecreaseValue Tag, Step = 1, Limit?
InputValue Tag
CopyValue Target, Source
LinearScaling, InvertLinearScaling Target, Source, X1, X2, Y1, Y2
ShiftAndMask Target, Source, Shift = 0, Mask = 65535
AcknowledgeAllAlarms —
AcknowledgeAlarm Alarm
ShowLogonDialog, Logoff, ChangePassword —
ShowMessage Text
PrintScreen, ToggleFullScreen, Beep, StopRuntime —
RunScript Function, Argument?
RunServerScript Function, Argument?

SetBitWhileKeyPressed из скрипта не вызывают: эта функция работает в паре с событием отпускания кнопки. Смысл каждой функции описан в разделе События и функции.

Открытые экраны и поиск элементов.

Член Описание
Screen.Name, Screen.Title Имя и заголовок основного экрана
Screen.Width, Screen.Height, Screen.Background Размер и фон основного экрана
Screen.Names() Массив имён открытых экранов
Screen.Items(name) Элемент по имени; если его нет — ошибка
Screen.Find(name) Элемент по имени или null
Screen.Items() Элементы верхнего уровня всех открытых экранов
Screen.All() Все элементы, включая вложенные
Screen.Reset() Отменить все изменения, сделанные скриптами

Элемент, на событии которого выполняется скрипт, или null. У него те же члены, что у элемента из Screen.Items:

Группа Члены
Сведения Name, Id, Type, TypeTitle, ScreenName, Events, Parent
Свойства Любое свойство как поле (Item.Fill), Get, Set, Has, Actual, Properties()
Положение Move(x, y), Resize(w, h)
Состояние Visible, Enabled, IsShown, IsOperable
Тег Tag, Value, Quality
Настройка Config, Apply(fields)
Действия Raise(event), Reload(), Reset(), Children(), Children(name)

Подробно и с примерами — на странице Элементы из скриптов, список свойств каждого элемента — в справочнике свойств.