Added new methods (enable, reset mapping)

Author: rlabbeptc

kepconfig/datalogger/log_group.py

@@ -1,42 +1,38 @@
 # -------------------------------------------------------------------------
-# Copyright (c) 2020, PTC Inc. and/or all its affiliates. All rights reserved.
+# Copyright (c) PTC Inc. and/or all its affiliates. All rights reserved.
 # See License.txt in the project root for
 # license information.
 # --------------------------------------------------------------------------
 
 r""":mod:`log_group` exposes an API to allow modifications (add, delete, modify) to 
-Log Group objects within the Kepware Configuration API
+log group objects in DataLogger within the Kepware Configuration API
 """
+from kepconfig import connection, error as KepError
 
-
-LOG_GROUP_ROOT_URL = '/project/_datalogger/log_groups'
-
+ENABLE_PROPERTY = 'datalogger.LOG_GROUP_ENABLED'
+LOG_GROUP_ROOT = '/project/_datalogger/log_groups'
+SERVICES_ROOT = '/services'
 def _create_url(log_group = None):
-    '''Creates url object for the "agent" branch of Kepware's project tree. Used 
+    '''Creates url object for the "log_group" branch of Kepware's project tree. Used 
     to build a part of Kepware Configuration API URL structure
 
     Returns the agent specific url when a value is passed as the agent name.
     '''
 
     if log_group == None:
-        return '{}'.format(LOG_GROUP_ROOT_URL)
+        return '{}'.format(LOG_GROUP_ROOT)
     else:
-        return '{}/{}'.format(LOG_GROUP_ROOT_URL, log_group)
+        return '{}/{}'.format(LOG_GROUP_ROOT, log_group)
 
 
 def add_log_group(server, DATA):
-    '''Add a  "agent" or multiple "agent" objects of a specific type to Kepware's IoT Gateway. Can be used to pass children of an
-    agent object such as iot items. This allows you to create an agent and iot items if desired.
-
-    Additionally it can be used to pass a list of agents and it's children to be added all at once.
+    '''Add a "log group" or multiple "log groups" objects to Kepware's DataLogger. It can be used 
+    to pass a list of log groups to be added all at once.
 
     INPUTS:
     "server" - instance of the "server" class
 
-    *DATA* - properly JSON object (dict) of the agent and it's children
-    expected by Kepware Configuration API
-
-    "agent_type" (optional) - agent type to add to IoT Gateway. Only needed if not existing in "DATA"
+    *DATA* - properly JSON object (dict) of the log group expected by Kepware Configuration API
 
     RETURNS:
     True - If a "HTTP 201 - Created" is received from Kepware
@@ -51,14 +47,12 @@ def add_log_group(server, DATA):
     else: return False
 
 def del_log_group(server, log_group):
-    '''Delete a "agent" object in Kepware. This will delete all children as well
+    '''Delete a "log group" object in Kepware's Datalogger.
     
     INPUTS:
     "server" - instance of the "server" class
 
-    "agent" - name of IoT Agent
-
-    "agent_type" - agent type to delete to IoT Gateway
+    "log_group" - name of log group
 
     RETURNS:
     True - If a "HTTP 200 - OK" is received from Kepware
@@ -72,18 +66,16 @@ def del_log_group(server, log_group):
     else: return False
 
 def modify_log_group(server, DATA, log_group = None, force = False):
-    '''Modify a agent object and it's properties in Kepware. If a "agent" is not provided as an input,
-    you need to identify the agent in the 'common.ALLTYPES_NAME' property field in the "DATA". It will 
-    assume that is the agent that is to be modified.
+    '''Modify a log group object and it's properties in Kepware's Datalogger. If a "log group" is not provided as an input,
+    you need to identify the log group in the 'common.ALLTYPES_NAME' property field in the "DATA". It will 
+    assume that is the log group that is to be modified.
 
     INPUTS:
     "server" - instance of the "server" class
 
     "DATA" - properly JSON object (dict) of the agent properties to be modified
 
-    "agent" (optional) - name of IoT Agent. Only needed if not existing in "DATA"
-
-    "agent_type" (optional) -agent type to modify to IoT Gateway. Only needed if not existing in "DATA"
+    "log_group" (optional) - name of log group. Only needed if not existing in "DATA"
 
     "force" (optional) - if True, will force the configuration update to the Kepware server
 
@@ -103,7 +95,7 @@ def modify_log_group(server, DATA, log_group = None, force = False):
             if r.code == 200: return True 
             else: return False
         except KeyError as err:
-            print('Error: No agent identified in DATA | Key Error: {}'.format(err))
+            print('Error: No log group identified in DATA | Key Error: {}'.format(err))
             return False
         # except:
         #     return 'Error: Error with {}'.format(inspect.currentframe().f_code.co_name)
@@ -113,17 +105,15 @@ def modify_log_group(server, DATA, log_group = None, force = False):
         else: return False
 
 def get_log_group(server, log_group):
-    '''Returns the properties of the agent object. Returned object is JSON.
+    '''Returns the properties of the log group object. Returned object is JSON.
     
     INPUTS:
     "server" - instance of the "server" class
 
-    "agent" - name of IoT Agent
-
-    "agent_type" - agent type
+    "log_group" - name of log group
 
     RETURNS:
-    JSON - data for the IoT Agent requested
+    JSON - data for the log group requested
 
     EXCEPTIONS:
     KepHTTPError - If urllib provides an HTTPError
@@ -133,19 +123,81 @@ def get_log_group(server, log_group):
     return r.payload
 
 def get_all_log_groups(server):
-    '''Returns the properties of all agent objects for a specific agent type. Returned object is JSON list.
+    '''Returns the properties of all log group objects for Kepware's Datalogger. Returned object is JSON list.
     
     INPUTS:
     "server" - instance of the "server" class
 
-    "agent_type" - agent type
-
     RETURNS:
-    JSON - data for the IoT Agents requested
+    JSON - data for the log groups requested
 
     EXCEPTIONS:
     KepHTTPError - If urllib provides an HTTPError
     KepURLError - If urllib provides an URLError
     '''
     r = server._config_get(server.url + _create_url())
     return r.payload
+
+def enable_log_group(server, log_group):
+    '''Enable the log group. Returned object is JSON.
+    
+    INPUTS:
+    "server" - instance of the "server" class
+
+    "log_group" - name of log 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}
+    modify_log_group(server, DATA, log_group)
+
+def disable_log_group(server, log_group):
+    '''Enable the log group. Returned object is JSON.
+    
+    INPUTS:
+    "server" - instance of the "server" class
+
+    "log_group" - name of log 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}
+    modify_log_group(server, DATA, log_group)
+
+def reset_column_mapping_service(server, log_group):
+    '''Executes a ResetColumnMapping serivce call to the log group
+
+    INPUTS:
+    "server" - instance of the "server" class
+
+    "log_group" - name of log group
+
+    RETURNS:
+    KepServiceResponse instance with job information
+    
+    EXCEPTIONS (If not HTTP 200 or 429 returned):
+    KepHTTPError - If urllib provides an HTTPError
+    KepURLError - If urllib provides an URLError
+    '''
+
+    try:
+        r = server._config_update(server.url + _create_url(log_group) + SERVICES_ROOT + '/ResetColumnMapping', None)
+        job = connection.KepServiceResponse(r.payload['code'],r.payload['message'], r.payload['href'])
+        return job
+    except KepError.KepHTTPError as err:
+        if err.code == 429:
+            job.code = err.code
+            job.message = err.payload
+            return job
+        else:
+            raise err