Cleaned up and added comments for planned changes

Author: Juliana Mashon

api_functions.py

@@ -9,55 +9,31 @@ def __init__(self):
         self.echo = True
         self.verbose = True
 
-    def __return_config(self, funct_name, return_value, is_json=False):
-        """Configure echo and verbosity of function returns."""
-
-        if self.echo is True:
-            print('-' * 100)
-            print(f'FUNCTION: {funct_name}\n')
-            if is_json is True:
-                readable_json = json.dumps(return_value, indent=4)
-                print(readable_json)
-            else:
-                print(return_value)
-        elif self.echo is False:
-            pass
-        else:
-            print('-' * 100)
-            return print("ERROR: Incompatible return configuration.")
-
-        return return_value
-
     def get_token(self, email, password, server='https://my.farm.bot'):
+        # Generate user authentication token
         token_str = self.api_connect.get_token(email, password, server)
-        return self.__return_config("get_token()", token_str, is_json=True)
-
-    # data = get_info() and like functions will assign 'data' JSON object
-    # data["name"] will access the field "name" and return the field value
+        # Return token as json object: token[""]
+        return token_str
 
     def get_info(self, endpoint, id=None):
+        # Get endpoint info
         endpoint_data = self.api_connect.get(endpoint, id)
-        return self.__return_config("get_info()", endpoint_data, is_json=True)
+        # Return endpoint info as json object: endpoint[""]
+        return endpoint_data
 
     def set_info(self, endpoint, field, value, id=None):
+        # Edit endpoint info
         new_value = {
             field: value
         }
-
         self.api_connect.patch(endpoint, id, new_value)
 
-        endpoint_data = self.api_connect.get(endpoint, id)
-        return self.__return_config("set_info()", endpoint_data, is_json=True)
-
-    def env(self, id=None, field=None, new_val=None): # TODO: Fix
-        if id is None:
-            env_data = self.api_connect.get('farmware_envs', id=None)
-        else:
-            env_data = self.api_connect.get('farmware_envs', id)
-
-        return self.__return_config("env()", env_data, is_json=True)
+        # Return endpoint info as json object: endpoint[""]
+        new_endpoint_data = self.api_connect.get(endpoint, id)
+        return new_endpoint_data
 
     def log(self, message, type=None, channel=None):
+        # Send new log message via API
         log_message = {
             "message": message,
             "type": type, # https://software.farm.bot/v15/app/intro/jobs-and-logs#log-types
@@ -68,13 +44,18 @@ def log(self, message, type=None, channel=None):
         id = None
 
         self.api_connect.post(endpoint, id, log_message)
-        # return ...
+
+        # No inherent return value
 
     def safe_z(self):
-        json_data = self.get_info('fbos_config')
-        return json_data['safe_height']
+        # Get safe z height via get_info()
+        config_data = self.get_info('fbos_config')
+        z_value = config_data["safe_height"]
+        # Return safe z height as value
+        return z_value
 
     def garden_size(self):
+        # Get garden size parameters via get_info()
         json_data = self.get_info('firmware_config')
 
         x_steps = json_data['movement_axis_nr_steps_x']
@@ -87,13 +68,25 @@ def garden_size(self):
         length_y = y_steps / y_mm
         area = length_x * length_y
 
-        return print(f'Garden size:\n'
-                    f'\tx length = {length_x:.2f}\n'
-                    f'\ty length = {length_y:.2f}\n'
-                    f'\tarea = {area:.2f}')
+        # Return garden size parameters as values
+        return length_x, length_y, area
+
+    def group(self, id=None):
+        # Get all groups or single by id
+        if id is None:
+            group_data = self.get_info("point_groups")
+        else:
+            group_data = self.get_info('point_groups', id)
+
+        # Return group as json object: group[""]
+        return group_data
 
-    def group(self, id): # TODO: make ID optional return full tree w/o ID
-        return self.get_info('point_groups', id)
+    def curve(self, id=None):
+        # Get all curves or single by id
+        if id is None:
+            curve_data = self.get_info("curves")
+        else:
+            curve_data = self.get_info('curves', id)
 
-    def curve(self, id): # TODO: make ID optional return full tree w/o ID
-        return self.get_info('curves', id)
+        # Return curve as json object: curve[""]
+        return curve_data

broker_connect.py

@@ -79,33 +79,3 @@ def listen(self, duration, channel):
 
         self.client.loop_stop()
         self.client.disconnect()
-
-    ## FUNCTIONS -- HIDDEN
-
-    def hidden_on_connect(self, _client, _userdata, _flags, _rc):
-        # Subscribe to all channels
-        self.client.subscribe(f"bot/{self.token['token']['unencoded']['bot']}/#")
-
-    def hidden_on_message(self, _client, _userdata, msg):
-        # print channel
-        print('-' * 100)
-        print(f'{msg.topic} ({datetime.now().strftime("%Y-%m-%d %H:%M:%S")})\n')
-        # print message
-        print(json.dumps(json.loads(msg.payload), indent=4))
-
-    def hidden_listen(self):
-        if self.client is None:
-            self.connect()
-
-        self.client.on_connect = self.hidden_on_connect
-        self.client.on_message = self.hidden_on_message
-
-        # Start loop in a separate thread
-        self.client.loop_start()
-
-        # Sleep for five seconds to listen for messages
-        time.sleep(60)
-
-        # Stop loop and disconnect after five seconds
-        self.client.loop_stop()
-        self.client.disconnect()