Alpha.Community

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

Функции

SetAreaDisabled

Блокирует или снимает блокировку зон событий, переданных в виде JSON-массива. При блокировке источник данных прекращает формировать уведомления о событиях зоны и не сохраняет их в историю.

Синтаксис

void SetAreaDisabled(areasTag, disabled);

Параметры

areasTag string JSON-массив с именем зоны или перечислением зон
disabled bool true — включить блокировку; false — снять блокировку

Примеры

Заблокировать зоны Discrete и Enum:

ApAlarmManager_1.SetAreaDisabled('["Discrete", "Enum"]', true);

SetSourceDisabled

Блокирует или снимает блокировку источников событий, переданных в виде JSON-массива. При блокировке источник данных прекращает формировать уведомления о событиях сигнала и не сохраняет их в историю.

Синтаксис

void SetSourceDisabled(sourcesTag, disabled);

Параметры

sourcesTag string JSON-массив с именем источника или перечислением источников
disabled bool true — включить блокировку; false — снять блокировку

Примеры

Заблокировать источник Discrete.s_bool:

ApAlarmManager_1.SetSourceDisabled('["Discrete.s_bool"]', true);

SetAreaSuppressed

Подавляет или снимает подавление зон событий, переданных в виде JSON-массива. При подавлении источник данных прекращает уведомлять клиентов о событиях зоны, но продолжает сохранять их в историю.

Синтаксис

void SetAreaSuppressed(areasTag, suppressed, suppressedUntil);

Параметры

areasTag string JSON-массив с именем зоны или перечислением зон
suppressed bool true — включить подавление; false — снять подавление
suppressedUntil timestamp 0 — бессрочное подавление; любое другое значение — метка времени окончания подавления в UTC

Примеры

Подавить зону Discrete на один час:

SuppressUntil: var = DateTime.ToUtc(DateTime.Now()) + 3600;
ApAlarmManager_1.SetAreaSuppressed('["Discrete"]', true, SuppressUntil);

Подавить зону Discrete бессрочно:

ApAlarmManager_1.SetAreaSuppressed('["Discrete"]', true, 0);

SetSourceSuppressed

Подавляет или снимает подавление источников событий, переданных в виде JSON-массива. При подавлении источник данных прекращает уведомлять клиентов о событиях сигнала, но продолжает сохранять их в историю.

Синтаксис

void SetSourceSuppressed(sourcesTag, suppressed, suppressedUntil);

Параметры

sourcesTag string JSON-массив с именем источника или перечислением источников
suppressed bool true — включить подавление; false — снять подавление
suppressedUntil timestamp 0 — бессрочное подавление; любое другое значение — метка времени окончания подавления в UTC

Примеры

Подавить источник Discrete.s_bool на один час:

SuppressUntil: var = DateTime.ToUtc(DateTime.Now()) + 3600;
ApAlarmManager_1.SetSourceSuppressed('["Discrete.s_bool"]', true, SuppressUntil);

GetAreaState

Запрашивает текущее состояние блокировки и подавления для зон, переданных в виде JSON-массива.

Синтаксис

void GetAreaState(areasTag);

Параметры

areasTag string JSON-массив с именем зоны или перечислением зон

Примеры

Получить состояние зон Discrete и Enum:

ApAlarmManager_1.GetAreaState('["Discrete", "Enum"]');

GetSourceState

Запрашивает текущее состояние блокировки и подавления для источников, переданных в виде JSON-массива.

Синтаксис

void GetSourceState(sourcesTag);

Параметры

sourcesTag string JSON-массив с именем источника или перечислением источников

Примеры

Получить состояние источника Discrete.s_bool:

ApAlarmManager_1.GetSourceState('["Discrete.s_bool"]');

GetDisabledOrSuppressedAreas

Запрашивает список всех зон, для которых в данный момент активна блокировка или подавление.

Синтаксис

void GetDisabledOrSuppressedAreas(filter);

Параметры

filter string Фильтр зон в формате шаблона. Передайте пустую строку "", чтобы получить все заблокированные или подавленные зоны

Примеры

Получить список всех заблокированных или подавленных зон:

ApAlarmManager_1.GetDisabledOrSuppressedAreas("");

GetDisabledOrSuppressedSources

Запрашивает список всех источников, для которых в данный момент активна блокировка или подавление.

Синтаксис

void GetDisabledOrSuppressedSources(filter);

Параметры

filter string Фильтр источников в формате шаблона. Передайте пустую строку "", чтобы получить все заблокированные или подавленные источники

Примеры

Получить список всех заблокированных или подавленных источников:

ApAlarmManager_1.GetDisabledOrSuppressedSources("");