Module <UserProtocol> of subsystem “Protocols”
Русская версия
Українська версія?
| Module: | UserProtocol |
| Name: | User protocol |
| Type: | Protocol |
| Source: | prot_UserProtocol.so |
| Version: | 0.5.0 |
| Author: | Roman Savochenko |
| Translated: | Maxim Lysenko |
| Description: | Allows you to create your own user protocols on any OpenSCADA's language. |
| License: | GPL |
Introduction
Module UserProtocol of the transport protocol is made to provide the user with the possibility of creation the implementations of different protocols by himself at one of the internal languages of OpenSCADA, usually JavaLikeCalc, without necessity of low-level programming of OpenSCADA.
Основная цель модуля - упростить задачу подключения к системе OpenSCADA устройств источников данных, которые имеют незначительное распространение и/или предоставляют доступ к собственным данным по специфическому протоколу, обычно достаточно простому для реализации на внутреннем языке OpenSCADA. Для реализации этого предоставляется механизм формирования протокола исходящего запроса.
Кроме механизма протокола исходящего запроса предоставляется механизм протокола входящего запроса, который позволяет OpenSCADA обслуживать запросы на получение данных по специфическим протоколам, которые достаточно просто могут быть реализованы на внутреннем языке OpenSCADA.
Модуль предоставляет возможность создания реализаций множества различных протоколов в объекте "Пользовательский протокол" (рис.1).
Рис.1. Основная вкладка объекта "Пользовательский протокол".
Главная вкладка содержит основные настройки пользовательского протокола:
- Раздел "Состояние" - содержит свойства, характеризующие состояние протокола:
- Состояние - текущее состояние протокола.
- Включен - состояние протокола "Включен".
- БД - БД в которой хранится конфигурация.
- Раздел "Конфигурация" - непосредственно содержит поля конфигурации:
- ID - информация об идентификаторе протокола.
- Имя - указывает имя протокола.
- Описание - краткое описание протокола и его назначения.
- Включать - указывает на состояние "Включен", в которое переводить протокол при загрузке.
1. Часть протокола для входящих запросов
Протокол входящих запросов работает в кооперации с входящим транспортом и отдельный объект "Пользовательского протокола" указывается в поле конфигурации протокола транспорта вместе с именем модуля UserProtocol. В дальнейшем все запросы к транспорту будут направляться в процедуру обработки запроса протокола (рис.2).
Рис.2. Вкладка процедуры обработки входящих запросов.
Вкладка процедуры обработки входящих запросов содержит поле для выбора внутреннего языка программирования OpenSCADA и поле ввода текста процедуры обработки.
Для процедуры обработки предопределены следующие переменные обмена с входящим транспортом:
- rez - результат обработки (false-полный запрос;true-не полный запрос);
- request - сообщение запроса;
- answer - сообщение ответа;
- sender - отправитель запроса.
Общий сценарий обработки входящих запросов:
- Запрос формируется удалённой станцией и через сеть попадает на транспорт OpenSCADA.
- OpenSCADA транспорт передаёт запрос, выбранному в поле протокола, модулю UserProtocol и объекту пользовательского протокола в виде значений переменной "request" - для блока запроса и "sender" - для адреса отправителя запроса.
- Запускается выполнение процедуры протокола входящего запроса, в процессе которой анализируется содержимое переменной "request" и формируется ответ в переменной "answer". По окончанию выполнения процедуры формируется переменная "rez", которая указывает транспорту на факт получения полноценного запроса и формирование корректного ответа (false) или необходимость транспорту ожидать оставшихся данных (true).
- Если в результате процедуры обработки переменная "rez" равна 'false' и ответ в переменной "answer" не нулевой, то транспорт отправляет ответ и обнуляет накопление "request".
- Если в результате процедуры обработки переменная "rez" равна 'true' то транспорт продолжает ожидать данные. При получении следующей порции данных они добавляются к переменной "request" и выполнение процедуры повторяется.
2. Часть протокола для исходящих запросов
Протокол исходящих запросов работает в кооперации с исходящим транспортом и отдельным объектом "Пользовательского протокола". Источником запроса через протокол может выступать функция общесистемного API пользовательского программирования исходящего транспорта int messIO( XMLNodeObj req, string prt );, в параметрах которой указывается:
- req - запрос в виде дерева XML со структурой соответствующей входному формату реализованного протокола;
- prt - имя модуля "UserProtocol".
Запрос отправленный вышеуказанным образом направляться в процедуру обработки запроса протокола (рис.3) с идентификатором пользовательского протокола указываемым в атрибуте req.attr("ProtIt").
Рис.3. Вкладка процедуры обслуживания исходящих запросов.
Вкладка процедуры обработки исходящих запросов содержит поле для выбора внутреннего языка программирования OpenSCADA и поле ввода текста процедуры обработки.
Для процедуры обработки предопределены следующие переменные обмена:
- io - XML узел обмена с клиентом, через который протокол принимает запросы и в который помещает результат с форматом реализуемым в процедуре;
- tr - объект транспорта, предназначен для вызова функции транспорта string messIO( string mess, real timeOut = 1000 ); "tr.messIO(req)".
Общий сценарий формирования исходящего запроса:
- Формирование XML-дерева в соответствии со структурой реализуемой протоколом и указание идентификатора пользовательского протокола в атрибуте "ProtIt".
- Отправка запроса к транспорту через протокол SYS.Transport["Modul"]["OutTransp"].messIO(req,"UserProtocol");.
- Выбор пользовательского интерфейса в соответствии с req.attr("ProtIt") и инициализация переменных исходящего транспорта io - соответственно к первому аргументу messIO() и tr - объект "OutTransp".
- Вызов процедуры на исполнение, которая обработав структуру "io" формирует прямой запрос транспорту tr.messIO(req);, результат которого обрабатывается и помещается назад в io.
Суть выделения протокольной части кода в процедуру пользовательского протокола заключается в упрощении интерфейса клиентского обмена при многократном использовании и предпологает формирование структуры XML-узла обмена в виде атрибутов адресов удалённых станций, адресов читаемых и записываемых переменных, а также значений самих переменных. При этом весь груз непосредственного кодирования запроса и декодирования ответа возлагается на процедуру пользовательского протокола.
Ссылки