Export translations

Settings

Group
Language
Format	Export for off-line translation Export in native format

{{DISPLAYTITLE:Документація/API користувача}}<languages/>
{{Info|
* '''Автор:''' [[User:RomanSavochenko|Роман Савоченко]]
* '''Початково створено:''' у [http://wiki.oscada.org/HomePageEn/Doc/ProgrammManual старій Wiki] }}

До початку програмування у OpenSCADA Ви маєте вивчити структуру об'єктів програми (Об'єктна модель) у [[Special:MyLanguage/Documents/Program_manual|посібнику по програмі OpenSCADA]] та на рисунку 1.

З цього документу Ви побачите, що можете, як користувач, програмувати наступні частини OpenSCADA:
* [[Special:MyLanguage/Documents/DAQ#Virtual|Джерела логічного рівня підсистеми "Збір даних"]].
* Транспортні протоколи, доступні для користувацького програмування, такі як: [[Special:MyLanguage/Modules/UserProtocol|Користувацький протокол]], [[Special:MyLanguage/Modules/ModBus|ModBus вузли типу "Данні"]], [[Special:MyLanguage/Modules/WebUser|Web-інтерфейси від користувача]], ...
* [[Special:MyLanguage/Modules/VCAEngine|Середовище Візуалізації та Управління (СВУ)]], у процедурах віджетів.

API користувацького програмування представляє собою дерево об'єктів OpenSCADA (Рис.1), кожний об'єкт якого може надавати власний перелік властивостей та функцій. Властивості та функції об'єктів можуть використовуватися користувачем у процедурах на мовах користувацького програмування OpenSCADA.

На цей час OpenSCADA надає тільки одну мову текстового програмування — [[#JavaLikeCalc|JavaLikeCalc]], відповідно Ви також повинні її вивчити перед початком. Точкою входу для доступу до об'єктів OpenSCADA (Рис.1) з мови користувацького програмування JavaLikeCalc є зарезервоване слово "SYS", кореневого об'єкту OpenSCADA. Наприклад, для доступу до функції вихідного транспорту треба записати: '''SYS.Transport.Serial.out_ModBus.messIO(mess);'''.

API об'єктів, які надаються модулями, описуються у власній документації модулів та тут до неї надаються посилання.

== {{Anch|JavaLikeCalc|[[Special:MyLanguage/Modules/JavaLikeCalc|Користувацька мова програмування JavaLikeCalc]]}} ==
{{#lst:Modules/JavaLikeCalc/uk|LANG}}

== {{Anch|Object|Загальносистемні користувацькі об'єкти}} ==
{{#lst:Modules/JavaLikeCalc/uk|OBJ}}

=== {{Anch|Array|Об'єкт масиву (Array)}} ===
Особливістю масиву є те, що він працює з властивостями як з індексами та повне їх найменування не має сенсу, відтак доступний тільки механізм звернення охопленням індексу квадратними дужками "'''arr[1]'''". Масив зберігає властивості у власному контейнері одномірного масиву. Цифрові властивості масиву використовуються для доступу безпосередньо до масиву, а символьні працюють як властивості об'єкту.

Масив надає спеціальну властивість "length", для отримання розміру масиву "'''var = arr.length;'''". Також масив надає наступні функції:
* ''string join( string sep = "," )'', ''string toString( string sep = "," )'', ''string valueOf( string sep = "," )'' — повертає рядок з елементами масиву, поділеними ''sep'' або символом ','.
* ''Array concat( Array arr );'' — додає до первинного масиву елементи масиву ''arr''. Повертає первинний масив зі змінами.
* ''int push( ElTp var, ... );'' — поміщає елемент(и) ''var'' у кінець масиву, як до стеку. Повертає новий розмір масиву.
* ''ElTp pop( );'' — видаляє останній елемент масиву та повертає його значення, як із стеку.
* ''Array reverse( );'' — змінює порядок розташування елементів масиву. Повертає первинний масив зі змінами.
* ''ElTp shift( );'' — зсуває масив догори, при цьому перший елемент масиву видаляється, а його значення повертається.
* ''int unshift( ElTp var, ... );'' — засуває елемент(и) ''var'' до масиву. Перший елемент у 0, другий у 1 та так само далі.
* ''Array slice( int beg, int end = {end} );'' — повертає фрагмент масиву від ''beg'' до ''end'' (виключаючи). Якщо значення початку або кінця негативне то відлік ведеться з кінця масиву. Якщо кінець не вказано то кінцем є кінець масиву.
* ''Array splice( int beg, int remN = {end}[, ElTp val1[, ElTp val2, ...]] );'' — видаляє елементи від ''beg'' у кількості ''remN'' і надалі вставляє елементи ''val1, val2, ...'' до масиву. Повертає масив видалених елементів.
* ''int indexOf( ElTp var, int start = 0 );'' — повертає індекс масиву потрібної змінної ''var'' у початковій послідовності, починаючи з позиції ''start''. Якщо початкову позицію не вказано то пошук починається з початку. Якщо шуканої змінної не знайдено то повертається "-1".
* ''int lastIndexOf( ElTp var, int start = {end} );'' — повертає індекс масиву потрібної змінної ''var'' у початковій послідовності, починаючи з позиції ''start'' за пошуком з кінця. Якщо початкову позицію не вказано то пошук починається з кінця. Якщо шуканої змінної не знайдено то повертається "-1".
* ''double sum( int beg, int end = {end} );'' — сума значень частини масиву з позиції ''beg'' по ''end'', виключно.
* ''Array sort( );'' — сортує елементи масиву у лексикографічній послідовності.

=== {{Anch|RegExp|Об'єкт регулярного виразу (RegExp)}} ===
Об'єкт роботи з регулярними виразами, засновано на бібліотеці PCRE. При глобальному пошуку встановлюється атрибут об'єкта "lastIndex", що дозволяє продовжити пошук при наступному виклику функції. У випадку невдалого пошуку атрибут "lastIndex" скидається у нуль.

У якості аргументів створення об'єкту передається рядок з текстом регулярного виразу та прапорці у вигляді рядка символів:
* 'g' — режим глобального пошуку, що означає повторення запиту для опрацювання усіх виразів до повернення порожнього масиву;
* 'i' — режим регістронезалежного пошуку;
* 'm' — режим багаторядкового пошуку;
* 'u' — примусовий дозвіл символів UTF-8, для інших локалей;
* 'p' — тестування виразу за правилами звичайного шаблону з ключовими символами: '?', '*' та '\'.

Властивості об'єкту:
* ''source'' — початковий шаблон регулярного виразу, тільки читання.
* ''global'' — ознака глобального пошуку, тільки читання.
* ''ignoreCase'' — ознака ігнорування регістру символів при пошуку, тільки читання.
* ''multiline'' — ознака багаторядкового пошуку, тільки читання.
* ''UTF8'' — ознака дозволу UTF-8 символів, тільки читання.
* ''lastIndex'' — індекс символу за підрядком останнього пошуку, використовується у глобальному режимі для продовження сканування, при наступному виклику.

Функції об'єкту:
<ul>
<li>''Array exec(string val);'' — викликає пошук за рядком ''val''. Повертає знайдений підрядок (0) та підвирази (>0) у масиві. Встановлює атрибут масиву "index" у позицію знайденого підрядка. Встановлює атрибут масиву "input" у значення початкового рядку.
<syntaxhighlight lang="JavaScript">
var re = new RegExp("(\\d\\d)[-/](\\d\\d)[-/](\\d\\d(?:\\d\\d)?)","");
var rez = re.exec("12/30/1969");
var month = rez[1];
var day = rez[2];
var year = rez[3]; </syntaxhighlight></li>
<li>''bool test(string val);'' — повертає "true" якщо підрядок знайдено у ''val''.
<syntaxhighlight lang="JavaScript">
var re = new RegExp("(\\d\\d)[-/](\\d\\d)[-/](\\d\\d(?:\\d\\d)?)","");
var OK = re.test("12/30/1969"); </syntaxhighlight></li>
</ul>

=== Об'єкт вузла-тегу XML (XMLNodeObj) ===
Функції:
* ''string name( )'' — ім'я вузла, XML-тегу.
* ''string text( bool full = false )'' — текст вузла, вміст XML-тегу. Встановити ''full'' для отримання комбінованого тексту зі всіма включеними вузлами.
* ''string attr( string id )'' — значення атрибуту вузла ''id''.
* ''XMLNodeObj setName( string vl )'' — встановлює ім'я вузла у ''vl''. Повертає поточний вузол.
* ''XMLNodeObj setText( string vl )'' — встановлює текст вузла у ''vl''. Повертає поточний вузол.
* ''XMLNodeObj setAttr( string id, string vl )'' — встановлює атрибут ''id'' у значення ''vl''. Повертає поточний вузол.
* ''XMLNodeObj clear( bool full = false )'' — очищує вузол видаленням дочірніх вузлів, очищує текст та атрибути для ''full''.
* ''int childSize( )'' — кількість вкладених вузлів.
* ''XMLNodeObj childAdd( ElTp no = XMLNodeObj ); XMLNodeObj childAdd(string no)'' — додає об'єкт ''no'' як вкладений. ''no'' може бути як безпосередньо об'єктом-результатом функції "SYS.XMLNode()", так і рядком з ім'ям нового тегу. Повертається вкладений вузол.
* ''XMLNodeObj childIns( int id, ElTp no = XMLNodeObj ); XMLNodeObj childIns(int id, string no)'' — вставляє об'єкт ''no'' як вкладений, у позицію ''id''. ''no'' може бути як безпосередньо об'єктом-результатом функції "SYS.XMLNode()", так і рядком з ім'ям нового тегу. Повертається вкладений вузол.
* ''XMLNodeObj childDel( int id )'' — видаляє вкладений вузол у позиції ''id''. Повертає поточний вузол.
* ''XMLNodeObj childGet( int id )'' — отримує вкладений вузол у позиції ''id''. Повертає '''0''' за відсутності.
* ''XMLNodeObj childGet( string name, int num = 0 )'' — отримує вкладений вузол з ім'ям тегу ''name'' та порядковим номером ''num''. Повертає '''0''' за відсутності.
* ''XMLNodeObj parent()'' — отримує батьківський вузол. Повертає '''false''' за відсутності.
* ''string load( string str, bool file = false, int flg = 0, string cp = "UTF-8" )'' — завантажує XML з рядка ''str'' або з файлу з шляхом у ''str'' якщо ''file'' дорівнює "true", з кодуванням ''cp''. Повертає рядок із помилкою у форматі "'''{errCod}:{errText}'''", який "0" для успішного завантаження. Де ''flg'' — прапорці завантаження:
::0x01 — повне завантаження, з блоками тексту та коментарями у спеціальних вузлах;
::0x02 — не видаляти пробіли на початку та кінці тексту тегу.
* ''string save( int flg = 0, string path = "", string cp = "UTF-8" )'' — зберігає дерево XML у рядок або у файлі ''path'', з параметрами форматування ''flg'' та кодуванням ''cp''. Повертає текст XML або код помилки. Передбачено наступні прапорці форматування ''flg'':
::0x01 — переривати рядок перед відкривальним тегом;
::0x02 — переривати рядок після відкривального тегу;
::0x04 — переривати рядок після закривального тегу;
::0x08 — переривати рядок після тексту;
::0x10 — переривати рядок після інструкції;
::0x1E — переривати рядок після всіх;
::0x20 — вставляти стандартний XML-заголовок;
::0x40 — вставляти стандартний XHTML-заголовок;
::0x80 — очищати сервісні теги: <nowiki><??>, </nowiki>;
::0x100 — не кодувати назви тегів;
::0x200 — не кодувати назви атрибутів;
::0x400 — захист бінарних символів [\x0-\x8\xB-\xC\x0E-\x1F] та помилкових UTF-8.
* ''XMLNodeObj getElementBy( string val, string attr = "id" )'' — отримує елемент з дерева за атрибутом ''attr'' зі значенням ''val'', повертає '''null-EVAL''' за відсутності запитуваного елементу.
* ''TArrayObj<XMLNodeObj> getElementsBy( string tag, string attrVal = "", string attr = "id", int limit = 0, int from = 0 )'' — отримує масив елементів з дерева за тегом ''tag'' (порожній для всіх) та атрибутом ''attr'' зі значенням ''attrVal'' (порожній для пропуску), також починаючи із тегу з номером ''from'' і обмежуючи їх кількість у ''limit'' (нуль без обмеження).

== {{Anch|SYS|Програма-система (SYS)}} ==
Функції об'єкту:
<ul>
<li>''{string|int} system( string cmd, bool noPipe = false);'' — викликає консольні команди ''cmd'' ОС з поверненням результату по каналу. Якщо встановлено ''noPipe'' то повертається код повернення виклику та можливий запуск програм у фоні ("sleep 5 &"). Функція надає користувачу OpenSCADA широкі можливості через виклик будь яких системних програм, утиліт та скриптів, а також отримання за посередництвом них доступу до величезного об'єму системних даних. Наприклад, команда "ls -l" поверне деталізований вміст робочої теки.</li>
<li>''int fileSize( string file );'' — повертає розмір файлу ''file''.</li>
<li>''string fileRead( string file, int off = 0, int sz = -1 );'' — повертає рядок частини файлу ''file'' за зміщенням ''off'' та розміром ''sz''.</li>
<li>''int fileWrite( string file, string str, bool append = false );'' — записує рядок ''str'' до файлу ''file'', видаляючи присутній файл або додаючи до нього, ''append''. Повертає кількість записаних байт.</li>
<li>''int fileRemove( string file );'' — видаляє файл ''file''. Повертає результат видалення.</li>
<li>''int message( string cat, int level, string mess );'' — формує системне повідомлення ''mess'' з категорією ''cat'', рівнем ''level'' (-7...7). Негативне значення рівня формує порушення — "Alarm".</li>
<li>''int messDebug( string cat, string mess ); int messInfo( string cat, string mess ); int messNote( string cat, string mess ); int messWarning( string cat, string mess ); int messErr( string cat, string mess ); int messCrit( string cat, string mess ); int messAlert( string cat, string mess ); int messEmerg( string cat, string mess );'' — формує системне повідомлення ''mess'' з категорією ''cat'' та відповідним до назви рівнем.</li>
<li>''XMLNodeObj XMLNode( string name = "" );'' — створює об'єкт вузла XML з ім'ям ''name''.</li>
<li>''string cntrReq( XMLNodeObj req, string stat = "" );'' — надсилає запит ''req'' у вигляді XML до [[Special:MyLanguage/Documents/API#CntrNode|Інтерфейсу Управління]] програми. Повертає рядок із помилкою у форматі "'''{errCod}:{errText}'''", який "0" для успіху. Запит загалом записується у вигляді '''<get path="/OPath/%2felem" />''' та із додатковими атрибутами, специфічними до конкретного запиту. При визначені станції ''stat'' здійснюється запит до вказаної зовнішньої станції. Адресу до атрибуту "path" можна дізнатися у конфігураторі OpenSCADA, а саме у рядку статусу, де ця адреса виникає при наведені курсору миші на конфігураційне або інформаційне поле. Деякі приклади розповсюджених запитів, більше прикладів у [[Special:MyLanguage/Documents/API#CntrNode|описі Інтерфейсу Управління]] та [[Special:MyLanguage/Libs/Service_procedures#releaseTests|releaseTests()]]:<ul>
 <li>Читання значення елементу (ім'я користувача "test"):
<syntaxhighlight lang="JavaScript">
req = SYS.XMLNode("get").setAttr("path","/sub_Security/usr_test/%2fprm%2fDESCR");
SYS.cntrReq(req);
idSt = req.text(); </syntaxhighlight></li>
 <li>Запис значення елемента (ім'я користувача "test"):
<syntaxhighlight lang="JavaScript">
req = SYS.XMLNode("set").setAttr("path","/sub_Security/usr_test/%2fprm%2fDESCR").setText("New test user name");
SYS.cntrReq(req); </syntaxhighlight></li>
<li>Додання нового вузла (користувача "test"):
<syntaxhighlight lang="JavaScript">
req = SYS.XMLNode("add").setAttr("path","/sub_Security/%2fbr%2fusr_").setText("test");
SYS.cntrReq(req); </syntaxhighlight></li>
<li>Видалення вузла (користувача "test"):
<syntaxhighlight lang="JavaScript">
req = SYS.XMLNode("del").setAttr("path","/sub_Security/%2fbr%2fusr_").setText("test");
SYS.cntrReq(req); </syntaxhighlight></li>
<li>Збереження змін вузла у БД (користувача "test"):
<syntaxhighlight lang="JavaScript">
req = SYS.XMLNode("save").setAttr("path","/sub_Security/usr_test/%2fobj");
SYS.cntrReq(req); </syntaxhighlight></li>
<li>Завантаження вузла з БД (користувача "test"):
<syntaxhighlight lang="JavaScript">
req = SYS.XMLNode("load").setAttr("path","/sub_Security/usr_test/%2fobj");
SYS.cntrReq(req); </syntaxhighlight></li>
</ul></li>
<li>''string lang(string full);'' — повертає системну мову двома символами та повну мову у ''full''.</li>
<li>''int sleep(real tm, int ntm = 0);'' — засипає потік виконання на ''tm'' секунд (з точністю до наносекунд) та ''ntm'' наносекунд. Час сну можна встановити не більш STD_INTERF_TM (5 секунд).</li>
<li>''int time( int usec );'' — повертає абсолютний час у секундах від епохи 1.1.1970 та мікросекунди у ''usec'', якщо вказано.</li>
<li>''int utime( ); int mtime( );'' — повертає абсолютний час у мікросекундах та мілісекундах від епохи 1.1.1970.</li>
<li>''int {localtime|gmtime}( int fullsec, int sec, int min, int hour, int mday, int month, int year, int wday, int yday, int isdst );'' — повертає повну дату та час у секундах (sec), хвилинах (min), годинах (hour), днях місяця (mday), місяцях (month), роках (year), днях тижня (wday), днях у році (yday) та ознаку літнього часу (isdst), виходячи з абсолютного часу у секундах ''fullsec'' від епохи 1.1.1970. ''gmtime'' повертає час у GMT(UTC).</li>
<li>''int {mktime|timegm}(int sec, int min, int hour, int mday, int month, int year, int wday, int yday, int isdst);'' — формує час з епохи 1.1.1970 з окремо вказаних секунд, хвилин, годин, днів, місяців та інше. Значення окремих одиниць часу можуть вказуватися за межами їх звичного діапазону, що дозволяє використовувати цю функцію при переборі та у результаті чого одиниці часу буде виправлено та повернуто у звичайному діапазоні. ''timegm'' працює з часом у GMT(UTC). </li>
<li>''string {strftime|strftimegm}( int sec, string form = "%Y-%m-%d %H:%M:%S" );'' — перетворює абсолютний час ''sec'' у рядок потрібного формату ''form''. Запис формату відповідає POSIX-функції ''strftime''. ''strftimegm'' повертає час у GMT(UTC).</li>
<li>''int {strptime|strptimegm}( string str, string form = "%Y-%m-%d %H:%M:%S" );'' — повертає час у секундах від епохи 1.1.1970, виходячи з строкового запису часу ''str'', відповідно до вказаного шаблону ''form''. Наприклад, шаблону "%Y-%m-%d %H:%M:%S" відповідає час "2006-08-08 11:21:55". Опис формату шаблону можна отримати з документації на POSIX-функцію ''strptime''. ''strptimegm'' працює з часом у GMT(UTC).</li>
<li>''{{Anch|CRON|<nowiki>int cron( string cronreq, int base = 0 );</nowiki>}}'' — повертає час, спланований у форматі стандарту CRON, ''cronreq'', починаючи від базового часу ''base'' або від поточного, якщо базовий не вказано. Форма стандарту CRON це "* * * * *".
; Де елементи по черзі:
* хвилини (0-59);
* години (0-23);
* дні (1-31);
* місяці (1-12);
* дні тижня (0[Неділя]-6).
; Де варіанти елементу:
* "*" — будь яке значення;
* "1,2,3" — дозволені значення;
* "1-5" — діапазон дозволених значень;
* "*/2" — дільник загального діапазону дозволених значень.
; Приклади:
* "* * * * *" — кожна хвилина;
* "10 23 * * *" — лише 23я година та 10а хвилина будь якого дня та місяця;
* "*/2 * * * *" — для хвилин: 0,2,4,...,56,58;
* "* 2-4 * * *" — для будь якої хвилини у годинах від 2 до 4(включно).
</li>
<li>''string time2str( real tm, bool inParts = true );'' — Перетворює інтервал часу ''tm'' в секундах у людський рядок на кшталт "1година 23хвилини 10с" при встановлені ''inParts'' або "1.5 година" інакше.</li>
<li>''string cpct2str( real cnt );'' — Перетворює обсяг ''cnt'' в байтах у рядок людського представлення.</li>
<li>''string str2time( string val, bool inParts = true );'' — Перетворює відносний час людського представлення ''val'' функції ''time2str()'' у час в секундах, із розбором частин при встановлені ''inParts''.</li>
<li>''string strFromCharCode( int char1, int char2, int char3, ... );'' — створює рядок з кодів символів ''char1'', ''char2'' ... ''charN''.</li>
<li>''string strFromCharUTF([string type = "UTF-8",] int char1, int char2, int char3, ...);'' — створює рядок з UTF символів ''char1'', ''char2'' ... ''charN''. Наступні типи символу підтримуються: UTF-8, UTF-16, UTF-16LE, UTF-16BE, UTF-32, UTF-32LE, UTF-32BE.</li>
<li>''string strCodeConv( string src, string fromCP, string toCP );'' — перекодовує текст ''src'' з кодування ''fromCP'' у ''toCP''. Якщо кодування опущено (порожній рядок), то використовується внутрішнє.</li>
<li>''string strEncode( string src, string tp = "Bin", string opt = "" );'' — кодує рядок ''src'' за правилом ''tp'' та опції ''opt''. Доступні правила:
:"PathEl" — символи '''[/%]''' у "%2f" та "%25", відповідно;
:"HttpURL" — символи '''[ \t%]''' та "> 0x80" у "%20", "%09", "%25" та інше;
:"HTML" — символи HTML-сутностей '''[><"&']''' у "&amp;gt;", "&amp;lt;", "&amp;quot;" та інше;
:"JavaScript" — символ '\n' екрануванням "\\n";
:"SQL" — екранування-захист символів '''['"`\]''', доданням символу '\' або дублювання перелічених у ''opt'' символів;
:"Custom" — символів вказаних у ''opt'' у вигляд "%NN";
:"Base64" — бінарне кодування у Base 64, де у ''opt'' встановлюються символ(и) переривання рядку після 57 символів;
:"FormatPrint" — символ '%' в "%%";
:"OscdID" — майже всі символи на кшталт '''[ /\&(]''' у '_';
:"Bin" — перелік ASCII байтів ("XX XX XX XX ...") у бінарне представлення;
:"Reverse" — інверсія послідовності;
:"ToLower" — символи до нижнього регістру;
:"Limit" — обмеження рядку довжиною у ''opt'', враховуючи змінну довжину UTF-8;
:"ShieldSymb" — захист символів із ''opt'' (типово ['"`]) символом слешу "\" на кшталт '\n', '\r', ..., '\0NNN';
:"ShieldBin" — захист усіх бінарних символів [\x0-\x8\xB-\xC\x0E-\x1F] символом слешу "\".
</li>
<li>''string strDecode( string src, string tp = "Bin", string opt = "" );'' — декодує рядок ''src'' за правилом ''tp'' та опції ''opt''. Доступні правила:
:"PathEl", "HttpURL", "Custom" — символи вигляду "%NN" у бінарне представлення;
:"Base64" — відповідно з Base 64;
:"Bin" — бінарний рядок у ASCII байти ("XX XX XX XX .. A.b.c.."), ''opt'' вказує на роздільник або "<text>", для включення зміщення ліворуч та текстової частини праворуч;
:"ShieldSymb" — захищені символи на кшталт '\n', '\r', ..., '\0NNN', '\xNN' у бінарне представлення.
</li></ul>

== {{Anch|TCntrNode|Будь який об'єкт (TCntrNode) дерева OpenSCADA (SYS.*)}} ==
Функції об'єкту:
* ''PropTp property(string id, PropTp val = '''null''');'' — Повертає властивість ''id'' об'єкту для групи ''grp'' із встановленням її у ''val'' не '''null''' і '''EVAL'''. Де ''val'' у '''EVAL''' очищує властивість і '''null''' (без аргументу) просто нічого не встановлює. Ви можете [[#Object|звертатися прямо]] до властивостей об'єктів TCntrNode, звісно за їх відсутності у Моделі Об'єктів.
* ''TArrayObj nodeList( string grp = "", string path = "" );'' — повертає перелік повних ідентифікаторів дочірніх вузлів для групи ''grp'' та вузла за шляхом ''path''. Якщо ''grp'' порожня то повертаються вузли всіх груп. Повний ідентифікатор, це "{grp}{nID}".
* ''TCntrNodeObj nodeAt( string path, string sep = "" );'' — під'єднує до вузла ''path'' у дереві об'єктів OpenSCADA (рис.1). Якщо вказується роздільник у ''sep'' то шлях обробляється як рядок з роздільником. Для відсутніх і некоректних вузлів ця функція повертатиме "false", тоді як коректний вузол при перетворені у BOOLEAN повертатиме "true".
* ''TCntrNodeObj nodePrev( );'' — повертає попередній-батьківський вузол.
* ''string nodePath( string sep = "", bool from_root = true );'' — повертає шлях до поточного вузла у дереві об'єктів OpenSCADA (рис.1). Символ роздільника вказується у ''sep'', для отримання шляху через роздільник, наприклад — "DAQ.ModBus.PLC1.P1.var", інакше — "/DAQ/ModBus/PLC1/P1/var". ''from_root'' вказує на необхідність формувати шлях від кореня та без вказання ідентифікатору станції.
* ''int messSys( int level, string mess )'' — формує системне повідомлення ''mess'' з рівнем ''level'', зі шляхом вузла у якості категорії та з читабельним шляхом перед повідомленням.

== Підсистема "Безпека" (SYS.Security) ==
Функції об'єкту підсистеми (SYS.Security):
* ''int access( string user, int mode, string owner, string group, int perm )'' — перевіряє доступ користувача ''user'' до ресурсу, який належить ''owner'' та ''group'' з правами ''perm'' і для режиму ''mode'':
::''user'' — користувач перевірки доступу;
::''mode'' — режим доступу (4-R, 2-W, 1-X);
::''owner'' — власник ресурсу;
::''group'' — група ресурсу;
::''perm'' — права ресурсу (RWXRWXRWX — 0777).

Функції об'єкту "Користувач" (SYS.Security["usr_{User}"]):
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поле ''nm'' об'єкту у значення ''val''.
* ''bool auth( string pass )'' — повертає TRUE у випадку вдалої автентифікації користувача за ''pass''.
* ''Array groups( )'' — повертає перелік груп користувача.

Функції об'єкту "Група користувачів" (SYS.Security["grp_{Group}"]):
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поле ''nm'' об'єкту у значення ''val''.
* ''bool user( string nm )'' — перевіряє присутність користувача ''nm'' у даній групі.

== {{Anch|SYS.BD|Підсистема "БД" (SYS.BD)}} ==
Функції об'єкту бази даних (SYS.BD["TypeDB"]["DB"]):
<ul>
<li>''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.</li>
<li>''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поле ''nm'' об'єкту у значення ''val''.</li>
<li>''Array SQLReq( string req, bool tr = '''EVAL''' );'' — здійснює SQL-запит ''req'' до БД, всередині (''tr''=true), назовні (''tr''=false) або байдуже (''tr''='''EVAL''') до транзакції. Повертає масив рядків таблиці результату з полями за індексами і за іменами стовпців. У випадку помилки її значення розташовується у властивості "err" результату.
<syntaxhighlight lang="JavaScript">
DBTbl = SYS.BD.MySQL.GenDB.SQLReq("SELECT * from DB;");
if(DBTbl.err.length) SYS.messInfo("TEST DB","Error: "+DBTbl.err);
else for(var iRw = 0; iRw < DBTbl.length; iRw++) {
 var rec = "";
 for(var iFld = 0; iFld < DBTbl[iRw].length; iFld++) rec += DBTbl[iRw][iFld] + "\t";
 SYS.messInfo("TEST DB", "Row "+iRw+": "+rec);
 //Get column value by the name
 if(iRw) SYS.messInfo("TEST DB", "Row "+iRw+": 'NAME'"+DBTbl[iRw]["NAME"]);
} </syntaxhighlight></li>
</ul>

Функції об'єкту таблиці (SYS.BD["TypeDB"]["DB"]["Table"]):
<ul>
<li>''XMLNodeObj fieldStruct( );'' — отримує структуру таблиці у вигляді XML вузла "field" з дочірніми вузлами-стовпчиками '''<RowId type="real" len="10.2" key="1" def="Default value">{Value}</RowId>''', де:<ul>
 <li>{RowId} — ідентифікатор стовпчика;</li>
 <li>{Value} — значення стовпчика;</li>
 <li>type — тип значення стовпчика: ''str'' — рядок, ''int'' — ціле, ''real'' — реальне та ''bool'' — логічне;</li>
 <li>len — розмір значення стовпчика, у знаках;</li>
 <li>key — ознака того, що стовпчик є ключем, та пошук здійснюється за його значенням;</li>
 <li>def — значення стовпчика по замовченню.</li>
</ul></li>
<li>''string fieldSeek( int row, XMLNodeObj fld );'' — запитує поле ''row'' таблиці. Якщо поле отримано то повертається "1" інакше "0". У випадку помилки повертається "0:Error".</li>
<li>''string fieldGet( XMLNodeObj fld );'' — запитує значення поля. У випадку помилки повертається "0:Error".
<syntaxhighlight lang="JavaScript">
req = SYS.XMLNode("field");
req.childAdd("user").setAttr("type","str").setAttr("key","1").setText("root");
req.childAdd("id").setAttr("type","str").setAttr("key","1").setText("/Lang2CodeBase");
req.childAdd("val").setAttr("type","str");
SYS.BD.MySQL.GenDB.SYS.fieldGet(req);
SYS.messDebug("TEST DB","Value: "+req.childGet(2).text()); </syntaxhighlight></li>
<li>''string fieldSet( XMLNodeObj fld );'' — встановлює поле. У випадку помилки повертається "0:Error".</li>
<li>''string fieldDel( XMLNodeObj fld );'' — видаляє поле. У випадку помилки повертається "0:Error".</li>
</ul>

== {{Anch|SYS.DAQ|Підсистема "Збір даних" (SYS.DAQ)}} ==
Функції об'єкту підсистеми (SYS.DAQ):
<ul>
<li>''TCntrNodeObj daqAt(string path, string sep = "", waitForAttr = true)'' — підключається до DAQ вузла (об'єкт контролеру, параметр, атрибут) за шляхом ''path'' або поділюваним рядком за поділювачем ''sep'', від DAQ-підсистеми. Перевіряти на атрибут у кінці шляху, за ''waitForAttr''.</li>
<li>''bool funcCall( string progLang, TVarObj args, string prog, string fixId = "", string err = "" );'' — виконує текст функції ''prog'' з аргументами у об'єкті ''args'' на мові програмування ''progLang'' та з ідентифікатором фіксації ''fixId'' (автоматично якщо порожній). Повертає "true" при коректному виконанні, інакше "false" та встановлюється "err". Фіксована функція відрізняється від автоматичної тим, що вона не видаляється після виконання, а використовується повторно за адресою у ''fixId'', яка замінює оригінальний ідентифікатор при першому виклику. Для переформування функції треба змінити програму або очистити ''fixId'' у її оригінальний ідентифікатор.
<syntaxhighlight lang="JavaScript">
var args = new Object();
args.y = 0;
args.x = 123;
SYS.DAQ.funcCall("JavaLikeCalc.JavaScript",args,"y=2*x;");
SYS.messDebug("TEST Calc","TEST Calc rezult: "+args.y); </syntaxhighlight></li>
<li>''string funcSnthHgl(string progLang);'' — запит правил підсвітлення синтаксису мови програми ''progLang'' у [[Special:MyLanguage/Documents/API#SnthHgl|XML-тегу ''SnthHgl'']].</li>
</ul>

Функції об'єкту контролеру (SYS.DAQ["Modul"]["Controller"]):
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поля ''nm'' об'єкту у значення ''val''.
* ''string name( )'' — ім'я об'єкту контролера.
* ''string descr( )'' — опис об'єкту та контролеру.
* ''string status( )'' — статус контролеру.
* ''bool messSet( string mess, int lev, string type2Code = "OP", string prm = "", string cat = "")'' — встановлює повідомлення джерела даних ''mess'' із рівнем ''lev'', для параметру ''prm'' ('''{PrmId}\n{PrmNm}'''), додатковою інформацією категорії ''cat'' та кодом типу ''type2Code''. Ця функція [[Special:MyLanguage/Documents/Program_manual#ArchMess|формує повідомлення]] з уніфікованою категорією транспортування через джерело даних '''{type2Code}{ModId}:{CntrId}[.{PrmId}][:{cat}]''' та текстом '''{CntrNm} > {PrmNm}: {MessText}''', де: 
** ''type2Code'' — двосимвольний код типу повідомлення, по замовченню означає дію оператору "OP";
** ''ModId'' — ідентифікатор модуля;
** ''CntrId'' — ідентифікатор об'єкту контролера;
** ''PrmId'' — ідентифікатор параметру, з аргументу ''prm'';
** ''cat'' — додаткова інформація категорії яку визначено для типу ''type2Code''
** ''CntrNm'' — назва об'єкту контролера, тобто встановлення або із поля опису "'''MessName: {Name}'''" (навіть порожнє для приховування) або із непорожньої назви;
** ''PrmNm'' — назва параметру, з аргументу ''prm'';
** ''MessText'' — текст повідомлення.
* ''bool alarmSet( string mess, int lev = -5, string prm = "", bool force = false )'' — встановлює/знімає порушення ''mess'' із рівнем ''lev'' (негативне для встановлення інакше зняття), для параметру ''prm'' ('''{PrmId}\n{PrmNm}'''). Очищення порушень, так як і встановлення, працює у режимі перемикача, що передбачає пропуск повідомлень очищення до буферу повідомлень, та саме очищення, лише за наявності відповідного порушення, що може бути вимкнено встановленням ''force''. Функція формує порушення з категорією '''al{ModId}:{CntrId}[.{PrmId}]''' та текстом '''{CntrNm} > {PrmNm}: {MessText}''', де:
** ''ModId'' — ідентифікатор модуля;
** ''CntrId'' — ідентифікатор об'єкту контролера;
** ''PrmId'' — ідентифікатор параметру, з аргументу ''prm'';
** ''CntrNm'' — назва об'єкту контролера, тобто встановлення або із поля опису "'''MessName: {Name}'''" (навіть порожнє для приховування) або із непорожньої назви;
** ''PrmNm'' — назва параметру, з аргументу ''prm'';
** ''MessText'' — текст повідомлення.
* ''bool enable( bool newSt = '''EVAL''' )'' — отримує стан "Включений" або змінює його призначенням атрибуту ''newSt''.
* ''bool start( bool newSt = '''EVAL''' )'' — отримує стан "Виконується" або змінює його призначенням атрибуту ''newSt''.

Функції об'єкту параметру контролера (SYS.DAQ["Modul"]["Controller"]["Parameter"]):
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поля ''nm'' об'єкту у значення ''val''.
* ''TCntrNodeObj cntr( )'' — повертає об'єкт контролеру цього параметру, незалежно від вкладеності.
* ''bool messSet( string mess, int lev, string type2Code = "OP", string cat = "")'' — встановлює повідомлення джерела даних ''mess'' із рівнем ''lev'', для параметру, чия назва вставляється до тексту ієрархічно або із поля опису "'''MessName: {Name}'''" (навіть порожнє для приховування) або із непорожньої назви.
* ''bool alarmSet( string mess, int lev = -5, bool force = false )'' — встановлює/знімає порушення ''mess'' з рівнем ''lev'' (негативне для встановлення інакше зняття) для цього параметру, чия назва вставляється до тексту ієрархічно або із поля опису "'''MessName: {Name}'''" (навіть порожнє для приховування) або із непорожньої назви. Очищення порушень, так як і встановлення, працює у режимі перемикача, що передбачає пропуск повідомлень очищення до буферу повідомлень, та саме очищення, лише за наявності відповідного порушення, що може бути вимкнено встановленням ''force''.

Функції об'єкту атрибута параметра контролера (SYS.DAQ["Modul"]["Controller"]["Parameter"]["Attribute"]):
* ''ElTp get( int tm = 0, int utm = 0, bool sys = false )'' — запитує значення атрибуту на час ''tm.utm'' та ознакою системного доступу ''sys''. Атрибути часу ''tm.utm'' є також виходами, відтак реальний час отриманого значення розміщується у них, якщо це змінні.
* ''bool set( ElTp val, int tm = 0, int utm = 0, bool sys = false )'' — записує значення ''val'' до атрибуту з міткою часу ''tm:utm'' та ознакою системного доступу ''sys''.
* ''TCntrNodeObj arch( )'' — отримує об'єкт архіву, пов'язаний з цим атрибутом. У випадку відсутності пов'язаного архіву повертається "false".
* ''string descr( )'' — опис атрибуту.
* ''int time( int utm )'' — час останнього значення у секундах та мікросекундах у ''utm'', якщо вказано та є змінною.
* ''int len( )'' — довжина поля у БД.
* ''int dec( )'' — роздільна здатність реального числа поля у БД.
* ''int flg( )'' — прапорці поля.
* ''string def( )'' — значення по замовченню.
* ''string values( )'' — перелік допустимих значень або діапазон.
* ''string selNames( )'' — перелік імен допустимих значень.
* ''string reserve( )'' — резервна властивість значення.

Функції об'єкта бібліотеки шаблона (SYS.DAQ[tmplb_Lib"]) та шаблону (SYS.DAQ[tmplb_Lib"]["Tmpl"]) параметра контролеру:
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поля ''nm'' об'єкту у значення ''val''.

=== Модуль [[Special:MyLanguage/Modules/JavaLikeCalc|DAQ.JavaLikeCalc]] ===
{{#lst:Modules/JavaLikeCalc/uk|API}}
=== Модуль [[Special:MyLanguage/Modules/LogicLev|DAQ.LogicLev]] ===
{{#lst:Modules/LogicLev/uk|API}}
=== Модуль [[Special:MyLanguage/Modules/BlockCalc|DAQ.BlockCalc]] ===
{{#lst:Modules/BlockCalc/uk|API}}
=== Модуль [[Special:MyLanguage/Modules/ModBus|DAQ.ModBus]] ===
{{#lst:Modules/ModBus/uk|API}}
=== Модуль [[Special:MyLanguage/Modules/Siemens|DAQ.Siemens]] ===
{{#lst:Modules/Siemens/uk|API}}
=== Модуль [[Special:MyLanguage/Modules/OPC_UA|DAQ.OPC_UA]] ===
{{#lst:Modules/OPC_UA/uk|API}}

== {{Anch|SYS.Archive|Підсистема "Архіви-Історія" (SYS.Archive)}} ==
Функції об'єкту підсистеми:
* ''Array messGet( int btm, int etm, string cat = "", int lev = 0, string arch = "", int upTm = 0 );'' — запитує повідомлення програми або порушеня (lev < 0) на час від ''btm'' по ''etm'' для категорії ''cat'', рівня ''lev'' (-7...7) та архіваторів ''arch'' (поділені символом ';'; "" — буфер та архіватори; "<buffer>" — буфер; "{ArhMod}.{Arh}" — конкретний архіватор модуля). ''upTm'' встановлює обмеження тривалості операції у визначений час; негативне значення використовується як відносний час; менше ніж STD_INTERF_TM (5). Повертається час зупинки читання (атрибут "tm" масиву) та масив об'єктів повідомлень/порушень з властивостями:
** ''tm'' — час повідомлення, секунди;
** ''utm'' — час повідомлення, мікросекунди;
** ''categ'' — категорія повідомлення;
** ''level'' — рівень повідомлення;
** ''mess'' — текст повідомлення.
* ''bool messPut( int tm, int utm, string cat, int lev, string mess, string arch = "" );'' — записує повідомлення ''mess'' з категорією ''cat'', рівнем ''lev'' (-7...7) та часом ''tm.utm'' до архіваторів ''arch'' (поділені символом ';') та/або перелік порушень.

Функції об'єкту архіватору повідомлень (SYS.Archive["mod_Modul"]["mess_Archivator"]):
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поля ''nm'' об'єкту у значення ''val''.
* ''bool status( )'' — статус архіватору "Виконання".
* ''int end( )'' — час закінчення даних архіватору.
* ''int begin( )'' — час початку даних архіватору.

Функції об'єкту архіватору значень (SYS.Archive["val_Modul"]["val_Archivator"]):
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поля ''nm'' об'єкту у значення ''val''.
* ''bool status( )'' — статус архіватору "Виконання".

{{Anch|SYS.Archive|Функції об'єкту архіву (SYS.Archive["va_Archive"]):}}
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поля ''nm'' об'єкту у значення ''val''.
* ''bool status( )'' — статус архіву "Виконання".
* ''int end( string arch = "" )'' — час закінчення даних архіву для архіватору ''arch'', у мікросекундах.
* ''int begin( string arch = "" )'' — час початку даних архіву для архіватору ''arch'', у мікросекундах.
* ''int period( string arch = "" )'' — період даних архіву для архіватору ''arch'', у мікросекундах.
* ''TArrayObj archivatorList( )'' — перелік архіваторів, які використовують цей архів як джерело.
* ''VarType getVal( int tm, bool up_ord = false, string arch = "" )'' — отримує значення з архіву на час ''tm'', підтягненням догори ''up_ord'' та архіватору ''arch'':
** ''tm'' — час запитаного значення, у мікросекундах, встановити у 0 для "end()"; цей атрибут є також виходом, відтак реальний час отриманого значення поміщається сюди, якщо це змінна;
** ''up_ord'' — підтягувати час запитаного значення догори ґратки;
** ''arch'' — архіватор запиту, встановити у порожній рядок для перевірки всіх архіваторів, встановити у "<buffer>" для обробки тільки буферу.
* ''bool setVal( int tm, VarType vl, string arch = "" )'' [доступ до підсистеми Архіви-Історія] — встановлює значення ''vl'' у архів на час ''tm'' та архіватор ''arch'':
** ''tm'' — час встановленого значення, у мікросекундах;
** ''vl'' — значення;
** ''arch'' — архіватор встановлення, встановити у порожній рядок для всіх архіваторів, встановити у "<buffer>" для обробки тільки буферу.
* ''Array getVals( int begTm, int endTm, int period, string arch = "" )'' — отримує архів/історію значень з ''begTm'' та до ''endTm'' для архіватору ''arch'':
** ''begTm'' — час початку запитаного діапазону даних, у мікросекундах, буде змінено у реальний початок даних;
** ''endTm'' — час закінчення запитаного діапазону даних, у мікросекундах;
** ''period'' — період даних, у мікросекундах, має бути обов'язково визначене та буде використане максимальне значення для цього архіву, буде змінено у періодичність реальних даних;
** ''arch'' — архіватор запиту, встановити у порожній рядок для перевірки всіх архіваторів, встановити у "<buffer>" для обробки тільки буферу.
* ''bool setVals( Array buf, int tm, int period, string arch = "" )'' [доступ до підсистеми Архіви-Історія] — встановлює значення архіву/історії ''buf'' у архів від часу початку ''tm'', для періоду значень ''period'' та архіватору ''arch''.
** ''buf'' — масив значень до встановлення;
** ''tm'' — час початку встановлюваного діапазону даних, у мікросекундах;
** ''period'' — період встановлюваних даних, у мікросекундах, має бути обов'язково визначене та буде використане максимальне значення для цього архіву, буде змінено у періодичність реальних даних;
** ''arch'' — архіватор запиту, встановити у порожній рядок для перевірки всіх архіваторів, встановити у "<buffer>" для обробки тільки буферу.

== {{Anch|SYSTransport|Підсистема "Транспорти" (SYS.Transport)}} ==
Функції об'єкту підсистеми:
* ''TCntrNodeObj outAt( string addr );'' — загальне-уніфіковане підключення вихідного транспорту за адресою ''addr''. При помилках створення транспорту функція повертатиме "false", тоді як коректний вузол при перетворені у BOOLEAN повертатиме "true". Адреса визначається у формах:
:: "'''{TrModule}.[out_]{TrID}[:{TrAddr}]'''" — типове вихідне із автоматичним створенням ''TrID'' за відсутності та наявності ''TrAddr'';
:: "'''{TrModule}.in_{TrID}:{RemConId}'''" — ініціативне вхідне із ідентифікатором підключення у ''RemConId''.
:* ''TrModule'' — модуль транспорту, як є [[Special:MyLanguage/Modules/Sockets|Sockets]], [[Special:MyLanguage/Modules/SSL|SSL]], [[Special:MyLanguage/Modules/Serial|Serial]];
:* ''TrID'' — ідентифікатор транспорту;
:* ''TrAddr'' — специфічна адреса транспорту;
:* ''RemConId'' — ІД віддаленого ініціативного підключення.

Функції об'єкту вхідного транспорту (SYS.Transport["Modul"]["in_Transp"]):
* ''ElTp cfg( string nm )'' — отримує значення конфігураційного поля ''nm'' об'єкту.
* ''bool cfgSet( string nm, ElTp val )'' [доступ до відповідної підсистеми] — встановлює конфігураційне поля ''nm'' об'єкту у значення ''val''.
* ''string status()'' — рядок статусу транспорту.
* ''string addr( string vl = "" )'' — адреса транспорту, встановлює у непорожнє значення ''vl''.
* ''string writeTo( string sender, string mess )'' — відправляє повідомлення ''mess'' відправнику ''sender'', як відповідь.
* ''TArrayObj associateTrsList( )'' — перелік асоційованих вихідних транспортів із цим вхідним.
* ''TCntrNodeObj associateTr( string id )'' — отримання асоційованого транспорту за підключенням ''id''.
* ''ElTp conPrm( string id, ElTp val = '''EVAL''', string cfg = "" )'' — загальне поводження із параметром часу підключення ''id'' з встановленням у значення ''val'' за наявності; запит конфігураційного параметру часу підключення із реєстрацією конфігурації ''cfg'' у форматі "{SRC}\n{NAME}\n{HELP}" вперше.
* ''bool setConPrm( string id, ElTp val )'' — встановлення параметру часу підключення ''id'' у значення ''val'', лише для сумісності.

Функції об'єкту вихідного транспорту (SYS.Transport["Modul"]["out_Transp"]):
<ul>
<li>''bool isNetwork()'' — ознака — "Транспорт мережевий", що визначає таймаути у секундах.</li>
<li>''ElTp cfg(string nm)'' — отримує значення конфігураційного поля ''nm'' об'єкту.</li>
<li>''bool cfgSet(string nm, ElTp val)'' [доступ до відповідної підсистеми] — встановлює конфігураційне поле ''nm'' об'єкту у значення ''val''.</li>
<li>''string status()'' — рядок статусу транспорту.</li>
<li>''bool start( bool vl = '''EVAL''', int tm = 0 )'' — повертає статус "Виконання", запускає/зупиняє за ''vl'' (якщо не '''EVAL'''). Для запуску можна вказувати особливий таймаут ''tm''.</li>
<li>''string addr( string vl = "" )'' — адреса транспорту, встановлює у непорожнє значення ''vl''.</li>
<li>''string timings( string vl = "", isDef = true )'' — таймінги транспорту, встановлює у непорожнє значення ''vl'' та по замовченню для ''isDef''. </li>
<li>''int attempts( int vl = '''EVAL''' )'' — спроб підключень транспорту, встановлює у не-'''EVAL''' значення ''vl''.</li>
<li>''ElTp conPrm( string id, ElTp val = '''EVAL''', string cfg = "" )'' — загальне поводження із параметром часу підключення ''id'' з встановленням у значення ''val'' за наявності; запит конфігураційного параметру часу підключення із реєстрацією конфігурації ''cfg'' у форматі "{SRC}\n{NAME}\n{HELP}" вперше.</li>
<li>''bool setConPrm( string id, ElTp val )'' — встановлення параметру часу підключення ''id'' у значення ''val'', лише для сумісності.</li>
<li>''string messIO( string mess, real timeOut = 0, int inBufLen = -1 );'' — відправляє повідомлення ''mess'' через транспорт з таймаутом очікування відповіді ''timeOut'' (у секундах) та читає відповідь (буфер) розміром ''inBufLen'' байт. У випадку нульового таймауту цей час береться з налаштувань вихідного транспорту. Негативний час ''timeOut'' (< -1e-3) вимикає роботу транспорту у режимі запит/відповідь та дозволяє незалежно читати/писати у буфер ВВ, з таймаутом читання ''timeOut'' у абсолютному значенні. Для негативного ''inBufLen'' розмір буферу встановлюється у STR_BUF_LEN(10000), а "0" вимикає читання взагалі. 
[[File:at.png]] Якщо Ваш транспорт у відповідь на запит передбачає отримання даних частинами тоді використовуйте цю функцію у одному потоці для декількох пристроїв на одній шині-транспорті оскільки тут не існує способу блокування транспорту з користувацького API. Один потік це об'єкт контролеру підсистеми "Збір даних", а [[Special:MyLanguage/Modules/UserProtocol|модуль "Протокол користувача"]] блокує транспорт всередині, перед виконанням своїх користувацьких процедур.
<syntaxhighlight lang="JavaScript">
rez = SYS.Transport.Serial.out_ttyUSB0.messIO(SYS.strFromCharCode(0x4B,0x00,0x37,0x40),0.2);
//Wait for all the message tail by timeout and empty result
while(rez.length && (trez=SYS.Transport.Serial.out_ttyUSB0.messIO("")).length) rez += trez; </syntaxhighlight></li>
<li>''string messIO( XMLNodeObj req, string prt );'' — відправляє запити ''req'' до протоколу ''prt'' для здійснення сеансу зв'язку через транспорт за посередництвом протоколу. Повертає рядок із помилкою у форматі "'''{errCod}:{errText}'''", який порожній для успішного запиту.
<syntaxhighlight lang="JavaScript">
req = SYS.XMLNode("TCP");
req.setAttr("id","test").setAttr("reqTm",500).setAttr("node",1).setAttr("reqTry",2).setText(SYS.strFromCharCode(0x03,0x00,0x00,0x00,0x05));
SYS.Transport.Sockets.out_testModBus.messIO(req,"ModBus");
test = Special.FLibSYS.strDec4Bin(req.text()); </syntaxhighlight></li>
</ul>

== Підсистема "Протоколи" (SYS.Protocols) ==
=== Модуль [[Special:MyLanguage/Modules/HTTP|Protocol.HTTP]] ===
{{#lst:Modules/HTTP/uk|API}}

== {{Anch|SYSUI|Підсистема "Користувацькі інтерфейси" (SYS.UI)}} ==
* ''string mimeGet(string fnm);'' — отримання типу MIME за назвою файлу ''fnm''.

=== Модуль [[Special:MyLanguage/Modules/QTStarter|QTStarter]] ===
{{#lst:Modules/QTStarter/uk|API}}
=== Модуль [[Special:MyLanguage/Modules/VCAEngine|UI.VCAEngine]] ===
{{#lst:Sub-projects/VCA/uk|API}}

== Підсистема "Спеціальні" (SYS.Special) ==
=== Модуль [[Special:MyLanguage/Modules/FLibSYS|Бібліотека системного API середовища користувацького програмування (Special.FLibSYS)]] ===
{{#lst:Modules/FLibSYS/uk|API}}
=== Модуль [[Special:MyLanguage/Modules/FLibMath|Бібліотека стандартних математичних функцій (Special.FLibMath)]] ===
{{#lst:Modules/FLibMath/uk|API}}
=== Модуль [[Special:MyLanguage/Modules/FLibComplex1|Бібліотека функцій сумісності з SCADA Complex1 фірми ТОВ НІП "DIYA" (Special.FLibComplex1)]] ===
{{#lst:Modules/FLibComplex1/uk|API}}

== Бібліотеки функцій користувача  ==
На цей час OpenSCADA має бібліотеки функцій користувача, написані з використанням цього API користувача. Деякі з них розроблено для виключного використання з цього API. Всі бібліотеки користувача представлено у наступній таблиці:
{{:Libs/uk}}

== Посилання ==
* [[:File:Oscada UserOM_uk.odg|Діаграма: Користувацька об'єктна модель ядра OpenSCADA.]]

Export translations

Views

Navigation menu

OpenSCADA

OpenSCADA Wiki

Search

Tools

MediaWiki

Personal tools