Managing system modules

Owned by Vladimir Tayzhev
Last updated: Apr 18, 2018

Article content:

Reading modules

The request for reading modules contains the following fields:

  • querytype - request type: getmodule - read modules;
  • k - session identifier;
  • id - unique identifier of the module, in the absence of the identifier, a list of all modules available to the user is displayed.


An example of a response to a request from one module, the answer contains information specific to the module:

<module id="2012" clas="can" name="VT460-0005" state="normal" iface="1" node="2" rev="0.01" sn="5" />

An example of an answer to a query for a list of all modules, the answer contains general information about the modules:


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

Modules in the monitoring system have the following common attributes:

  • id - unique identifier of the module;
  • pcode - module product code;
  • sn - the serial number of the module;
  • clas - describes the class of the module;
  • type - describes the type of module within the class;
  • name - the name of the module;
  • state - the state of the module.


Possible classes and types of modules:

  • internal - modules of the motherboard:
    • notifier - modules of notification elements (SMS, e-mail, snmp);
    • devirt - modules of virtual elements (logic, timers, etc.);
    • devhwr - modules of hardware devices (cameras, modem, etc.);
    • onboard - motherboard parameters sensors;
    • analog - analog sensors;
    • outlet - built-in outlets, relays, power outputs;
    • dry - dry contacts.
  • can - modules on the CAN bus, the module type is not specifically indicated.
  • power - modules, which are used in devices with the function of measuring the energy parameters of the load:
    • relay - the module of the relays or outlets without the functions of measurement of power parameters;
    • sensor relay - the module of the relays or outlets with a function of measurement of power parameters;
    • general parameters - the module of general energy parameters;
    • current parameters - module of current parameters;
    • power parameters - module of power parameters;
    • other parameters - the module of other energy parameters.