You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
5
+
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.
6
6
7
7
**API reference documentation is available on [Github Pages](https://ptcinc.github.io/Kepware-ConfigAPI-SDK-Python)**
8
8
@@ -22,13 +22,15 @@ Package allows for *GET*, *ADD*, *DELETE*, and *MODIFY* functions for the follow
22
22
|**Connectivity** <br /> *(Channel, Devices, Tags, Tag Groups)*| Y | Y |
23
23
|**IoT Gateway** <br /> *(Agents, IoT Items)*| Y | Y |
24
24
|**Datalogger** <br /> *(Log Groups, Items, Mapping, Triggers, Reset Mapping Service)*| Y | Y |
25
-
|**UA Gateway** <br /> *(Certificates, Server Endpoints, Client Connectins)*| Y***| N |
25
+
|**UA Gateway** <br /> *(Certificates, Server Endpoints, Client Connections, Server Interface parameters)*| Y***| N |
26
26
|**Administration** <br /> *(User Groups, Users, UA Endpoints, Local License Server)*| Y*| Y |
27
27
|**Product Info and Health Status\*\***| Y | Y |
28
+
|**Import Project (via JsonProjectLoad Service) / Export Project\*\*\*\***| Y | Y |
28
29
29
30
- Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only
30
31
- Note (**) - Added to Kepware Server v6.13 / Kepware Edge v1.5 and later builds
31
-
- Note (***) - TKS only
32
+
- Note (***) - TKS only v6.16 and later
33
+
- Note (****) - Added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds
32
34
33
35
Driver specific features:
34
36
@@ -51,12 +53,15 @@ Configuration API *Services* implemented:
51
53
|**TagGeneration** <br /> *(for supported drivers)*| Y | Y |
52
54
|**ReinitializeRuntime**| Y*| Y |
53
55
|**ProjectLoad and ProjectSave**| Y | Y |
56
+
|**JsonProjectLoad\*\*** <br /> *(used for import project feature)*| Y | Y |
54
57
55
58
Note (*) - Reinitialize service was implemented for Kepware Server v6.8+
56
59
57
-
Filtering, sorting and pagination query options are added for any collections methods (ex: get_all_devices() or get_all_channel()).
60
+
Note (**) - Added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds
58
61
59
-
Generic REST methods are provided to use for functions not developed in SDK package. These are found in the Server Class in [connection.py](./kepconfig/connection.py)
62
+
Filtering, sorting and pagination query options are added for any collections methods (ex: `get_all_devices()` or `get_all_channel()`).
63
+
64
+
Generic REST methods are provided to use for functions not developed in SDK package. These are found in the `Server` class in [connection.py](./kepconfig/connection.py)
60
65
61
66
## Known Limitations
62
67
@@ -76,7 +81,7 @@ Package can be installed with `pip` using the following:
76
81
77
82
NOTE: Detailed examples can also be found in the [examples](./examples/) folder.
78
83
79
-
### Create server connection
84
+
### Create server connection instance
80
85
81
86
```python
82
87
from kepconfig import connection
@@ -88,13 +93,13 @@ server = connection.server(host = '127.0.0.1', port = 57512, user = 'Administrat
88
93
89
94
```
90
95
91
-
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:
96
+
For certificate validation, the SDK uses the OS/systems trusted certificate store. The connection uses the `create_default_context()` function as part of urllib as described at the following links:
0 commit comments