Skip to content

Commit 91a1297

Browse files
committed
Doc updated for 1.3.0
1 parent ba72035 commit 91a1297

File tree

8 files changed

+2093
-1524
lines changed

8 files changed

+2093
-1524
lines changed

docs/kepconfig.html

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ <h1 class="modulename">
7070

7171
<p><a href="https://pypi.org/project/kepconfig"><img src="https://img.shields.io/pypi/v/kepconfig" alt="Released Version" /></a> <a href="https://pypi.org/project/kepconfig"><img src="https://img.shields.io/pypi/pyversions/kepconfig" alt="Supported Versions" /></a> <img src="https://img.shields.io/pypi/dm/kepconfig" alt="PyPI - Downloads" /> <img src="https://img.shields.io/pypi/l/kepconfig" alt="PyPI - License" /></p>
7272

73-
<p>This is a package to help create Python applications to conduct operations with the Kepware Configuration API. This package is designed to work with all versions of Kepware that support the Configuration API including Thingworx Kepware Server (TKS), Thingworx Kepware Edge (TKE) and KEPServerEX (KEP).</p>
73+
<p>This is a package to help create Python applications to conduct operations with the Kepware Configuration API. This package is designed to work with all versions of Kepware that support the Configuration API including Thingworx Kepware Server (TKS), Thingworx Kepware Edge (TKE) and KEPServerEX (KEP). For reference, Kepware Server in this documentation will refer to both TKS and KEP versions.</p>
7474

7575
<p><strong>API reference documentation is available on <a href="https://ptcinc.github.io/Kepware-ConfigAPI-SDK-Python">Github Pages</a></strong></p>
7676

@@ -116,7 +116,7 @@ <h2 id="features">Features</h2>
116116
<td style="text-align:center;">Y</td>
117117
</tr>
118118
<tr>
119-
<td style="text-align:center;"><strong>UA Gateway</strong> <br /> <em>(Certificates, Server Endpoints, Client Connectins)</em></td>
119+
<td style="text-align:center;"><strong>UA Gateway</strong> <br /> <em>(Certificates, Server Endpoints, Client Connections, Server Interface parameters)</em></td>
120120
<td style="text-align:center;">Y<em>*</em></td>
121121
<td style="text-align:center;">N</td>
122122
</tr>
@@ -130,13 +130,19 @@ <h2 id="features">Features</h2>
130130
<td style="text-align:center;">Y</td>
131131
<td style="text-align:center;">Y</td>
132132
</tr>
133+
<tr>
134+
<td style="text-align:center;"><strong>Import Project (via JsonProjectLoad Service) / Export Project****</strong></td>
135+
<td style="text-align:center;">Y</td>
136+
<td style="text-align:center;">Y</td>
137+
</tr>
133138
</tbody>
134139
</table>
135140

136141
<ul>
137142
<li>Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only</li>
138143
<li>Note (**) - Added to Kepware Server v6.13 / Kepware Edge v1.5 and later builds</li>
139-
<li>Note (<em>*</em>) - TKS only</li>
144+
<li>Note (<em>*</em>) - TKS only v6.16 and later</li>
145+
<li>Note (<em>*</em>*) - Added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds</li>
140146
</ul>
141147

142148
<p>Driver specific features:</p>
@@ -210,14 +216,21 @@ <h2 id="features">Features</h2>
210216
<td style="text-align:center;">Y</td>
211217
<td style="text-align:center;">Y</td>
212218
</tr>
219+
<tr>
220+
<td style="text-align:center;"><strong>JsonProjectLoad**</strong> <br /> <em>(used for import project feature)</em></td>
221+
<td style="text-align:center;">Y</td>
222+
<td style="text-align:center;">Y</td>
223+
</tr>
213224
</tbody>
214225
</table>
215226

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

218-
<p>Filtering, sorting and pagination query options are added for any collections methods (ex: get_all_devices() or get_all_channel()).</p>
229+
<p>Note (**) - Added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds</p>
230+
231+
<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>
219232

220-
<p>Generic REST methods are provided to use for functions not developed in SDK package. These are found in the Server Class in <a href="./kepconfig/connection.py">connection.py</a></p>
233+
<p>Generic REST methods are provided to use for functions not developed in SDK package. These are found in the <code>Server</code> class in <a href="./kepconfig/connection.py">connection.py</a></p>
221234

222235
<h2 id="known-limitations">Known Limitations</h2>
223236

@@ -238,7 +251,7 @@ <h2 id="key-concepts">Key Concepts</h2>
238251

239252
<p>NOTE: Detailed examples can also be found in the <a href="./examples/">examples</a> folder.</p>
240253

241-
<h3 id="create-server-connection">Create server connection</h3>
254+
<h3 id="create-server-connection-instance">Create server connection instance</h3>
242255

243256
<div class="pdoc-code codehilite">
244257
<pre><span></span><code><span class="kn">from</span> <span class="nn">kepconfig</span> <span class="kn">import</span> <span class="n">connection</span>
@@ -250,15 +263,15 @@ <h3 id="create-server-connection">Create server connection</h3>
250263
</code></pre>
251264
</div>
252265

253-
<p>For certificate validation, the SDK uses the OS/systems trusted CA certificate store. The connection uses the "create_default_context()" function as part of urllib as described at the following links:</p>
266+
<p>For certificate validation, the SDK uses the OS/systems trusted certificate store. The connection uses the <code>create_default_context()</code> function as part of urllib as described at the following links:</p>
254267

255268
<ul>
256269
<li><a href="https://docs.python.org/3/library/ssl.html#ssl.create_default_context">ssl.create_default_context</a></li>
257270
<li><a href="https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_default_certs">ssl.SSLContext.load_default_certs</a></li>
258271
<li><a href="https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_default_verify_paths">set_default_verify_paths</a></li>
259272
</ul>
260273

261-
<p>For Windows OSes, the Kepware server's instance certificate can be loaded into the hosts "Trusted Root Certificate Authorities" store.</p>
274+
<p>For Windows OSes, the Kepware Server's instance certificate can be loaded into the hosts "Trusted Root Certificate Authorities" store.</p>
262275

263276
<h3 id="create-an-object">Create an object</h3>
264277

@@ -299,6 +312,7 @@ <h2 id="need-more-information">Need More Information</h2>
299312
<p><strong>Visit:</strong></p>
300313

301314
<ul>
315+
<li><a href="https://ptcinc.github.io/Kepware-ConfigAPI-SDK-Python">Kepconfig Package Documentation on Github Pages</a></li>
302316
<li><a href="https://www.kepware.com/">Kepware.com</a></li>
303317
<li><a href="https://www.ptc.com/">PTC.com</a></li>
304318
</ul>

0 commit comments

Comments
 (0)