Alpha.Community

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

Функции

TrySetValue

Синхронно записывает значение сигнала на сервер.

Для записи значений сигнала на сервер рекомендуется использовать функцию WriteValueAsync, так как она предотвращает возможные задержки в работе Alpha.HMI и предоставляет подробную информацию о результате операции.

Синтаксис

bool TrySetValue(variant value)

Параметры

value variant Значение для записи.

Возвращаемое значение

true Значение успешно записано на сервер.
false Не удалось записать значение.

Примеры

Попытаться присвоить значение сигналу и вывести результат в текстовое поле.

Result: var = ApItem_1.TrySetValue("Строка 1");
TextEdit_1.Text = String.ToString(Result);

WriteValueAsync

Асинхронно записывает значение сигнала на сервер. Результат операции (успех или ошибка) можно отслеживать через события OnWriteValueSucceeded и OnWriteValueFailed.

Синтаксис

uint8 WriteValueAsync(variant value)

Параметры

value variant Значение для записи.

Возвращаемое значение

requestId uint8

Идентификатор запроса, который позволяет отследить результат выполнения записи.

  • > 0: Успешно создан запрос на запись.
  • 0: Источник сигнала не указан или настроен некорректно.

Примеры

Записать новое значение сигнала и отобразить результат операции в текстовом поле.

requestId: uint8 = ApItem_1.WriteValueAsync("Новое значение");
if (requestId == 0)
{
Text_1.Text = "Ошибка: некорректно настроен источник сигнала.";
}
else
{
Text_1.Text = "Запрос на запись отправлен. ID: " + String.ToString(requestId);
}

GetHistorySources

Запрашивает список источников, в которые записывается история значений сигнала. Функция не возвращает данные напрямую. Вместо этого она инициирует запрос, результат которого можно отслеживать через событие OnGetHistorySourcesFinished.

Синтаксис

uint4 GetHistorySources()

Возвращаемое значение

requestId uint4

Идентификатор запроса. Используется, чтобы сопоставить вызов метода и результат, полученный в событии OnGetHistorySourcesFinished.

Примеры

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

// Поле myRequestId (тип uint4) предварительно создано
myRequestId = ApItemUInt4_1.GetHistorySources();
Text_1.Text = "Запрос источников истории отправлен. ID: " + String.ToString(myRequestId);

В обработчике события OnGetHistorySourcesFinished:

if (requestId == myRequestId)
ㅤㅤ// Только если requestId совпадает, выводим результат
ㅤㅤText_2.Text = "Источники истории: " + result;

GetCustomProperties

Запрашивает значения пользовательских свойств сигнала. Функция не возвращает данные напрямую. Вместо этого она инициирует запрос, результат которого можно отслеживать через событие OnGetCustomPropertiesFinished.

Синтаксис

uint4 GetCustomProperties(string RequestParameters)

Параметры

RequestParameters string

JSON-строка, содержащая массив идентификаторов пользовательских свойств для запроса (например, [1000001, 1000002]). Если передан пустой массив [], запрашиваются все доступные пользовательские свойства сигнала.

Возвращаемое значение

requestId uint4

Идентификатор запроса. Используется, чтобы сопоставить вызов метода и результат, полученный в событии OnGetCustomPropertiesFinished.

Примеры

Запросить пользовательские свойства сигнала с идентификаторами 1000001 и 1000002 и вывести полученные значения в текстовое поле.

// Поле myRequestId (тип uint4) предварительно создано
jsonParams: string = "[1000001, 1000002]";
myRequestId = ApItemUInt4_1.GetCustomProperties(jsonParams);
Text_1.Text = "Запрос пользовательских свойств отправлен. ID: " + String.ToString(myRequestId:);

В обработчике события OnGetCustomPropertiesFinished:

if (requestId == myRequestId)
ㅤㅤ// Только если requestId совпадает, выводим результат
ㅤㅤText_2.Text = "Полученные свойства:\n" + result;