System Information

Owned by Vladimir Tayzhev
Last updated: Mar 07, 2022 by Technical Service Specialist
2 min read

Article content:

Request information about the system

The request for information about the system contains the following fields:

  • querytype - type of request: getsystem - read information about the system;
  • k - session identifier;

Example of an answer to a request for information about the system:

<system brandname="Vutlan" brandext="vut" brandpen="39052" state="normal" version="2.7.4 b517" kernel="12.03.2019" type="VT335" time="1449665393" sms="true" dubl="false" camera="false" ntpserver="false" optime="2925" uptime="189" can_count="1" sd_count="0" cpuusage="37.6" memusage="25836" memtotal="60496" />

The answer contains the following fields:

  • brandname - firmware brand;
  • brandext - extension of file name for settings file and firmware file;
  • brandpen - SNMP PEN code;
  • state - the state of the system;
  • version - version number of the system software;
  • kernel - building date of system kernel, optional;
  • type - the type of the device of the system;
  • sms - the ability to send SMS in the system (true or false);
  • dubl - availability of a "Duplicator" program in the system (true or false);
  • camera - availability of a AV camera in the system (true or false);
  • ntpserver - availability of a NTP server in the system (true or false);
  • can_count - number of available CAN interfaces;
  • sd_count - number of available builtin SD card reader;
  • time - current system time in UTS format;
  • optime - total system operating time, in seconds;
  • uptime - the time of the current session, in seconds;
  • cpuusage - CPU utilization, in percent;
  • memusage - the amount of memory used, in kilobytes;
  • memtotal - the total amount of available memory, in kilobytes.


The state of the system characterizes the state of modules and elements. The state depends only on the elements of the classes "discrete" and "analog", as well as on the state of the modules, as shown in the table.


PriorityElement classElement statusModule statusSystem status
lowestanalog, discretenormalnormalnormal
highanaloglow warning, high warningwarningwarning
very high

analoglow alarm, high alarmalarmalarm

discrete

alarm

Request a full report on the current state of the system

The request contains the following fields:

  • querytype - request type: getmodules - full report;
  • k - session identifier;


Example of an answer to a query:

<system id="100" state="alarm" version="2.6.0 b1587" type="VT2100" time="1449665393" sms="true" optime="3983" uptime="2045" cpuusage="37.6" memusage="25836" memtotal="60496" >
  <modules>
    <module id="2001" pcode="4" sn="0" clas="internal" type="onboard" name="Onboard" state="normal" />
    <module id="2002" pcode="5" sn="0" clas="internal" type="analog" name="Autodetect" state="normal" />
  </modules>
  <groups>
    <group id="3001" name="room313" descr="komnata unilan" elements="1002,1006,1001" modules="2001,2005,2011" />
  </groups>
  <elements>
    <element id="1001" module="2001" num="-1" clas="analog" type="temperature" name="Internal T°C" state="high warning" value="32.0" view="0" um="°C" />
    <element id="1002" module="2001" num="-2" clas="analog" type="voltage" name="Internal DC" state="high alarm" value="14.5" view="0" um="V" />
  </elements>
</system>

The answer contains information about the system, general information about the modules, information about the groups (if any), and general information about the elements.

Further content: