Skip to content

Commit ba72035

Browse files
committed
Update with 1.3.0 info
1 parent 2549f22 commit ba72035

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Released Version](https://img.shields.io/pypi/v/kepconfig)](https://pypi.org/project/kepconfig) [![Supported Versions](https://img.shields.io/pypi/pyversions/kepconfig)](https://pypi.org/project/kepconfig) ![PyPI - Downloads](https://img.shields.io/pypi/dm/kepconfig) ![PyPI - License](https://img.shields.io/pypi/l/kepconfig)
44

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).
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.
66

77
**API reference documentation is available on [Github Pages](https://ptcinc.github.io/Kepware-ConfigAPI-SDK-Python)**
88

@@ -22,13 +22,15 @@ Package allows for *GET*, *ADD*, *DELETE*, and *MODIFY* functions for the follow
2222
| **Connectivity** <br /> *(Channel, Devices, Tags, Tag Groups)* | Y | Y |
2323
| **IoT Gateway** <br /> *(Agents, IoT Items)* | Y | Y |
2424
| **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 |
2626
| **Administration** <br /> *(User Groups, Users, UA Endpoints, Local License Server)* | Y* | Y |
2727
| **Product Info and Health Status\*\*** | Y | Y |
28+
| **Import Project (via JsonProjectLoad Service) / Export Project\*\*\*\***| Y | Y |
2829

2930
- Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only
3031
- 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
3234

3335
Driver specific features:
3436

@@ -51,12 +53,15 @@ Configuration API *Services* implemented:
5153
| **TagGeneration** <br /> *(for supported drivers)* | Y | Y |
5254
| **ReinitializeRuntime** | Y* | Y |
5355
| **ProjectLoad and ProjectSave**| Y | Y |
56+
| **JsonProjectLoad\*\*** <br /> *(used for import project feature)*| Y | Y |
5457

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

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
5861

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)
6065

6166
## Known Limitations
6267

@@ -76,7 +81,7 @@ Package can be installed with `pip` using the following:
7681

7782
NOTE: Detailed examples can also be found in the [examples](./examples/) folder.
7883

79-
### Create server connection
84+
### Create server connection instance
8085

8186
```python
8287
from kepconfig import connection
@@ -88,13 +93,13 @@ server = connection.server(host = '127.0.0.1', port = 57512, user = 'Administrat
8893

8994
```
9095

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:
9297

9398
- [ssl.create_default_context](https://docs.python.org/3/library/ssl.html#ssl.create_default_context)
9499
- [ssl.SSLContext.load_default_certs](https://docs.python.org/3/library/ssl.html#ssl.SSLContext.load_default_certs)
95100
- [set_default_verify_paths](https://docs.python.org/3/library/ssl.html#ssl.SSLContext.set_default_verify_paths)
96101

97-
For Windows OSes, the Kepware server's instance certificate can be loaded into the hosts "Trusted Root Certificate Authorities" store.
102+
For Windows OSes, the Kepware Server's instance certificate can be loaded into the hosts "Trusted Root Certificate Authorities" store.
98103

99104
### Create an object
100105

@@ -133,5 +138,6 @@ result = tag.add_tag(server, tag_path, tag_info)
133138

134139
**Visit:**
135140

141+
- [Kepconfig Package Documentation on Github Pages](https://ptcinc.github.io/Kepware-ConfigAPI-SDK-Python)
136142
- [Kepware.com](https://www.kepware.com/)
137143
- [PTC.com](https://www.ptc.com/)

0 commit comments

Comments
 (0)