Managing system elements

Пример ответа на запрос списка всех элементов:

Элементы в системе мониторинга имеют следующие общие атрибуты:

• id — уникальный идентификатор элемента;

• module — идентификатор модуля которому принадлежит элемент;
• num — порядковый номер внутри модуля, положительные значения соответствуют внешнему элементу, доступному для пользователя (например датчик на шине CAN), отрицательные - элементу внутри устройства (например датчик напряжения питания);
• clas — описывает класс элемента (аналоговый, дискретный и т.д.);
• type — описывает тип элемента внутри класса (температура, напряжение, вибрация, реле и т.д.);

• name — имя элемента;

• state — состояние элемента (норма, тревога, включено и т.д.);

• value — числовое значение соответствующее измеряемой величине;

• view — сейчас не используется;

• um — еденица измерения данного элемента;
• descr — вспомогательное описание элемента.

Возможные классы и типы элементов:

• discrete - датчики с дискретным выходом, возможны следующих типов:

• • dry - сухой контакт (в составе устройства или плат VT16 / VT32 Dry contacts board и др.);
  • door - датчик открытой двери (VT530 Access sensor);
  • airflow - датчик воздушного потока (LCF013 Airflow sensor);
  • motion - датчик движения (VT570 PIR sensor);
  • vibration - датчик вибрации (в составе VT470 PIR, vibration and temperature sensor и др.);
  • smoke - датчик задымления (VT560 Smoke detector);
  • water - датчик протечки воды (VT590 Leak sensor и др.);
  • overload - признак перегрузки по току, используется в устройствах с функцией измерения энергетических параметров нагрузки.

• analog - датчики с аналоговым выходом, возможны следующих типов:

• • temperature - датчик температуры (VT500 Temperature sensor и др.);

  • humidity - датчик относительной влажности (VT510 Humidity sensor);
  • voltage - датчик напряжения (VT520 AC voltage monitor и др.);
  • fvoltage - датчик напряжения преобразовательный (VT410 DC voltage monitor);
  • current - датчик тока;
  • fcurrent - датчик тока преобразовательный (VT420 Converter и др.);
  • vibration - датчик вибрации;
  • power - мощность, используется в устройствах с функцией измерения энергетических параметров нагрузки;
  • frequency - частота, используется в устройствах с функцией измерения энергетических параметров нагрузки;
  • factor - прочие энергопараметры, используется в устройствах с функцией измерения энергетических параметров нагрузки.

• switch - элементы переключения, возможны следующих типов:

• • relay - реле, выход которого в устройстве оформлен в виде контактов;
  • outlet - розетка;
  • toggle - переключатель;
  • strobo - слаботочный низковольтный выход в виде контактов.

• devhwr - аппаратные устройства, возможны следующих типов:

• • reader - считыватель ключа iButton (VT109 iTouch reader) или карты RFID доступа (VT107 Proximity reader);
  • ip-cam - IP камера;
  • usb-cam - USB камера;
  • GSM modem - GSM модем.

• devirt - виртуальные элементы, возможны следующих типов:

• • logic - логическая схема;
  • timer - таймер;
  • ping - пинг заданного IP адреса;
  • trigger - виртуальный переключатель, который можно включать в логические схемы;
  • snmpget - виртуальный элемент управляемый через интернет-протокол SNMP.

• notifier - элементы уведомления, возможны следующих типов:

• • mailer - письмо по электронной почте;
  • sms - сообщение на мобильный телефон;
  • snmp trap - уведомление менеджеру интернет-протокола SNMP.

Набор состояний в котором может находиться элемент зависит от его класса:

(1) - возможное состояние зависит от типа устройства.

Датчики в системе мониторинга Sky Control

Датчики с дискретным выходом (clas=discrete)

Возможные состояния: not connected, normal, alarm

Диапазон возможных значений: 0, 1

Параметры (атрибуты):

• hwport - аппаратный порт (наименование разъема на корпусе устройства), только чтение;
• reset - сброс памяти датчика или отключение питания:
  • 0 - немедленный сброс тревоги датчика;
  • 1 .. 86400 - сброс по таймуту, через указанное время;
  • отрицательная величина (-1) - автосброс отключен;
• high - верхний порог срабатывания датчика в % (1-200 для airflow, 1-100 для остальных датчиков);
• low - нижний порог срабатывания датчика в % (1-200 для airflow, 1-100 для остальных датчиков);
• reverse - флаг инверсии выхода датчика (0 либо 1), инвертирует состояние датчика;
• spec - справочная информация для настройки датчика (только чтение);

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

Элементы с дискретным выходом могут иметь также другие атрибуты.

Датчики с аналоговым выходом (clas=analog)

Возможные состояния: not connected, low alarm, low warning, normal, high warning, high alarm

Параметры (атрибуты):

• hwport - аппаратный порт (наименование разъема на корпусе устройства), только чтение;
• vmax - максимальное значение для диапазона измерений, только чтение;
• vmin - минимальное значение для диапазона измерений, только чтение;
• low_alarm - порог состояния "тревога, ниже нормы" (кроме типа "factor");
• low_warning - порог состояния "предупреждение, ниже нормы";
• high_warning - порог состояния "предупреждение, выше нормы";
• high_alarm - порог состояния "тревога, выше нормы";
• at0 - коэффициент калибровки в формуле at0*x+at75;
• at75 - коэффициент калибровки в формуле at0*x+at75;
• expr - выражение для вычисления выходной величины (для преобразовательных датчиков);
• um - единицы измерения для величины, измеряемой датчиком (если данный атрибут отсутствует - единицы измерения вычисляются по атрибуту type).
• descr - описание датчика;

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

Элементы с аналоговым выходом могут иметь также другие атрибуты.

Переключатели (clas=switch)

Возможные состояния: not connected, on, off, pulse

Устройства (clas=devhwr)

Возможные состояния: not connected, normal, alarm

Виртуальные элементы (clas=devirt)

Возможные состояния: not connected, normal, alarm

Особенность: cоздаются в системе пользователем

Уведомления (clas=notifier)

Возможные состояния: normal

Особенность: cоздаются в системе пользователем, активируются при срабатывании логических схем

Example of an answer to a query for a list of all items:

The elements in the monitoring system have the following common attributes:

• id - unique identifier of the element;
• module - the identifier of the module to which the element belongs;
• num is the sequence number within the module, positive values ​​correspond to an external element available to the user (for example, a sensor on the CAN bus), negative values ​​correspond to an element inside the device (for example, a voltage supply sensor);
• clas - describes the class of the element (analog, discrete, etc.);
• type - describes the type of the element within the class (temperature, voltage, vibration, relay, etc.);
• name - the name of the element;
• state - the state of the element (norm, alarm, enabled, etc.);
• value - a numerical value corresponding to the measured value;
• view - it is not used now;
• um - unit of measurement of this element;
• descr is an auxiliary description of the element.

Possible classes and types of elements:

• discrete - sensors with a discrete output, the following types are possible:
  • dry - dry contact (as part of the device or VT16 / VT32 boards Dry contacts board, etc.);
  • door - open door sensor (VT530 Access sensor);
  • airflow - airflow sensor (LCF013 Airflow sensor);
  • motion - motion sensor (VT570 PIR sensor);
  • vibration - vibration sensor (in the VT470 PIR, vibration and temperature sensor, etc.);
  • smoke - smoke detector (VT560 Smoke detector);
  • water - water leakage sensor (VT590 Leak sensor, etc.);
  • overload is a sign of current overload, it is used in devices with the function of measuring the energy parameters of the load.
• analog - sensors with analog output, the following types are possible:
  • temperature - temperature sensor (VT500 Temperature sensor, etc.);
  • humidity - the relative humidity sensor (VT510 Humidity sensor);
  • voltage - voltage sensor (VT520 AC voltage monitor, etc.);
  • fvoltage - voltage sensor converter (VT410 DC voltage monitor);
  • current - current sensor;
  • fcurrent - current sensor converter (VT420 Converter, etc.);
  • vibration - vibration sensor;
  • power - power, used in devices with the function of measuring the energy parameters of the load;
  • frequency - frequency, used in devices with the function of measuring the energy parameters of the load;
  • factor - other energy parameters, is used in devices with the function of measuring the energy parameters of the load.
• switch - switching elements, the following types are possible:
  • relay - relay, the output of which in the device is designed in the form of contacts;
  • outlet - socket;
  • toggle - switch;
  • strobo - low-current low-voltage output in the form of contacts.
• devhwr - hardware devices, the following types are possible:
  • reader - iButton key reader (VT109 iTouch reader) or RFID access card (VT107 Proximity reader);
  • ip-cam - IP camera;
  • usb-cam - USB camera;
  • GSM modem - GSM modem.
• devirt - virtual elements, the following types are possible:
  • logic - logic scheme;
  • timer - timer;
  • ping - ping the given IP address;
  • trigger - a virtual switch that can be included in the logic;
  • snmpget is a virtual element managed via the Internet protocol SNMP.
• notifier - notification elements, the following types are possible:
  • mailer - the letter by e-mail;
  • sms - message to the mobile phone;
  • snmp trap - notification to the manager of the Internet protocol SNMP.

The set of states in which an element may reside depends on its class:

(1) - the possible state depends on the type of device.

Sensors in the Sky Control monitoring system

Sensors with a discrete output (clas = discrete)

Possible states: not connected, normal, alarm

Range of possible values: 0, 1

Parameters (attributes):

• hwport - hardware port (connector name on the device body), read only;
• reset - Reset the sensor memory or turn off the power:
  
  • 0 - immediate reset of the sensor alarm;
  • 1 .. 86400 - reset by the timeout, after the specified time;
  • negative value (-1) - auto reset is disabled;
• high - the upper threshold of the sensor in% (1-200 for airflow, 1-100 for other sensors);
• low - the lower threshold of the sensor in% (1-200 for airflow, 1-100 for other sensors);
• reverse - the flag of the sensor output inversion (0 or 1), inverts the sensor state;
• spec - reference information for sensor adjustment (read only);

If the element does not give any attribute from the specified - then the value of this attribute is not determined in the process of work and its installation does not affect the operation of the element.

Elements with a discrete output can also have other attributes.

Sensors with analog output (clas = analog)

Possible states: not connected, low alarm, low warning, normal, high warning, high alarm

Parameters (attributes):

• hwport - hardware port (connector name on the device body), read only;
• vmax - maximum value for the measuring range, read only;
• vmin - minimum value for the measuring range, read only;
• low_alarm - the threshold of the "alarm, below normal" state (except for the "factor" type);
• low_warning - threshold of "warning, below normal" status;
• high_warning - "warning, above normal" status threshold;
• high_alarm - threshold of "alarm, above normal" status;
• at0 is the calibration coefficient in the formula at0 * x + at75;
• at75 is the calibration factor in the formula at0 * x + at75;
• expr - expression for calculating the output value (for conversion sensors);
• um is the unit of measurement for the value measured by the sensor (if this attribute is missing, the units of measurement are calculated by the type attribute).
• descr - description of the sensor;

If the element does not give any attribute from the specified - then the value of this attribute is not determined in the process of work and its installation does not affect the operation of the element.

Elements with an analog output can also have other attributes.

Switches (clas = switch)

Possible states: not connected, on, off, pulse

Devices (clas=devhwr)

Possible states: not connected, normal, alarm

Virtual elements (clas=devirt)

Possible states: not connected, normal, alarm

Feature: created in the system by the user

Уведомления (clas=notifier)

Possible states: normal

Feature: are created in the system by the user, activated when the logic circuits