Managing system elements

The read element request contains the following fields:

• querytype - type of request: getelement - reading elements;

• k - session identifier;

• id - the unique identifier of the element, in the absence of an identifier, a list of all elements available to the user is displayed.

Example of a response to a query for a specific element:

Example of a response to a query for a list of all elements:

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 - 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 - 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 / Dry contacts board", "VT32 / Dry contacts board" , etc.);

  • door - open door sensor (VT530 Access sensor);

  • airflow - airflow sensor (LCF013 Airflow sensor);

  • motion - motion sensor (VT572 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 - 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 - outlet;

  • 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 - 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.

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 return any one of the 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.

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;