Updated Beta 3

Author: rlabbeptc

README.md

@@ -1,6 +1,6 @@
 # Kepware Configuration API SDK for Python
 
-This is a package SDK to create Python modules to conduct operations with the Kepware Configuration API.
+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
 
@@ -12,24 +12,38 @@ The client libraries are supported on Python 3.6 or later. All HTTP communicatio
 
 SDK allows for *GET*, *ADD*, *DELETE*, and *MODIFY* functions for the following Kepware configuration objects:
 
-- **Project Properties** *(Get and Modify Only)*
-- **Connectivity** *(Channel, Devices, Tags, Tag Groups)*
-- **IoT Gateway** *(Agents, IoT Items)*
+| Features      | TKS/KEP       | TKE           |
+| :----------:  | :----------:  | :----------:  |
+| **Project Properties** <br /> *(Get and Modify Only)* | Y | Y |
+| **Connectivity** <br /> *(Channel, Devices, Tags, Tag Groups)* | Y | Y |
+| **IoT Gateway** <br /> *(Agents, IoT Items)* | Y | Y |
+| **Datalogger** <br /> *(Log Groups, Items, Mapping, Triggers, Reset Mapping Service)* | Y | Y |
+| **Administration** <br /> *(User Groups, Users, UA Endpoints)* | Y* | Y |
+
+Note (*) - UA Endpoints supported for Kepware Edge only
 
 Methods to read the following logs:
 
-- **Event Log**
-- **API Transaction Log**
+| Logs          | TKS/KEP       | TKE           |
+| :----------:  | :----------:  | :----------:  |
+| **Event Log** | Y | Y |
+| **API Transaction Log** | Y | Y |
+
+Configuration API *Services* implemented:
 
-Additionally the following *Services* are implemented:
+| Services      | TKS/KEP       | TKE           |
+| :----------:  | :----------:  | :----------:  |
+| **TagGeneration** <br /> *(not supported by all drivers)* | Y | Y |
+| **ReinitializeRuntime** | Y* | Y |
 
-- **TagGeneration** *(not supported by all drivers)*
-- **ReinitializeRuntime** *(Thingworx Kepware Edge and Kepware Server 6.8+)*
+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](/kepconfig/connection.py)
 
 ## Known Limitations
 
 - Other property configruation for more complex drivers are not explicitly defined
-- Other supported plug-ins (Datalogger, Scheduler, etc) are not 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
@@ -42,6 +56,8 @@ pip install kepconfig-<version>-py3-none-any.whl -f ./ --no-index
 
 ## Key Concepts
 
+NOTE: Samples can also be found in the [samples](samples) folder.
+
 ### Create server connection
 
 ```python
@@ -64,7 +80,7 @@ For Windows OSes, the Kepware server's instance certificate can be loaded into t
 
 ### Create an object
 
-Objects such as channels or devices can be created either sigularly or with children included.
+Objects such as channels or devices can be created either singularly or with children included.
 
 ### Ex: Add Single channel
 
@@ -100,3 +116,4 @@ result = tag.add_tag(server, tag_path, tag_info))
 **Visit:**
 [Kepware.com](https://www.kepware.com/)
 [Configuration API Info](https://www.kepware.com/en-us/products/kepserverex/features/configuration-api/)
+[PTC.com](https://www.ptc.com/)

kepconfig/admin/user_groups.py

@@ -8,6 +8,7 @@
 user_groups within the Kepware Administration User Manager through the Kepware Configuration API
 """
 USERGROUPS_ROOT = '/admin/server_usergroups'
+ENABLE_PROPERTY = 'libadminsettings.USERMANAGER_GROUP_ENABLED'
 
 def _create_url(user_group = None):
     '''Creates url object for the "server_usergroups" branch of Kepware's project tree. Used 
@@ -133,4 +134,40 @@ def get_all_user_groups(server):
     '''
 
     r = server._config_get(server.url + _create_url())
-    return r.payload
+    return r.payload
+
+def enable_user_group(server, user_group):
+    '''Enable the user group. Returned object is JSON.
+    
+    INPUTS:
+    "server" - instance of the "server" class
+
+    "user_group" - name of user group
+
+    RETURNS:
+    True - If a "HTTP 200 - OK" is received from Kepware
+
+    EXCEPTIONS:
+    KepHTTPError - If urllib provides an HTTPError
+    KepURLError - If urllib provides an URLError
+    '''
+    DATA = {ENABLE_PROPERTY: True}
+    return modify_user_group(server, DATA, user_group)
+
+def disable_user_group(server, user_group):
+    '''Disable the user group. Returned object is JSON.
+    
+    INPUTS:
+    "server" - instance of the "server" class
+
+    "user_group" - name of user group
+
+    RETURNS:
+    True - If a "HTTP 200 - OK" is received from Kepware
+
+    EXCEPTIONS:
+    KepHTTPError - If urllib provides an HTTPError
+    KepURLError - If urllib provides an URLError
+    '''
+    DATA = {ENABLE_PROPERTY: False}
+    return modify_user_group(server, DATA, user_group)

kepconfig/admin/users.py

@@ -8,6 +8,7 @@
 users within the Kepware Administration User Management through the Kepware Configuration API
 """
 USERS_ROOT = '/admin/server_users'
+ENABLE_PROPERTY = 'libadminsettings.USERMANAGER_USER_ENABLED'
 
 def _create_url(user = None):
     '''Creates url object for the "server_users" branch of Kepware's project tree. Used 
@@ -133,4 +134,40 @@ def get_all_users(server):
     '''
 
     r = server._config_get(server.url + _create_url())
-    return r.payload
+    return r.payload
+
+def enable_user(server, user):
+    '''Enable the user. Returned object is JSON.
+    
+    INPUTS:
+    "server" - instance of the "server" class
+
+    "user" - name of user
+
+    RETURNS:
+    True - If a "HTTP 200 - OK" is received from Kepware
+
+    EXCEPTIONS:
+    KepHTTPError - If urllib provides an HTTPError
+    KepURLError - If urllib provides an URLError
+    '''
+    DATA = {ENABLE_PROPERTY: True}
+    return modify_user(server, DATA, user)
+
+def disable_user(server, user):
+    '''Disable the user. Returned object is JSON.
+    
+    INPUTS:
+    "server" - instance of the "server" class
+
+    "user" - name of user
+
+    RETURNS:
+    True - If a "HTTP 200 - OK" is received from Kepware
+
+    EXCEPTIONS:
+    KepHTTPError - If urllib provides an HTTPError
+    KepURLError - If urllib provides an URLError
+    '''
+    DATA = {ENABLE_PROPERTY: False}
+    return modify_user(server, DATA, user)

kepconfig/datalogger/log_group.py

@@ -154,10 +154,10 @@ def enable_log_group(server, log_group):
     KepURLError - If urllib provides an URLError
     '''
     DATA = {ENABLE_PROPERTY: True}
-    modify_log_group(server, DATA, log_group)
+    return modify_log_group(server, DATA, log_group)
 
 def disable_log_group(server, log_group):
-    '''Enable the log group. Returned object is JSON.
+    '''Disable the log group. Returned object is JSON.
     
     INPUTS:
     "server" - instance of the "server" class
@@ -172,7 +172,7 @@ def disable_log_group(server, log_group):
     KepURLError - If urllib provides an URLError
     '''
     DATA = {ENABLE_PROPERTY: False}
-    modify_log_group(server, DATA, log_group)
+    return modify_log_group(server, DATA, log_group)
 
 def reset_column_mapping_service(server, log_group):
     '''Executes a ResetColumnMapping serivce call to the log group