OpenSCADAWiki: Home Page En/Doc/API/part18 ...

Home | Index | Changes | Comments | Users | Registration | Login:   Password:  
 
This is an old revision of HomePageEn/Doc/API/part18 from 2009-11-17 10:37:44..

18. Service functions of the OpenSCADA control interface

Service functions - is an interface to access the OpenSCADA system through the OpenSCADA control interface from external systems. This mechanism is the basis for all exchange mechanisms within OpenSCADA, implemented through weak links and standard exchange protocol of OpenSCADA. Its main advantage is the priority processing and the possibility of using non-standard packaging data. For access to normal data you can use the standard commands of the control interface.

18.1. Group access to the values of the parameter's attributes of the subsystem "Data acquisition", as well as to the detailed information

These requests let you to obtain detailed information about the parameters of the subsystem "Data acquisition", to acquire the values of all attributes of the parameters, and also to make the group setting. Detailed information about requests is given in Table 23.


Table 23. Attributes of the request commands of the attributes' parameters of the subsystem "Data acquisition"

IdNameValue
Request command of information about the attributes of the parameter: <list path="/sub_DAQ/mod_{SRC}/cntr_{CNTR}/prm_{PRM}/%2fserv%2fattr"/>
<el id="iatr"/> Information of the attributes In separate tags the information about attribute is returned.
id
Attribute's ID The character identifier of the single attribute.
nm
Attribute's name The name of the single attribute.
flg
Attribute's flags Flags of the single attribute.
tp
Attribute's type The type of the single attribute.
vals
Values area of the attribute. Values area of the single attribute.
names
The names of the attribute's values for the selective type. The names of the single attribute's values for the selective type.
Team request command of the all values of attributes of the parameter: <get path="/sub_DAQ/mod_{SRC}/cntr_{CNTR}/prm_{PRM}/%2fserv%2fattr"/>
<el id="iatr">val</el> Attributes' values In separate tags the values of the attributes are returned.
The set command of the the values of the specified attributes of the parameter: <set path="/sub_DAQ/mod_{SRC}/cntr_{CNTR}/prm_{PRM}/%2fserv%2fattr"/>
<el id="iatr">val</el> The values of attributes are specified In separate tags the values of attributes are specified.

18.2. Access to archived data of the archives of messages

To request the archive data in the archiving subsystem of the messages archive's object the following command is provided <info path="/sub_Archive/%2fserv%2fmess"/> и <get path="/sub_Archive/%2fserv%2fmess"/> to request the information about the archive and archive values respectively. The detailed description of these commands is presented in Table 24.


Table 24. Attributes of request commands of information about the archive of values and archive data

IdNameValue
Request command of the information about the archive: <info path="/sub_Archive/%2fserv%2fmess"/>
arch Setting the name of the archive's archiver Archive's archiver, for which to specify the parameters.
end Control of the archive's top in the given archiver As a result of the request points to the real top of the messages' archive in the given archiver <arch>.
beg Control of the archive's depth in the given archiver As a result of the request points to the real depth of the messages' archive in the given archiver <arch>.
Request command of the archival and/or current data: <get path="/sub_Archive/%2fserv%2fmess"/>
tm Time set Time of the block's top of the messages' archive .
tm_grnd Time set of the base/beginning of the archive Points to the base/beginning of the archive.
arch Setting of the archive's archiver Specifies at what archiver to request the values. If the archiver is not specified, the request will be made consistently in all archivers with the exception of duplicates.
cat Setting the message's category Specify the category/template of the requested messages.
lev Setting the level of importance Specifies the importance level of messages for which and above to get the messages.
<el>mess</el> Messages In separate tags the messages are returned.
time
Message's time Time of the separate message.
cat
Message's category Category of the separate message.
lev
Message's level Level of the separate message.

18.3. Access to archived data of the values' archive

