33< head >
44 < meta charset ="utf-8 ">
55 < meta name ="viewport " content ="width=device-width, initial-scale=1 ">
6- < meta name ="generator " content ="pdoc 13 .0.1 "/>
6+ < meta name ="generator " content ="pdoc 14 .0.0 "/>
77 < title > kepconfig API documentation</ title >
88
99 < style > /*! * Bootstrap Reboot v5.0.0 (https://getbootstrap.com/) * Copyright 2011-2021 The Bootstrap Authors * Copyright 2011-2021 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/main/LICENSE) * Forked from Normalize.css, licensed MIT (https://github.com/necolas/normalize.css/blob/master/LICENSE.md) */ * , ::after , ::before {box-sizing : border-box}@media (prefers-reduced-motion : no-preference){: root {scroll-behavior : smooth}}body {margin : 0 ;font-family : system-ui, -apple-system, "Segoe UI" , Roboto, "Helvetica Neue" , Arial, "Noto Sans" , "Liberation Sans" , sans-serif, "Apple Color Emoji" , "Segoe UI Emoji" , "Segoe UI Symbol" , "Noto Color Emoji" ;font-size : 1rem ;font-weight : 400 ;line-height : 1.5 ;color : # 212529background-color : # fff-webkit-text-size-adjust : 100% ;-webkit-tap-highlight-color : transparent}hr {margin : 1rem 0 ;color : inherit;background-color : currentColor;border : 0 ;opacity : .25 }hr : not ([size ]){height : 1px }h1 , h2 , h3 , h4 , h5 , h6 {margin-top : 0 ;margin-bottom : .5rem ;font-weight : 500 ;line-height : 1.2 }h1 {font-size : calc (1.375rem + 1.5vw )}@media (min-width : 1200px ){h1 {font-size : 2.5rem }}h2 {font-size : calc (1.325rem + .9vw )}@media (min-width : 1200px ){h2 {font-size : 2rem }}h3 {font-size : calc (1.3rem + .6vw )}@media (min-width : 1200px ){h3 {font-size : 1.75rem }}h4 {font-size : calc (1.275rem + .3vw )}@media (min-width : 1200px ){h4 {font-size : 1.5rem }}h5 {font-size : 1.25rem }h6 {font-size : 1rem }p {margin-top : 0 ;margin-bottom : 1rem }abbr [data-bs-original-title ], abbr [title ]{-webkit-text-decoration : underline dotted;text-decoration : underline dotted;cursor : help;-webkit-text-decoration-skip-ink : none;text-decoration-skip-ink : none}address {margin-bottom : 1rem ;font-style : normal;line-height : inherit}ol , ul {padding-left : 2rem }dl , ol , ul {margin-top : 0 ;margin-bottom : 1rem }ol ol , ol ul , ul ol , ul ul {margin-bottom : 0 }dt {font-weight : 700 }dd {margin-bottom : .5rem ;margin-left : 0 }blockquote {margin : 0 0 1rem }b , strong {font-weight : bolder}small {font-size : .875em }mark {padding : .2em ;background-color : # fcf8e3sub , sup {position : relative;font-size : .75em ;line-height : 0 ;vertical-align : baseline}sub {bottom : -.25em }sup {top : -.5em }a {color : # 0d6efdtext-decoration : underline}a : hover {color : # 0a58caa : not ([href ]): not ([class ]), a : not ([href ]): not ([class ]): hover {color : inherit;text-decoration : none}code , kbd , pre , samp {font-family : SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono" , "Courier New" , monospace;font-size : 1em ;direction : ltr;unicode-bidi : bidi-override}pre {display : block;margin-top : 0 ;margin-bottom : 1rem ;overflow : auto;font-size : .875em }pre code {font-size : inherit;color : inherit;word-break : normal}code {font-size : .875em ;color : # d63384word-wrap : break-word}a > code {color : inherit}kbd {padding : .2rem .4rem ;font-size : .875em ;color : # fffbackground-color : # 212529border-radius : .2rem }kbd kbd {padding : 0 ;font-size : 1em ;font-weight : 700 }figure {margin : 0 0 1rem }img , svg {vertical-align : middle}table {caption-side : bottom;border-collapse : collapse}caption {padding-top : .5rem ;padding-bottom : .5rem ;color : # 6c757dtext-align : left}th {text-align : inherit;text-align : -webkit-match-parent}tbody , td , tfoot , th , thead , tr {border-color : inherit;border-style : solid;border-width : 0 }label {display : inline-block}button {border-radius : 0 }button : focus : not (: focus-visible ){outline : 0 }button , input , optgroup , select , textarea {margin : 0 ;font-family : inherit;font-size : inherit;line-height : inherit}button , select {text-transform : none}[role = button ]{cursor : pointer}select {word-wrap : normal}select : disabled {opacity : 1 }[list ]::-webkit-calendar-picker-indicator {display : none}[type = button ], [type = reset ], [type = submit ], button {-webkit-appearance : button}[type = button ]: not (: disabled ), [type = reset ]: not (: disabled ), [type = submit ]: not (: disabled ), button : not (: disabled ){cursor : pointer}::-moz-focus-inner {padding : 0 ;border-style : none}textarea {resize : vertical}fieldset {min-width : 0 ;padding : 0 ;margin : 0 ;border : 0 }legend {float : left;width : 100% ;padding : 0 ;margin-bottom : .5rem ;font-size : calc (1.275rem + .3vw );line-height : inherit}@media (min-width : 1200px ){legend {font-size : 1.5rem }}legend + * clear : left}::-webkit-datetime-edit-day-field , ::-webkit-datetime-edit-fields-wrapper , ::-webkit-datetime-edit-hour-field , ::-webkit-datetime-edit-minute , ::-webkit-datetime-edit-month-field , ::-webkit-datetime-edit-text , ::-webkit-datetime-edit-year-field {padding : 0 }::-webkit-inner-spin-button {height : auto}[type = search ]{outline-offset : -2px ;-webkit-appearance : textfield}::-webkit-search-decoration {-webkit-appearance : none}::-webkit-color-swatch-wrapper {padding : 0 }::file-selector-button {font : inherit}::-webkit-file-upload-button {font : inherit;-webkit-appearance : button}output {display : inline-block}iframe {border : 0 }summary {display : list-item;cursor : pointer}progress {vertical-align : baseline}[hidden ]{display : none!important }</ style >
@@ -44,6 +44,7 @@ <h2>Submodules</h2>
4444 < li > < a href ="kepconfig/error.html "> error</ a > </ li >
4545 < li > < a href ="kepconfig/iot_gateway.html "> iot_gateway</ a > </ li >
4646 < li > < a href ="kepconfig/structures.html "> structures</ a > </ li >
47+ < li > < a href ="kepconfig/ua_gateway.html "> ua_gateway</ a > </ li >
4748 < li > < a href ="kepconfig/utils.html "> utils</ a > </ li >
4849 </ ul >
4950
@@ -83,7 +84,7 @@ <h2 id="features">Features</h2>
8384< li > Supports both HTTP and HTTPS connections with certificate validation options</ li >
8485</ ul >
8586
86- < p > SDK allows for < em > GET</ em > , < em > ADD</ em > , < em > DELETE</ em > , and < em > MODIFY</ em > functions for the following Kepware configuration objects:</ p >
87+ < p > Package allows for < em > GET</ em > , < em > ADD</ em > , < em > DELETE</ em > , and < em > MODIFY</ em > functions for the following Kepware configuration objects:</ p >
8788
8889< table >
8990< thead >
@@ -114,6 +115,11 @@ <h2 id="features">Features</h2>
114115 < td style ="text-align:center; "> Y</ td >
115116 < td style ="text-align:center; "> Y</ td >
116117</ tr >
118+ < tr >
119+ < td style ="text-align:center; "> < strong > UA Gateway</ strong > < br /> < em > (Certificates, Server Endpoints, Client Connectins)</ em > </ td >
120+ < td style ="text-align:center; "> Y< em > *</ em > </ td >
121+ < td style ="text-align:center; "> N</ td >
122+ </ tr >
117123< tr >
118124 < td style ="text-align:center; "> < strong > Administration</ strong > < br /> < em > (User Groups, Users, UA Endpoints, Local License Server)</ em > </ td >
119125 < td style ="text-align:center; "> Y*</ td >
@@ -130,6 +136,7 @@ <h2 id="features">Features</h2>
130136< ul >
131137< li > Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only</ li >
132138< li > Note (**) - Added to Kepware Server v6.13 / Kepware Edge v1.5 and later builds</ li >
139+ < li > Note (< em > *</ em > ) - TKS only</ li >
133140</ ul >
134141
135142< p > Driver specific features:</ p >
@@ -189,7 +196,7 @@ <h2 id="features">Features</h2>
189196</ thead >
190197< tbody >
191198< tr >
192- < td style ="text-align:center; "> < strong > TagGeneration</ strong > < br /> < em > (for supported drivers)</ em > </ td >
199+ < td style ="text-align:center; "> < strong > TagGeneration</ strong > < br /> < em > (for supported drivers)</ em > </ td >
193200 < td style ="text-align:center; "> Y</ td >
194201 < td style ="text-align:center; "> Y</ td >
195202</ tr >
@@ -234,7 +241,7 @@ <h2 id="key-concepts">Key Concepts</h2>
234241< h3 id ="create-server-connection "> Create server connection</ h3 >
235242
236243< div class ="pdoc-code codehilite ">
237- < pre > < span > </ span > < code > < span class ="kn "> import </ span > < span class ="nn "> < a href =" kepconfig/connection.html " > kepconfig.connection </ a > </ span >
244+ < pre > < span > </ span > < code > < span class ="kn "> from </ span > < span class ="nn "> kepconfig </ span > < span class =" kn " > import </ span > < span class =" n " > connection </ span >
238245
239246< span class ="n "> server</ span > < span class ="o "> =</ span > < span class ="n "> connection</ span > < span class ="o "> .</ span > < span class ="n "> server</ span > < span class ="p "> (</ span > < span class ="n "> host</ span > < span class ="o "> =</ span > < span class ="s1 "> '127.0.0.1'</ span > < span class ="p "> ,</ span > < span class ="n "> port</ span > < span class ="o "> =</ span > < span class ="mi "> 57412</ span > < span class ="p "> ,</ span > < span class ="n "> user</ span > < span class ="o "> =</ span > < span class ="s1 "> 'Administrator'</ span > < span class ="p "> ,</ span > < span class ="n "> pw</ span > < span class ="o "> =</ span > < span class ="s1 "> ''</ span > < span class ="p "> )</ span >
240247
@@ -283,7 +290,7 @@ <h3 id="ex-add-multiple-tags">Ex: Add Multiple tags</h3>
283290 < span class ="p "> }</ span >
284291< span class ="p "> ]</ span >
285292< span class ="n "> tag_path</ span > < span class ="o "> =</ span > < span class ="s1 "> '</ span > < span class ="si "> {}</ span > < span class ="s1 "> .</ span > < span class ="si "> {}</ span > < span class ="s1 "> .</ span > < span class ="si "> {}</ span > < span class ="s1 "> '</ span > < span class ="o "> .</ span > < span class ="n "> format</ span > < span class ="p "> (</ span > < span class ="n "> ch_name</ span > < span class ="p "> ,</ span > < span class ="n "> dev_name</ span > < span class ="p "> ,</ span > < span class ="n "> tag_group_path</ span > < span class ="p "> )</ span >
286- < span class ="n "> result</ span > < span class ="o "> =</ span > < span class ="n "> tag</ span > < span class ="o "> .</ span > < span class ="n "> add_tag</ span > < span class ="p "> (</ span > < span class ="n "> server</ span > < span class ="p "> ,</ span > < span class ="n "> tag_path</ span > < span class ="p "> ,</ span > < span class ="n "> tag_info</ span > < span class ="p "> )) </ span >
293+ < span class ="n "> result</ span > < span class ="o "> =</ span > < span class ="n "> tag</ span > < span class ="o "> .</ span > < span class ="n "> add_tag</ span > < span class ="p "> (</ span > < span class ="n "> server</ span > < span class ="p "> ,</ span > < span class ="n "> tag_path</ span > < span class ="p "> ,</ span > < span class ="n "> tag_info</ span > < span class ="p "> )</ span >
287294</ code > </ pre >
288295</ div >
289296
@@ -321,7 +328,7 @@ <h2 id="need-more-information">Need More Information</h2>
321328</ span > < span id ="L-18 "> < a href ="#L-18 "> < span class ="linenos "> 18</ span > </ a > < span class ="sd "> .. include:: ../README.md</ span >
322329</ span > < span id ="L-19 "> < a href ="#L-19 "> < span class ="linenos "> 19</ span > </ a >
323330</ span > < span id ="L-20 "> < a href ="#L-20 "> < span class ="linenos "> 20</ span > </ a > < span class ="sd "> """</ span >
324- </ span > < span id ="L-21 "> < a href ="#L-21 "> < span class ="linenos "> 21</ span > </ a > < span class ="n "> __version__</ span > < span class ="o "> =</ span > < span class ="s2 "> "1.2.0 "</ span >
331+ </ span > < span id ="L-21 "> < a href ="#L-21 "> < span class ="linenos "> 21</ span > </ a > < span class ="n "> __version__</ span > < span class ="o "> =</ span > < span class ="s2 "> "1.3.0b "</ span >
325332</ span > < span id ="L-22 "> < a href ="#L-22 "> < span class ="linenos "> 22</ span > </ a > < span class ="kn "> from</ span > < span class ="nn "> .</ span > < span class ="kn "> import</ span > < span class ="n "> connection</ span > < span class ="p "> ,</ span > < span class ="n "> error</ span >
326333</ span > </ pre > </ div >
327334
0 commit comments