Export translations
Views
Special page
From OpenSCADAWiki
Jump to:
navigation
,
search
Settings
Group
About
Documents
Documents/API
Documents/DAQ
Documents/FAQ
Documents/How to
Documents/How to/Build from source
Documents/How to/Crash report
Documents/How to/Create module
Documents/How to/Create multi language project
Documents/How to/Cyclic programming
Documents/How to/Debug
Documents/How to/Install
Documents/How to/Live disk
Documents/How to/Release
Documents/How to/Transferring project configuration
Documents/How to/Violations, alarms and notifications
Documents/Program manual
Documents/Quick start
Documents/Release 0.8.0
Documents/Release 0.8.0/Update10
Documents/Release 0.8.0/Update11
Documents/Release 0.8.0/Update12
Documents/Release 0.8.0/Update13
Documents/Release 0.8.0/Update14
Documents/Release 0.8.0/Update15
Documents/Release 0.8.0/Update16
Documents/Release 0.8.0/Update17
Documents/Release 0.8.0/Update18
Documents/Release 0.8.0/Update19
Documents/Release 0.8.0/Update20
Documents/Release 0.8.0/Update3
Documents/Release 0.8.0/Update4
Documents/Release 0.8.0/Update5
Documents/Release 0.8.0/Update6
Documents/Release 0.8.0/Update7
Documents/Release 0.8.0/Update8
Documents/Release 0.8.0/Update9
Documents/Release 0.9
Documents/Release 0.9/Update 7
Documents/Release 0.9/Update1
Documents/Release 0.9/Update2
Documents/Release 0.9/Update3
Documents/Release 0.9/Update4
Documents/Release 0.9/Update5
Documents/Release 0.9/Update6
Documents/Release 0.9/Updating 0.8.0 LTS
Documents/Terms
Documents/User API
Functions and demands
Home
Libs
Libs/Devices
Libs/Documents
Libs/Electrical elements
Libs/Generic list
Libs/LowLevelDevices
Libs/Main
Libs/Main graphical elements
Libs/Mnemo elements
Libs/Prescriptions
Libs/Regulation elements
Libs/Service procedures
Libs/Technological apparatuses
Modules
Modules/BFN
Modules/BlockCalc
Modules/Comedi
Modules/DAQGate
Modules/DBArch
Modules/DBF
Modules/DBGate
Modules/DCON
Modules/DiamondBoards
Modules/FireBird
Modules/FLibComplex1
Modules/FLibMath
Modules/FLibSYS
Modules/FSArch
Modules/GPIO
Modules/HTTP
Modules/ICP DAS
Modules/JavaLikeCalc
Modules/LDAP
Modules/LogicLev
Modules/ModBus
Modules/MySQL
Modules/OPC UA
Modules/PostgreSQL
Modules/QTCfg
Modules/QTStarter
Modules/SelfSystem
Modules/Serial
Modules/Siemens
Modules/SMH2Gi
Modules/SNMP
Modules/Sockets
Modules/SoundCard
Modules/SQLite
Modules/SSL
Modules/System
Modules/SystemTests
Modules/UserProtocol
Modules/VCAEngine
Modules/Vision
Modules/WebCfg
Modules/WebCfgD
Modules/WebUser
Modules/WebVision
Sub-projects
Sub-projects/Automatic Builder of OpenSCADA
Sub-projects/Automation Linux distributive
Sub-projects/Embedding and PLC
Sub-projects/Server
Sub-projects/VCA
User:RomanSavochenko
Using
Using/HouseSpirit
Using/Kramatorsk Ball Mills
Using/Kramatorsk Water
Using/Model AGLKS
Using/Model Boiler
Using/OpenWrt TELEOFIS RTU968
Using/Yaroslavskij broiler
Works
Works/Road map
Works/Technical Support
Works/Technical Support/Agreement
Works/To do
Language
aa - Afar
ab - Abkhazian
ace - Achinese
ady - Adyghe
ady-cyrl - адыгабзэ
aeb - Tunisian Arabic
aeb-arab - تونسي
aeb-latn - Tûnsî
af - Afrikaans
ak - Akan
aln - Gheg Albanian
am - Amharic
an - Aragonese
ang - Old English
anp - Angika
ar - Arabic
arc - Aramaic
arn - Mapuche
arq - Algerian Arabic
ary - Moroccan Arabic
arz - Egyptian Arabic
as - Assamese
ase - American Sign Language
ast - Asturian
av - Avaric
avk - Kotava
awa - Awadhi
ay - Aymara
az - Azerbaijani
azb - تۆرکجه
ba - Bashkir
bar - Bavarian
bbc - Batak Toba
bbc-latn - Batak Toba
bcc - Southern Balochi
bcl - Bikol Central
be - Belarusian
be-tarask - Belarusian (Taraškievica orthography)
bg - Bulgarian
bgn - Western Balochi
bho - Bhojpuri
bi - Bislama
bjn - Banjar
bm - Bambara
bn - Bengali
bo - Tibetan
bpy - Bishnupriya
bqi - Bakhtiari
br - Breton
brh - Brahui
bs - Bosnian
bto - Iriga Bicolano
bug - Buginese
bxr - буряад
ca - Catalan
cbk-zam - Chavacano de Zamboanga
cdo - Min Dong Chinese
ce - Chechen
ceb - Cebuano
ch - Chamorro
cho - Choctaw
chr - Cherokee
chy - Cheyenne
ckb - Central Kurdish
co - Corsican
cps - Capiznon
cr - Cree
crh - Crimean Turkish
crh-cyrl - Crimean Turkish (Cyrillic script)
crh-latn - Crimean Turkish (Latin script)
cs - Czech
csb - Kashubian
cu - Church Slavic
cv - Chuvash
cy - Welsh
da - Danish
de - German
de-at - Austrian German
de-ch - Swiss High German
de-formal - German (formal address)
diq - Zazaki
dsb - Lower Sorbian
dtp - Central Dusun
dty - डोटेली
dv - Divehi
dz - Dzongkha
ee - Ewe
egl - Emilian
el - Greek
eml - Emiliano-Romagnolo
en - English
en-ca - Canadian English
en-gb - British English
eo - Esperanto
es - Spanish
et - Estonian
eu - Basque
ext - Extremaduran
fa - Persian
ff - Fulah
fi - Finnish
fit - Tornedalen Finnish
fj - Fijian
fo - Faroese
fr - French
frc - Cajun French
frp - Arpitan
frr - Northern Frisian
fur - Friulian
fy - Western Frisian
ga - Irish
gag - Gagauz
gan - Gan Chinese
gan-hans - Simplified Gan script
gan-hant - Traditional Gan script
gd - Scottish Gaelic
gl - Galician
glk - Gilaki
gn - Guarani
gom - Goan Konkani
gom-deva - Goan Konkani (Devanagari script)
gom-latn - Goan Konkani (Latin script)
got - Gothic
grc - Ancient Greek
gsw - Swiss German
gu - Gujarati
gv - Manx
ha - Hausa
hak - Hakka Chinese
haw - Hawaiian
he - Hebrew
hi - Hindi
hif - Fiji Hindi
hif-latn - Fiji Hindi (Latin script)
hil - Hiligaynon
ho - Hiri Motu
hr - Croatian
hrx - Hunsrik
hsb - Upper Sorbian
ht - Haitian Creole
hu - Hungarian
hy - Armenian
hz - Herero
ia - Interlingua
id - Indonesian
ie - Interlingue
ig - Igbo
ii - Sichuan Yi
ik - Inupiaq
ike-cans - Eastern Canadian (Aboriginal syllabics)
ike-latn - Eastern Canadian (Latin script)
ilo - Iloko
inh - Ingush
io - Ido
is - Icelandic
it - Italian
iu - Inuktitut
ja - Japanese
jam - Jamaican Creole English
jbo - Lojban
jut - Jutish
jv - Javanese
ka - Georgian
kaa - Kara-Kalpak
kab - Kabyle
kbd - Kabardian
kbd-cyrl - Адыгэбзэ
kg - Kongo
khw - Khowar
ki - Kikuyu
kiu - Kirmanjki
kj - Kuanyama
kk - Kazakh
kk-arab - Kazakh (Arabic script)
kk-cn - Kazakh (China)
kk-cyrl - Kazakh (Cyrillic script)
kk-kz - Kazakh (Kazakhstan)
kk-latn - Kazakh (Latin script)
kk-tr - Kazakh (Turkey)
kl - Kalaallisut
km - Khmer
kn - Kannada
ko - Korean
ko-kp - 한국어 (조선)
koi - Komi-Permyak
kr - Kanuri
krc - Karachay-Balkar
kri - Krio
krj - Kinaray-a
ks - Kashmiri
ks-arab - Kashmiri (Arabic script)
ks-deva - Kashmiri (Devanagari script)
ksh - Colognian
ku - Kurdish
ku-arab - كوردي (عەرەبی)
ku-latn - Kurdish (Latin script)
kv - Komi
kw - Cornish
ky - Kyrgyz
la - Latin
lad - Ladino
lb - Luxembourgish
lbe - лакку
lez - Lezghian
lfn - Lingua Franca Nova
lg - Ganda
li - Limburgish
lij - Ligurian
liv - Livonian
lmo - Lombard
ln - Lingala
lo - Lao
loz - Lozi
lrc - Northern Luri
lt - Lithuanian
ltg - Latgalian
lus - Mizo
luz - Southern Luri
lv - Latvian
lzh - Literary Chinese
lzz - Laz
mai - Maithili
map-bms - Basa Banyumasan
mdf - Moksha
mg - Malagasy
mh - Marshallese
mhr - Eastern Mari
mi - Maori
min - Minangkabau
mk - Macedonian
ml - Malayalam
mn - Mongolian
mo - молдовеняскэ
mr - Marathi
mrj - Western Mari
ms - Malay
mt - Maltese
mus - Creek
mwl - Mirandese
my - Burmese
myv - Erzya
mzn - Mazanderani
na - Nauru
nah - Nāhuatl
nan - Min Nan Chinese
nap - Neapolitan
nb - Norwegian Bokmål
nds - Low German
nds-nl - Low Saxon
ne - Nepali
new - Newari
ng - Ndonga
niu - Niuean
nl - Dutch
nl-informal - Nederlands (informeel)
nn - Norwegian Nynorsk
nov - Novial
nrm - Nouormand
nso - Northern Sotho
nv - Navajo
ny - Nyanja
oc - Occitan
olo - Livvi-Karelian
om - Oromo
or - Oriya
os - Ossetic
pa - Punjabi
pag - Pangasinan
pam - Pampanga
pap - Papiamento
pcd - Picard
pdc - Pennsylvania German
pdt - Plautdietsch
pfl - Palatine German
pi - Pali
pih - Norfuk / Pitkern
pl - Polish
pms - Piedmontese
pnb - Western Punjabi
pnt - Pontic
prg - Prussian
ps - Pashto
pt - Portuguese
pt-br - Brazilian Portuguese
qu - Quechua
qug - Chimborazo Highland Quichua
rgn - Romagnol
rif - Riffian
rm - Romansh
rmy - Romani
rn - Rundi
ro - Romanian
roa-tara - tarandíne
ru - Russian
rue - Rusyn
rup - Aromanian
ruq - Megleno-Romanian
ruq-cyrl - Megleno-Romanian (Cyrillic script)
ruq-latn - Megleno-Romanian (Latin script)
rw - Kinyarwanda
sa - Sanskrit
sah - Sakha
sat - Santali
sc - Sardinian
scn - Sicilian
sco - Scots
sd - Sindhi
sdc - Sassarese Sardinian
sdh - Southern Kurdish
se - Northern Sami
sei - Seri
ses - Koyraboro Senni
sg - Sango
sgs - Samogitian
sh - Serbo-Croatian
shi - Tachelhit
shi-latn - Tašlḥiyt
shi-tfng - ⵜⴰⵛⵍⵃⵉⵜ
si - Sinhala
sk - Slovak
sl - Slovenian
sli - Lower Silesian
sm - Samoan
sma - Southern Sami
sn - Shona
so - Somali
sq - Albanian
sr - Serbian
sr-ec - Serbian (Cyrillic script)
sr-el - Serbian (Latin script)
srn - Sranan Tongo
ss - Swati
st - Southern Sotho
stq - Saterland Frisian
su - Sundanese
sv - Swedish
sw - Swahili
szl - Silesian
ta - Tamil
tcy - Tulu
te - Telugu
tet - Tetum
tg - Tajik
tg-cyrl - Tajik (Cyrillic script)
tg-latn - Tajik (Latin script)
th - Thai
ti - Tigrinya
tk - Turkmen
tl - Tagalog
tly - Talysh
tn - Tswana
to - Tongan
tokipona - Toki Pona
tpi - Tok Pisin
tr - Turkish
tru - Turoyo
ts - Tsonga
tt - Tatar
tt-cyrl - Tatar (Cyrillic script)
tt-latn - Tatar (Latin script)
tum - Tumbuka
tw - Twi
ty - Tahitian
tyv - Tuvinian
tzm - Central Atlas Tamazight
udm - Udmurt
ug - Uyghur
ug-arab - Uyghur (Arabic script)
ug-latn - Uyghur (Latin script)
uk - Ukrainian
ur - Urdu
uz - Uzbek
uz-cyrl - ўзбекча
uz-latn - oʻzbekcha
ve - Venda
vec - Venetian
vep - Veps
vi - Vietnamese
vls - West Flemish
vmf - Main-Franconian
vo - Volapük
vot - Votic
vro - Võro
wa - Walloon
war - Waray
wo - Wolof
wuu - Wu Chinese
xal - Kalmyk
xh - Xhosa
xmf - Mingrelian
yi - Yiddish
yo - Yoruba
yue - Cantonese
za - Zhuang
zea - Zeelandic
zh - Chinese
zh-cn - Chinese (China)
zh-hans - Simplified Chinese
zh-hant - Traditional Chinese
zh-hk - Chinese (Hong Kong)
zh-mo - 中文(澳門)
zh-my - 中文(马来西亚)
zh-sg - Chinese (Singapore)
zh-tw - Chinese (Taiwan)
zu - Zulu
qqq - Message documentation
Format
Export for off-line translation
Export in native format
{{DISPLAYTITLE:Документація/Як/Створити модуль}}<languages/> {{Info| * '''Автор:''' [[User:RomanSavochenko|Роман Савоченко]] * '''Спонсорування, повної ревізії на 1.8 {{CtxDetails|ЛД|людино-днів, 1ЛД — 10 годин}}:''' SINGE SOFTWARE * '''Початково створено:''' у [http://wiki.oscada.org/HomePageUk/Doc/ModuleBuild старій Wiki] }} Цей посібник покликано допомогти у створені модулів для OpenSCADA. Створення модуля може знадобитися у випадку бажання додати підтримку нового джерела даних або іншого розширення до OpenSCADA. Оскільки OpenSCADA є гранично модульною то всі інтерфейси взаємодії із зовнішнім середовищем здійснюється за посередництвом розширення модулями типів: * бази даних; * комунікаційні інтерфейси, транспорти; * протоколи комунікаційних інтерфейсів; * джерела даних та збір даних; * архіви-історія (повідомлень та значень); * інтерфейси користувача (GUI, TUI, WebGUI, speach, signal ...); * додаткові модулі, спеціальні. [[File:at.png]] Для створення модулів до OpenSCADA необхідні знання програмування на мові C/C++, складальної системи [http://en.wikipedia.org/wiki/GNU_build_system AutoTools], а також базові знання ОС Linux та використовуваного дистрибутиву Linux. Для подальшого розміщення розробленого модуля до [http://oscada.org/websvn/listing.php?repname=OpenSCADA репозиторію дерева вихідних текстів OpenSCADA] ви маєте виконати наступне та дотримуватися наступних вимог: * бути правовласником або автором коду цього модуля та розповсюджувати його за вільною ліцензією, віддаючи перевагу GPL; * приготувати та зберігати код модуля як архів окремої теки модуля будь якої з підсистем OpenSCADA із вимогам до вмісту: ** вихідні тексти модуля на початку кожного файлу мають включати коректну інформацію прав копіювання, бути написаними та відформатованими згідно до якоїсь системи де перевагу треба надавати [[Special:MyLanguage/Documents/API#CodeDesign|стилю форматуванню основних модулів OpenSCADA]]; ** файли локалізації модулів також мають бути коректними, актуальними та відповідно відформатованими. * написати коротку інформаційну сторінку модуля для розташування її на [[Special:MyLanguage/Modules|OpenSCADA Wiki]] таким-же чином, як і інші модулів поряд; * для розташування цього модуля написати прямий запит у темі форуму "[http://oscada.org/ua/forum/topics/rozrobka_openscada/ Розробка OpenSCADA]", включаючи доказ працездатності від розробника OpenSCADA або коротке демонстраційним відео. == Створення Нового Модуля == Модулі в OpenSCADA представляють із себе поділювані бібліотеки, які підключаються до ядра OpenSCADA динамічно при запуску або під час функціювання програми. Багато модулів у процесі функціювання можуть бути відключені, підключені та оновлені із [[Special:MyLanguage/Documents/Program_manual#CfgModSched|менеджера модулів]]. Модулі також можуть бути вбудовані-включені до ядра OpenSCADA під час складання за посередництвом аргументу '''--enable-{ModName}=incl''' до скрипту конфігурації '''configure''', про що можна дізнатися із [[Special:MyLanguage/Documents/How_to/Build_from_source|посібника по збірці]]. Модулі OpenSCADA можуть бути семи типів згідно присутнім [[Special:MyLanguage/Documents/Program_manual#Modularity|модульним підсистемам]]. Наразі модулі до OpenSCADA пишуться на мові програмування "'''C++'''", хоча у подальшому можлива поява біндінгів на інші мови. У дереві вихідних текстів, у гілці кожної підсистеми, для спрощення створення нових модулів передбачено теку "=Tmpl=" із шаблоном модуля відповідної підсистеми. Розробник нового модуля може взяти цю теку та скопіювати її з ім'ям свого нового модуля, хоча він також завжди може використати у якості зразка будь який реальний функціонуючий модуль якщо його новий близький за структурою. Передбачено можливість створення модулів у дереві вихідних текстів проєкту OpenSCADA або як незалежного проєкту зовнішнього модуля до OpenSCADA. === Створення у дереві вихідних текстів проєкту OpenSCADA === Створювати нові модулі у дереві вихідних текстів проєкту OpenSCADA має сенс у випадку подальших планів передачі нового модуля проєкту OpenSCADA. Оскільки модуль не має суперечити духу відкритого проєкту та ліцензії на основі якої [http://oscada.org/ua/golovna/pro-proekt/licenziji/ розробляється та розповсюджується OpenSCADA] то ліцензією нового модуля вочевидь має бути одна із вільних ліцензій. Процедура створення нового модуля з включенням до дерева вихідних текстів на основі шаблону в цілому є простішою за процедуру для зовнішнього модуля та включає в себе кроки: :1. Отримати дерево вихідних текстів проєкту OpenSCADA для: :* ''Робочої (Work) гілки:'' :: {{InLineCode|<nowiki>svn co svn://oscada.org/trunk/OpenSCADA</nowiki>}} :* ''гілки стабільного релізу — НЕБАЖАНО, оскільки до стабільних LTS релізів приймаються лише виправлення та ця інструкція потребує версії 0.9 або вище:'' :: {{InLineCode|<nowiki>svn co svn://oscada.org/tags/openscada_0.9</nowiki>}} :2. Скопіювати теку шаблону з назвою нового модуля "NewMod", наприклад, для підсистеми "БД": :: {{InLineCode|<nowiki>cd OpenSCADA/src/moduls/bd; cp -r =Tmpl= NewMod; cd NewMod; rm -f configure.ac</nowiki>}} ::: ''для підсистеми "Збір Даних" шлях наступний'' — "OpenSCADA/src/moduls/'''daq'''" ::: ''для підсистеми "Архіви-Історія" шлях наступний'' — "OpenSCADA/src/moduls/'''arhiv'''" ::: ''для підсистеми "Транспорти" шлях наступний'' — "OpenSCADA/src/moduls/'''transport'''" ::: ''для підсистеми "Транспортні Протоколи" шлях наступний'' — "OpenSCADA/src/moduls/'''protocol'''" ::: ''для підсистеми "Користувацькі Інтерфейси" шлях наступний'' — "OpenSCADA/src/moduls/'''ui'''" ::: ''для підсистеми "Спеціальні" шлях наступний'' — "OpenSCADA/src/moduls/'''special'''" :3. Редагувати файл "module.cpp" щодо: ::: ''також може здійснюватися автоматично за допомогою:'' {{InLineCode|<nowiki>sed -i "s/Tmpl/NewMod/g" *.{cpp,h}</nowiki>}} :* ''зміни назви функцій вбудування-включення модуля згідно назви нового модуля'': :: "TModule::SAt '''bd_Tmpl_module'''( int n_mod )" —> "TModule::SAt '''bd_NewMod_module'''( int n_mod )" :: "TModule *'''bd_Tmpl_attach'''( const TModule::SAt &AtMod, const string &source )" —> "TModule *'''bd_NewMod_attach'''( const TModule::SAt &AtMod, const string &source )" :* ''інформації про модуль у файлі "module.cpp", а саме ділянка:'' <syntaxhighlight lang="CPP" style="margin-left: 45px"> //************************************************ //* Modul info! * #define MOD_ID "NewMod" #define MOD_NAME _("DB NewMod") #define MOD_TYPE SDB_ID #define VER_TYPE SDB_VER #define MOD_VER "0.0.1" #define AUTHORS _("MyName MyFamily") #define DESCRIPTION _("BD NewMod description.") #define MOD_LICENSE "GPL2" </syntaxhighlight> :4. Відредагувати конфігурацію складання модуля у файлі "Makefile.am" щодо: ::: ''також може здійснюватися автоматично за допомогою:'' {{InLineCode|<nowiki>sed -i "s/Tmpl/NewMod/g" Makefile.am</nowiki>}} <pre style="white-space: pre-wrap; margin-left: 30px"> EXTRA_DIST = *.h po/* if NewModIncl noinst_LTLIBRARIES = db_NewMod.la db_NewMod_la_CXXFLAGS = -DMOD_INCL -fpic db_NewMod_la_LIBTOOLFLAGS = --tag=disable-shared db_NewMod_la_LDFLAGS = -module else oscd_modul_LTLIBRARIES = db_NewMod.la db_NewMod_la_CXXFLAGS = db_NewMod_la_LIBTOOLFLAGS = --tag=disable-static db_NewMod_la_LDFLAGS = -module -avoid-version $(top_builddir)/src/liboscada.la endif db_NewMod_la_CXXFLAGS += $(NewMod_CFLAGS) db_NewMod_la_LDFLAGS += $(NewMod_LDLAGS) db_NewMod_la_SOURCES = module.cpp I18N_mod = $(oscd_modulpref)NewMod include ../../../../I18N.mk </pre> :5. Додати запис нового модуля в кінець секції підсистеми конфігураційного файлу "OpenSCADA/configure.ac" складальної системи OpenSCADA: :* ''в кінець секції "DB modules" для підсистеми "БД":'' <pre style="white-space: pre-wrap; margin-left: 30px"> AX_MOD_DB_EN(NewMod, [disable or enable[=incl] compilation module DB.NewMod], disable, incl, [ # Код перевірки зовнішніх бібліотек модуля ]) </pre> :* ''в кінець секції "DAQ modules" для підсистеми "Збір Даних":'' <pre style="white-space: pre-wrap; margin-left: 30px"> AX_MOD_DAQ_EN(NewMod, [disable or enable[=incl] compilation module DAQ.NewMod], disable, incl, [ # Код перевірки зовнішніх бібліотек модуля ]) </pre> :* ''в кінець секції "Archive modules" для підсистеми "Архіви-Історія":'' <pre style="white-space: pre-wrap; margin-left: 30px"> AX_MOD_Archive_EN(NewMod, [disable or enable[=incl] compilation module Archive.NewMod], disable, incl, [ # Код перевірки зовнішніх бібліотек модуля ]) </pre> :* ''в кінець секції "Transport modules" для підсистеми "Транспорти":'' <pre style="white-space: pre-wrap; margin-left: 30px"> AX_MOD_Transport_EN(NewMod, [disable or enable[=incl] compilation module Transport.NewMod], disable, incl, [ # Код перевірки зовнішніх бібліотек модуля ]) </pre> :* ''в кінець секції "Transport protocol modules" для підсистеми "Транспортні Протоколи":'' <pre style="white-space: pre-wrap; margin-left: 30px"> AX_MOD_TrProt_EN(NewMod, [disable or enable[=incl] compilation module Protocol.NewMod], disable, incl, [ # Код перевірки зовнішніх бібліотек модуля ]) </pre> :* ''в кінець секції "UI modules" для підсистеми "Користувацькі Інтерфейси":'' <pre style="white-space: pre-wrap; margin-left: 30px"> AX_MOD_UI_EN(NewMod, [disable or enable[=incl] compilation module UI.NewMod], disable, incl, [ # Код перевірки зовнішніх бібліотек модуля ]) </pre> :* ''в кінець секції "Special modules" для підсистеми "Спеціальні":'' <pre style="white-space: pre-wrap; margin-left: 30px"> AX_MOD_Special_EN(NewMod, [disable or enable[=incl] compilation module Special.NewMod], disable, incl, [ # Код перевірки зовнішніх бібліотек модуля ]) </pre> :6. Тепер новий модуль можна скласти у складі OpenSCADA після переформування складальної системи: :: {{InLineCode|<nowiki>autoreconf -if; ./configure --enable-NewMod; make</nowiki>}} :7. Опублікувати — сформувати латку із вашим модулем та надіслати її розробникам OpenSCADA: :: {{InLineCode|<nowiki>cd OpenSCADA; make distclean; rm -rf src/moduls/bd/NewMod/{Makefile.in,.deps}</nowiki>}} :: {{InLineCode|<nowiki>svn add src/moduls/bd/NewMod; svn diff > NewMod.patch</nowiki>}} === Створення зовнішнього модуля до OpenSCADA === Створення зовнішнього модуля до OpenSCADA може мати сенс у випадку розробки інтерфейсу інтеграції з комерційними системами, які вимагають закриття коду взаємодії, а також у випадку інших реалізацій комерційних інтерфейсів при яких модуль до OpenSCADA отримує статус окремого проєкту, розповсюджується та підтримується незалежно, часто у вигляді бінарних збірок під конкретну платформу та версію OpenSCADA. Ліцензія таких модулів відповідно може бути будь якою. Процедура створення нового зовнішнього модуля на основі шаблону багато в чому схожа на попередню процедуру та включає в себе кроки: :1. Отримати вихідні текстів проєкту OpenSCADA — для зовнішнього модуля у якості джерела шаблону можна використати будь які файли OpenSCADA версії більш 0.9, оскільки із них потрібно скопіювати лише теку "=Tmpl=" та декілька файлів для збірки. :2. Скопіювати теку шаблону з ім'ям нового модуля "NewMod", наприклад, для підсистеми "БД"; та вже в ній створити та скопіювати потрібні файли зовнішнього модуля. В подальшому інформаційні файли проєкту "COPYING", "NEWS", "README", "AUTHORS" та "ChangeLog" потрібно заповнити згідно сутності нового модуля: :: {{InLineCode|<nowiki>cp -r OpenSCADA/src/moduls/bd/=Tmpl= NewMod; touch NewMod/{NEWS,README,AUTHORS,ChangeLog}; cp OpenSCADA/I18N.mk NewMod/</nowiki>}} ::: ''для підсистеми "Збір Даних" шлях наступний'' — "OpenSCADA/src/moduls/'''daq'''/=Tmpl=" ::: ''для підсистеми "Архіви-Історія" шлях наступний'' — "OpenSCADA/src/moduls/'''arhiv'''/=Tmpl=" ::: ''для підсистеми "Транспорти" шлях наступний'' — "OpenSCADA/src/moduls/'''transport'''/=Tmpl=" ::: ''для підсистеми "Транспортні Протоколи" шлях наступний'' — "OpenSCADA/src/moduls/'''protocol'''/=Tmpl=" ::: ''для підсистеми "Користувацькі Інтерфейси" шлях наступний'' — "OpenSCADA/src/moduls/'''ui'''/=Tmpl=" ::: ''для підсистеми "Спеціальні" шлях наступний'' — "OpenSCADA/src/moduls/'''special'''/=Tmpl=" :3. Відредагувати інформацію модуля у файлі "module.cpp" аналогічно цьому пункту попереднього розділу. :4. Відредагувати конфігурацію збірки модуля у файлі "Makefile.am" аналогічно цьому пункту попереднього розділу, окрім: :* замість "db_NewMod_la_LDFLAGS = -module -avoid-version '''$(top_builddir)/src/liboscada.la'''" записати "db_NewMod_la_LDFLAGS = -module -avoid-version", тобто видалити "$(top_builddir)/src/liboscada.la" :* замість "include '''../../../../'''I18N.mk" записати "include I18N.mk", тобто видалити шлях "../../../../" :5. Відредагувати файл конфігурації складальної системи "configure.ac" щодо: ::: ''також може здійснюватися автоматично за допомогою:'' {{InLineCode|<nowiki>sed -i "s/Tmpl/NewMod/g" configure.ac</nowiki>}} :* "AC_INIT(['''Tmpl'''],['''0.0.1'''],['''my@email.org'''])" — інформація про модуль: ім'я, версія та Ел.Пошта проєкту :* "AM_CONDITIONAL(['''TmplIncl'''],[test])" — "AM_CONDITIONAL(['''NewModIncl'''],[test])" :6. Встановити пакет розробки OpenSCADA "openscada-dev" або "openscada-devel" — у зв'язку з тим, що модуль зовнішній та вихідні файли OpenSCADA потрібні лише на першому етапі його створення, то необхідно встановлювати пакет розробки OpenSCADA, який містить заголовні файли та бібліотеки. :7. Тепер новий модуль можна скласти, після формування складальної системи: :: {{InLineCode|<nowiki>autoreconf -if; ./configure; make</nowiki>}} == API модуля == API OpenSCADA для розробника OpenSCADA та модулів до неї описано у відповідному документі "[[Special:MyLanguage/Documents/API|API OpenSCADA]]", який завжди має бути під рукою при розробці для OpenSCADA. В цьому ж документі наголос здійснено на детальному роз'яснені основних моментів модульного API. {{#lst:Documents/API/uk|ModAPI}} Для зручності прямої адресації до кореневого об'єкта модуля із будь якого об'єкта нижче за ієрархією, рекомендується визначити глобальну змінну "mod" у області імен модуля, з ініціалізацією її у конструкторі кореневого об'єкта. Також, для прозорого перекладу текстових повідомлень модуля рекомендується визначити шаблони функцій виклику перекладу повідомлень модуля "'''_({Повідомлення})'''" та "'''trS({Повідомлення})'''" як: <syntaxhighlight lang="CPP"> #undef _ #define _(mess) mod->I18N(mess).c_str() #undef trS #define trS(mess) mod->I18N(mess,mess_PreSave) </syntaxhighlight> У конструкторі кореневого об'єкту модуля успадкованого від '''TModule''' необхідно встановити основну інформацію модуля викликом функції '''void modInfoMainSet({Ім'я}, {Тип}, {Версія}, {Автори}, {Опис}, {Ліцензія}, {Джерело})''' після ініціалізації швидкого посилання "mod" на кореневий об'єкт цього модуля. Подальше отримання файлу шаблону перекладів "po/oscd_NewMod.pot" текстових повідомлень "'''_({Повідомлення})'''" та "'''trS({Повідомлення})'''", а також оновлення-актуалізація файлів вже існуючих перекладів "po/{uk|de|ru|...}.po" здійснюється командою у теці модуля {{InLineCode|make messages}}. При вирішенні завдань нового модуля може знадобитися розширення параметрів конфігурації, що здійснюється у віртуальній функції '''void cntrCmdProc( XMLNode *req );'''. Вміст цієї функції, який додає властивості, у [[Special:MyLanguage/Modules/SQLite|модулі SQLite]] має вигляд: <syntaxhighlight lang="CPP"> void MBD::cntrCmdProc( XMLNode *opt ) { //Getting the page info if(opt->name() == "info") { TBD::cntrCmdProc(opt); ctrMkNode("fld",opt,-1,"/prm/cfg/ADDR",EVAL_STR,enableStat()?R_R___:RWRW__,"root",SDB_ID,3, "dest","sel_ed","select","/prm/cfg/dbFsList","help", _("SQLite DB address must be written as: \"{FileDBPath}\".\n" "Where:\n" " FileDBPath - full path to DB file (./oscada/Main.db).\n" " Use the empty path to create a temporary database on the disk.\n" " Use \":memory:\" to create a temporary database in memory.")); if(reqCnt) ctrMkNode("comm",opt,-1,"/prm/st/end_tr",_("Close opened transaction"),RWRW__,"root",SDB_ID); } //Processing for commands to the page string a_path = opt->attr("path"); if(a_path == "/prm/cfg/dbFsList" && ctrChkNode(opt)) { opt->childAdd("el")->setText(":memory:"); TSYS::ctrListFS(opt, addr(), "db;"); } else if(a_path == "/prm/st/end_tr" && ctrChkNode(opt,"set",RWRW__,"root",SDB_ID,SEC_WR) && reqCnt) transCommit(); else TBD::cntrCmdProc(opt); } </syntaxhighlight> Перша половина цієї функції обслуговує інформаційні запити "info" з переліком та властивостями полів конфігурації. Друга половина обслуговує решту команд на отримання, встановлення значення та інше. Виклик '''TBD::cntrCmdProc(opt);''' використовується для отримання успадкованого інтерфейсу. Детальніше про призначення використаних функцій дивіться у [[Special:MyLanguage/Documents/API#CntrNode|інтерфейсі управління]], а також у вихідних текстах існуючих модулів. Об'єкт '''TCntrNode''' окрім функції інтерфейсу управління надає уніфіковані механізми контролю за модифікацією конфігурації об'єкта, завантаження, збереження та видалення дублікатів конфігурації у сховищі. Для встановлення прапорця модифікації даних об'єкта можна використовувати функції '''modif()''' та '''modifG()''', а специфічні до модуля дії із завантаження та збереження можна розташовувати у віртуальні функції: * ''void load_( TConfig *cfg );'', ''void load_( );'' — завантаження об'єкта зі сховища. * ''void save_( );'' — збереження об'єкта у сховищі. Дії із конфігурацією типово відбуваються за посередництвом об'єкта [[Special:MyLanguage/Documents/API#TConfig|TConfig]], яких містить набір визначених властивостей зі структурою та значеннями. Для прямого відображення властивостей об'єкта модуля він успадковується від '''TConfig''', а нові властивості додаються командою: <syntaxhighlight lang="CPP"> fldAdd(new TFld("MOD_PRMS",trS("Module addition parameters"),TFld::String,TFld::FullText|TCfg::NoVal,"100000"));</syntaxhighlight> Завантаження/збереження/видалення властивостей, вказаних у об'єкті ''TConfig'', із/у/в сховище здійснюється командами: <syntaxhighlight lang="CPP"> TBDS::dataGet(fullDB(), owner().nodePath()+tbl(), *this); TBDS::dataSet(fullDB(), owner().nodePath()+tbl(), *this); TBDS::dataDel(fullDB(flag&NodeRemoveOnlyStor), owner().nodePath()+tbl(), *this, TBDS::UseAllKeys); </syntaxhighlight> Де: * ''fullDB()'' — повна назва сховища у [[Special:MyLanguage/Documents/API#DataConcept|загальній формі]]; * ''owner().nodePath()+tbl()'' — загальний шлях до вузла об'єкта у конфігураційному файлі, представлений таблицею; * ''*this'' — цей об'єкт, успадкований від '''TConfig'''. Для генерації налагоджувальних повідомлень [[Special:MyLanguage/Documents/Program_manual#Config|відповідно до загальної концепції налаштувань]] необхідно використовувати функцію '''mess_debug()''' з умовою виклику залежно від ділянки вихідного тексту програми: * рідко викликувана ділянка — прямий виклик функції {{InLineCode|<nowiki>mess_debug(...);</nowiki>}}; * часто викликувана ділянка — умовний виклик {{InLineCode|<nowiki>if(mess_lev() == TMess::Debug) mess_debug(...);</nowiki>}}; * критична до продуктивності ділянка коду — обгортання у визначення '''OSC_DEBUG''': <syntaxhighlight lang="CPP"> #ifdef OSC_DEBUG mess_debug(...); #endif </syntaxhighlight>
Navigation menu
OpenSCADA
Site
Download
Old Wiki
OpenSCADA Wiki
Home
About OpenSCADA
Functions and demands
Tasks
Using
Fund
Recent changes
Random page
Search
Tools
Special pages
Printable version
MediaWiki
Help
Personal tools
English
Log in