Skip to content

Commit 93c774b

Browse files
committed
Updated with 1.2.0 version changes
1 parent 12b0f9d commit 93c774b

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Kepware Configuration API SDK for Python
22

3-
[![PyPI version](https://badge.fury.io/py/kepconfig.svg)](https://badge.fury.io/py/kepconfig)
3+
[![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 SDK to create Python modules 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).
66

77
## Prerequisites
88

9-
The client libraries are supported on Python 3.6 or later. All HTTP communication is handled by the [urllib](https://docs.python.org/3.6/library/urllib.html#module-urllib) Python standard library.
9+
Package supported and tested on Python 3.9 or later. Older versions support earlier Python 3 environments but have less functionality. All HTTP communication is handled by the [urllib](https://docs.python.org/3/library/urllib.html#module-urllib) Python standard library.
1010

1111
## Features
1212

@@ -21,14 +21,17 @@ SDK allows for *GET*, *ADD*, *DELETE*, and *MODIFY* functions for the following
2121
| **IoT Gateway** <br /> *(Agents, IoT Items)* | Y | Y |
2222
| **Datalogger** <br /> *(Log Groups, Items, Mapping, Triggers, Reset Mapping Service)* | Y | Y |
2323
| **Administration** <br /> *(User Groups, Users, UA Endpoints, Local License Server)* | Y* | Y |
24+
| **Product Info and Health Status\*\*** | Y | Y |
2425

25-
Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only
26+
- Note (*) - UA Endpoints and Local License Server supported for Kepware Edge only
27+
- Note (**) - Added to Kepware Server v6.13 / Kepware Edge v1.5 and later builds
2628

2729
Driver specific features:
2830

2931
| Driver | Features |
3032
| :----------: | :----------: |
3133
|GE Ethernet Global Data|Exchanges, Ranges and Name Resolutions|
34+
|Universal Device Driver|Profile Library|
3235

3336
Methods to read the following logs:
3437

@@ -41,16 +44,19 @@ Configuration API *Services* implemented:
4144

4245
| Services | TKS/KEP | TKE |
4346
| :----------: | :----------: | :----------: |
44-
| **TagGeneration** <br /> *(for supported drivers)* | Y | Y |
47+
| **TagGeneration**<br />*(for supported drivers)* | Y | Y |
4548
| **ReinitializeRuntime** | Y* | Y |
49+
| **ProjectLoad and ProjectSave**| Y | Y |
4650

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

49-
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)
53+
Filtering, sorting and pagination query options are added for any collections methods (ex: get_all_devices() or get_all_channel()).
54+
55+
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)
5056

5157
## Known Limitations
5258

53-
- Other property configuration for more complex drivers with objects besides channels, devices, tags and tag groups are not explicitly defined
59+
- Other property configuration for more complex drivers with objects besides channels, devices, tags and tag groups are not always explicitly defined
5460
- Other supported plug-ins (EFM Exporter, Scheduler, etc) are not defined
5561
- When using hostnames (not IP addresses) for connections, delays may occur under certain network configurations as the connection may attempt IPv6 connections first. IPv6 is not supported by Kepware servers at this time.
5662

@@ -64,7 +70,7 @@ Package can be installed with `pip` using the following:
6470

6571
## Key Concepts
6672

67-
NOTE: Samples can also be found in the [samples](samples) folder.
73+
NOTE: Detailed examples can also be found in the [examples](./examples/) folder.
6874

6975
### Create server connection
7076

@@ -74,7 +80,7 @@ import kepconfig.connection
7480
server = connection.server(host = '127.0.0.1', port = 57412, user = 'Administrator', pw = '')
7581

7682
# For HTTPS connections:
77-
server = connection.server(host = '127.0.0.1', port = 57412, user = 'Administrator', pw = '', https=True)
83+
server = connection.server(host = '127.0.0.1', port = 57512, user = 'Administrator', pw = '', https=True)
7884

7985
```
8086

@@ -124,5 +130,4 @@ result = tag.add_tag(server, tag_path, tag_info))
124130
**Visit:**
125131

126132
- [Kepware.com](https://www.kepware.com/)
127-
- [Configuration API Info](https://www.kepware.com/en-us/products/kepserverex/features/configuration-api/)
128133
- [PTC.com](https://www.ptc.com/)

0 commit comments

Comments
 (0)