Skip to content

README.md

Latest commit

 

History

History
125 lines (83 loc) · 4.7 KB

README.md

File metadata and controls

125 lines (83 loc) · 4.7 KB

Kepware Configuration API SDK for Python

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

Prerequisites

The client libraries are supported on Python 3.6 or later. All HTTP communication is handled by the urllib Python standard library.

Features

  • Supports both HTTP and HTTPS connections with certificate validation options

SDK allows for GET, ADD, DELETE, and MODIFY functions for the following Kepware configuration objects:

Features TKS/KEP TKE
Project Properties
(Get and Modify Only)		 Y Y
Connectivity
(Channel, Devices, Tags, Tag Groups)		 Y Y
IoT Gateway
(Agents, IoT Items)		 Y Y
Datalogger
(Log Groups, Items, Mapping, Triggers, Reset Mapping Service)		 Y Y
Administration
(User Groups, Users, UA Endpoints)		 Y* Y

Note (*) - UA Endpoints supported for Kepware Edge only

Driver specific features:

Driver Features
GE Ethernet Global Data Exchanges, Ranges and Name Resolutions

Methods to read the following logs:

Logs TKS/KEP TKE
Event Log Y Y
API Transaction Log Y Y

Configuration API Services implemented:

Services TKS/KEP TKE
TagGeneration
(not supported by all drivers)		 Y Y
ReinitializeRuntime Y* Y

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

Generic REST methods are provided to use for functions not developed in SDK package. These are found in the Server Class in connection.py

Known Limitations

  • Other property configruation for more complex drivers are not explicitly defined
  • Other supported plug-ins (EFM Exporter, Scheduler, etc) are not defined
  • 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.

Installation

PIP packages can be found in the dist folder to install. Installation can be done manually using the following:

pip install kepconfig-<version>-py3-none-any.whl -f ./ --no-index

Key Concepts

NOTE: Samples can also be found in the samples folder.

Create server connection

import kepconfig.connection

server = connection.server(host = '127.0.0.1', port = 57412, user = 'Administrator', pw = '')

# For HTTPS connections:
server = connection.server(host = '127.0.0.1', port = 57412, user = 'Administrator', pw = '', https=True)

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:

For Windows OSes, the Kepware server's instance certificate can be loaded into the hosts "Trusted Root Certificate Authorities" store.

Create an object

Objects such as channels or devices can be created either singularly or with children included.

Ex: Add Single channel

from kepconfig.connectivity import channel

channel_data = {"common.ALLTYPES_NAME": "Channel1","servermain.MULTIPLE_TYPES_DEVICE_DRIVER": "Simulator"}
result = channel.add_channel(server,channel_data)

Ex: Add Multiple tags

from kepconfig.connectivity import tag

tag_info = [
    {
            "common.ALLTYPES_NAME": "Temp",
            "servermain.TAG_ADDRESS": "R0"
    },
    {
            "common.ALLTYPES_NAME": "Temp2",
            "servermain.TAG_ADDRESS": "R1"
    }
]
tag_path = '{}.{}.{}'.format(ch_name, dev_name, tag_group_path)
result = tag.add_tag(server, tag_path, tag_info))

Need More Information

Visit: