The Kepware Configuration API SDK for .NET provides tools and libraries to interact with the Kepware Configuration REST API, enabling configuration management for Kepware servers. This repository includes examples and utilities to streamline development for deployment tools, including a service for continuous synchronization and an API client library.
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.
- API Client Library: Simplify interaction with the Kepware Configuration API.
- Service for Synchronization:
- Bi-directional synchronization between Kepware servers and local filesystems.
- Support for one-way and two-way synchronization modes.
- Sample Applications: Demonstrates API usage with real-world examples.
- HTTPS Support: Certificate validation and secure connections.
This repository contains the following projects:
A .NET library providing an easy-to-use client for interacting with the Kepware Configuration API. Includes functionality for managing channels, devices, tags, and more.
API reference documentation is available on TBD
A service application for synchronizing configurations between Kepware servers and the local filesystem. It supports monitoring and synchronization in real time.
Readme for KepwareSync.Service
Automatically synchronize configurations between two Kepware instances. Changes are detected via the REST Config API and propagated to the other instance.
+------------+ Sync +------------+
| Primary | <------------> | Secondary |
| Kepware | | Kepware |
+------------+ +------------+
Synchronize configurations between a Kepware instance and the local filesystem bidirectionally. Changes in files are synced to Kepware and vice versa. Git operations like commits and pulls must be managed separately (e.g., using Git Sync Services or manual Git operations).
+------------+ Sync +--------------+ Git +-------------+
| Kepware | <------------> | Local Files | <------------> | GIT Repo |
+------------+ +--------------+ +-------------+
Deploy a centralized GIT configuration across multiple Kepware instances. Configurations are provided locally via tools like Git or RSync and then synchronized to Kepware using the sync tool. Local specifics like device IP addresses or credentials can be customized using overwrite files.
+--------------------+
| Central GIT Repo |
+--------------------+
|
(Git Sync / RSync)
|
+--------------+ +--------------+ +--------------+
| Kepware #1 | | Kepware #2 | | Kepware #n |
| [Overwrite] | | [Overwrite] | | [Overwrite] |
+--------------+ +--------------+ +--------------+
Sample console applications demonstrating how to use Kepware.Api NuGet package to interact with the Kepware Configuration API. Includes examples for creating channels, devices, and tags.
We welcome contributions to this repository. Please review the Repository Guidelines for information on Commit Message Conventions, Pull Request process and other details.
This SDK and service application is provided "as is" under the MIT License. See the LICENSE file for details.
For any issues, please open an Issue within the repository. For questions or feature requests, please open a Discussion thread within the repository.
See Repository Guidelines for more information.
Visit:
Ready to dive in? Check out the project-specific Readmes for detailed information on how to get started!