Для запроса данных архива в подсистеме архивирования объекта архива значения и объекте атрибута параметра подсистемы сбора данных предусмотрена команда <info path="{a_p_addr}/%2fserv%2fval"/> и <get path="{a_p_addr}/%2fserv%2fval"/> для запроса информации об архиве и значений архива соответственно. Атрибуты данных команд, предусматривающие различные механизмы запроса, представлены в таблице 25.


Таблица 25. Атрибуты команд запроса информации об архиве значений и архивных данных

IdИмяЗначение
Команда запроса информации об архиве: <info path="{a_p_addr}/%2fserv%2fval"/>
arch Установка имени архиватора архива Архиватор архива, для которого определять параметры.
end Контроль вершины архива в данном архиваторе В результате запроса указывает на реальную вершину архива значений в данном архиваторе <arch>. В случае отсутствия архива атрибут устанавливается в "0".
beg Контроль глубины архива в данном архиваторе В результате запроса указывает на реальную глубину архива значений в данном архиваторе <arch>. В случае отсутствия архива атрибут устанавливается в "0".
per Контроль периодичности архива в данном архиваторе В результате запроса указывает на реальную периодичность значений в данном архиваторе <arch>. В случае отсутствия архива атрибут устанавливается в "0".
vtp Контроль типа значений архива/параметра Возвращает код типа значений архивных данных: 0 - Boolean, 1 - Integer, 4 - Real, 5 - String. Только данное свойство доступно в случае запроса у параметра без архива!
Команда запроса архивных и/или текущих данных: <get path="{a_p_addr}/%2fserv%2fval"/>
tm Установка и контроль времени Время запрашиваемого значения или вершины блока архива значений. Если атрибут не указан или равен "0", то возвращается последнее значение. Значение данного атрибута устанавливается в значение времени полученного значения или вершины блока архивных данных.
tm_grnd Установка и контроль времени основания/начала архива Указывает основание/начало архива. Если атрибут не указан или равен "0", то производится запрос одного значения. Значение данного атрибута устанавливается в значение времени основания блока архивных данных.
per Установка и контроль периодичности получаемых значений Периодичность запрашиваемых значений. Если атрибут не указан, равен "0" или меньше чем реальная периодичность архива, то значения будут возвращаться с реальной периодичностью архива и значение данного атрибута установится в значение реальной периодичности. Если значение атрибута больше реальной периодичности, то значения архива будут усредняться к указанной периодичности.
arch Установка и контроль архиватора архива Указывает, у какого архиватора запрашивать значения. Если архиватор не указан, то запрос будет производиться последовательно с приоритетностью от лучшего к худшему. Имя архиватора, у которого получены значения, будет указанно в данном атрибуте при возврате результата. Если архиватор для данного параметра не установлен или такого архиватора нет, то значение данного атрибута будет обнулено. В случае выполнение запроса, пересекающего несколько архиваторов, выполняется обработка только первого архиватора с указанием его имени и размерности в соответствующих атрибутах. Для запроса данных последующих архиваторов запрос повторяется отталкиваясь от размерности предыдущего запроса.
mode Установка и контроль режима передачи данных архива

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

0 -- Простая запись: одно значение - одна строка без упаковки смежных значений. В случае архива строк значения кодируются на предмет исключения символов перевода строки. Пример формы записи:
34.5678
23.6543
65.8754
34.6523

1 -- Упакованная запись по принципу сворачивания смежных значений: одно значение - одна запись. Перед каждым значением указывается его позиционный номер, отделённый пробелом:

0 34.5678
1 23.6543
4 65.8754
6 34.6523

2 -- Массив бинарных неупакованных значений, кодированный Mime Base64. Не может быть использован для строковых архивов.
real_prec Установка точности вещественных чисел Указывает, с какой точностью передавать данные значений вещественного типа в режиме "0" и "1". По умолчанию эта точность составляет 6 значащих цифр.
round_perc Установка процента округления Указывает процент округления смежных числовых значений, для режима "1".

 
There are no files on this page.[Display files/form]
There is no comment on this page. [Display comments/form]
2009-11-17 10:37:44 | Owner: Maxim Lysenko | Print version | Search: