Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,17 @@ Package allows for *GET*, *ADD*, *DELETE*, and *MODIFY* functions for the follow
| **IoT Gateway** <br /> *(Agents, IoT Items)* | Y | Y |
| **Datalogger** <br /> *(Log Groups, Items, Mapping, Triggers, Reset Mapping Service)* | Y | Y |
| **UA Gateway** <br /> *(Certificates, Server Endpoints, Client Connections, Server Interface parameters)* | Y*** | N |
| **Advanced Tags** <br /> *(All tag types and tag groups)*| Y****** | N |
| **Administration** <br /> *(User Groups, Users, UA Endpoints, Local License Server)* | Y* | Y |
| **Product Info and Health Status\*\*** | Y | Y |
| **Import Project (via JsonProjectLoad Service) / Export Project\*\*\*\***| Y | Y |
| **Backup Project (via CreateBackup Service) / Export Project\*\*\*\*\***| Y | Y |

- Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only
- Note (**) - Added to Kepware Server v6.13 / Kepware Edge v1.5 and later builds
- Note (*) - UA Endpoints and Local License Server supported for TKE only
- Note (**) - Added to Kepware Server v6.13 / TKE v1.5 and later builds
- Note (***) - TKS only v6.16 and later
- Note (****) - Added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds
- Note (****) - Added to Kepware Server v6.17 / TKE v1.10 and later builds
- Note (*****) - Added to Kepware Server v6.18 / TKE v1.11 and later builds

Driver specific features:

Expand All @@ -45,6 +48,9 @@ Methods to read the following logs:
| :----------: | :----------: | :----------: |
| **Event Log** | Y | Y |
| **API Transaction Log** | Y | Y |
| **Audit Log*** | Y | Y |

- Note (*) - Implemented for Kepware Server v6.18+ and TKE 1.11+

Configuration API *Services* implemented:

Expand All @@ -54,10 +60,11 @@ Configuration API *Services* implemented:
| **ReinitializeRuntime** | Y* | Y |
| **ProjectLoad and ProjectSave**| Y | Y |
| **JsonProjectLoad\*\*** <br /> *(used for import project feature)*| Y | Y |
| **CreateBackup\*\*\***| Y | Y |

Note (*) - Reinitialize service was implemented for Kepware Server v6.8+

Note (**) - Added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds
- Note (*) - Reinitialize service was implemented for Kepware Server v6.8+
- Note (**) - Added to Kepware Server v6.17 / TKE v1.10 and later builds
- Note (***) - Added to Kepware Server v6.18 / TKE v1.11 and later builds

Filtering, sorting and pagination query options are added for any collections methods (ex: `get_all_devices()` or `get_all_channel()`).

Expand Down
42 changes: 35 additions & 7 deletions docs/kepconfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="pdoc 14.0.0"/>
<meta name="generator" content="pdoc 13.1.0"/>
<title>kepconfig API documentation</title>

<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:#212529;background-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:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a: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:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-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:#6c757d;text-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>
Expand Down Expand Up @@ -38,6 +38,7 @@ <h2>Contents</h2>
<h2>Submodules</h2>
<ul>
<li><a href="kepconfig/admin.html">admin</a></li>
<li><a href="kepconfig/adv_tags.html">adv_tags</a></li>
<li><a href="kepconfig/connection.html">connection</a></li>
<li><a href="kepconfig/connectivity.html">connectivity</a></li>
<li><a href="kepconfig/datalogger.html">datalogger</a></li>
Expand Down Expand Up @@ -120,6 +121,11 @@ <h2 id="features">Features</h2>
<td style="text-align:center;">Y<em>*</em></td>
<td style="text-align:center;">N</td>
</tr>
<tr>
<td style="text-align:center;"><strong>Advanced Tags</strong> <br /> <em>(All tag types and tag groups)</em></td>
<td style="text-align:center;">Y<strong>**</strong></td>
<td style="text-align:center;">N</td>
</tr>
<tr>
<td style="text-align:center;"><strong>Administration</strong> <br /> <em>(User Groups, Users, UA Endpoints, Local License Server)</em></td>
<td style="text-align:center;">Y*</td>
Expand All @@ -135,14 +141,20 @@ <h2 id="features">Features</h2>
<td style="text-align:center;">Y</td>
<td style="text-align:center;">Y</td>
</tr>
<tr>
<td style="text-align:center;"><strong>Backup Project (via CreateBackup Service) / Export Project*****</strong></td>
<td style="text-align:center;">Y</td>
<td style="text-align:center;">Y</td>
</tr>
</tbody>
</table>

<ul>
<li>Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only</li>
<li>Note (**) - Added to Kepware Server v6.13 / Kepware Edge v1.5 and later builds</li>
<li>Note (*) - UA Endpoints and Local License Server supported for TKE only</li>
<li>Note (**) - Added to Kepware Server v6.13 / TKE v1.5 and later builds</li>
<li>Note (<em>*</em>) - TKS only v6.16 and later</li>
<li>Note (<em>*</em>*) - Added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds</li>
<li>Note (<em>*</em>*) - Added to Kepware Server v6.17 / TKE v1.10 and later builds</li>
<li>Note (<strong>*</strong>) - Added to Kepware Server v6.18 / TKE v1.11 and later builds</li>
</ul>

<p>Driver specific features:</p>
Expand Down Expand Up @@ -187,9 +199,18 @@ <h2 id="features">Features</h2>
<td style="text-align:center;">Y</td>
<td style="text-align:center;">Y</td>
</tr>
<tr>
<td style="text-align:center;"><strong>Audit Log*</strong></td>
<td style="text-align:center;">Y</td>
<td style="text-align:center;">Y</td>
</tr>
</tbody>
</table>

<ul>
<li>Note (*) - Implemented for Kepware Server v6.18+ and TKE 1.11+</li>
</ul>

<p>Configuration API <em>Services</em> implemented:</p>

<table>
Expand Down Expand Up @@ -221,12 +242,19 @@ <h2 id="features">Features</h2>
<td style="text-align:center;">Y</td>
<td style="text-align:center;">Y</td>
</tr>
<tr>
<td style="text-align:center;"><strong>CreateBackup***</strong></td>
<td style="text-align:center;">Y</td>
<td style="text-align:center;">Y</td>
</tr>
</tbody>
</table>

<p>Note (*) - Reinitialize service was implemented for Kepware Server v6.8+</p>

<p>Note (**) - Added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds</p>
<ul>
<li>Note (*) - Reinitialize service was implemented for Kepware Server v6.8+</li>
<li>Note (**) - Added to Kepware Server v6.17 / TKE v1.10 and later builds</li>
<li>Note (<em>*</em>) - Added to Kepware Server v6.18 / TKE v1.11 and later builds</li>
</ul>

<p>Filtering, sorting and pagination query options are added for any collections methods (ex: <code>get_all_devices()</code> or <code>get_all_channel()</code>).</p>

Expand Down
2 changes: 1 addition & 1 deletion docs/kepconfig/admin.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="pdoc 14.0.0"/>
<meta name="generator" content="pdoc 13.1.0"/>
<title>kepconfig.admin API documentation</title>

<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:#212529;background-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:#fcf8e3}sub,sup{position:relative;font-size:.75em;line-height:0;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}a{color:#0d6efd;text-decoration:underline}a:hover{color:#0a58ca}a: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:#d63384;word-wrap:break-word}a>code{color:inherit}kbd{padding:.2rem .4rem;font-size:.875em;color:#fff;background-color:#212529;border-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:#6c757d;text-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>
Expand Down
Loading