Bookmark--'request' method as argument

Author: Juliana Mashon

api_connect.py

@@ -71,40 +71,27 @@ def check_token(self):
             print("ERROR: You have no token, please call `get_token` using your login credentials and the server you wish to connect to.")
             sys.exit(1)
 
-    def request(self, method, endpoint, id, payload):
-        """Send requests from user-accessible functions via API."""
+    def request(self, method, endpoint, database_id, payload):
+        """Send requests to the API using various methods."""
 
         self.check_token()
 
-        if id is None:
+        # use 'GET' method to view endpoint data
+        # use 'POST' method to overwrite/create new endpoint data
+        # use 'PATCH' method to edit endpoint data (used for new logs)
+        # use 'DELETE' method to delete endpoint data (hidden)
+
+        if database_id is None:
             url = f'https:{self.token["token"]["unencoded"]["iss"]}/api/{endpoint}'
         else:
-            url = f'https:{self.token["token"]["unencoded"]["iss"]}/api/{endpoint}/{id}'
+            url = f'https:{self.token["token"]["unencoded"]["iss"]}/api/{endpoint}/{database_id}'
 
         headers = {'authorization': self.token['token']['encoded'], 'content-type': 'application/json'}
         response = requests.request(method, url, headers=headers, json=payload)
 
         if self.request_handling(response) == 200:
-            user_request = response.json()
             self.error = None
-            return user_request
+            request_data = response.json()
+            return request_data
         else:
             return self.error
-
-    ## REQUEST METHODS
-
-    def get(self, endpoint, id):
-        """METHOD: 'get' allows user to view endpoint data."""
-        return self.request('GET', endpoint, id, payload=None)
-
-    def post(self, endpoint, id, payload):
-        """METHOD: 'post' allows user to overwrite/create new endpoint data."""
-        return self.request('POST', endpoint, id, payload)
-
-    def patch(self, endpoint, id, payload):
-        """METHOD: 'patch' allows user to edit endpoint data (used for new logs)."""
-        return self.request('PATCH', endpoint, id, payload)
-
-    def delete(self, endpoint, id):
-        """METHOD: 'delete' allows user to delete endpoint data (hidden)."""
-        return self.request('DELETE', endpoint, id, payload=None)

broker_connect.py

@@ -54,7 +54,7 @@ def publish(self, message):
     ## FUNCTIONS -- RECEIVING MESSAGES
 
     def on_connect(self, _client, _userdata, _flags, _rc, channel):
-        """Subscribe to specified broker response channel."""
+        """Subscribe to specified message broker channel."""
         self.client.subscribe(f"bot/{self.token['token']['unencoded']['bot']}/{channel}")
 
     def on_message(self, _client, _userdata, msg):

broker_functions.py

@@ -35,7 +35,7 @@ def __init__(self):
 
         self.client = None
 
-    def read_status(self):
+    def read_status(self): #########################################
         # Get device status tree
         message = {
             "kind": "rpc_request",
@@ -59,7 +59,7 @@ def read_status(self):
         # Return status as json object: status[""]
         return status_tree
 
-    def read_sensor(self, id):
+    def read_sensor(self, id): #########################################
         # Get sensor data
         peripheral_str = self.api.get_info('peripherals', id)
         mode = peripheral_str['mode']
@@ -159,17 +159,7 @@ def e_stop(self):
 
     def unlock(self):
         # Tell bot to unlock
-        # No inherent return value
-
-        # unlock_message = {
-        #     **RPC_REQUEST,
-        #     "body": {
-        #         "kind": "emergency_unlock",
-        #         "args": {}
-        #     }
-        # }
-
-        new_unlock = {
+        message = {
             "kind": "rpc_request",
             "args": {
                 "label": "",
@@ -182,12 +172,12 @@ def unlock(self):
                 }
             ]
         }
-        self.broker_connect.publish(new_unlock)
+        self.broker_connect.publish(message)
 
-        # self.broker_connect.publish(unlock_message)
+        # No inherent return value
         return print("Triggered device unlock.")
 
-    def reboot(self):
+    def reboot(self): #########################################
         # Tell bot to reboot
         # No inherent return value
         reboot_message = {
@@ -203,7 +193,7 @@ def reboot(self):
         self.broker_connect.publish(reboot_message)
         return print("Triggered device reboot.")
 
-    def shutdown(self):
+    def shutdown(self): #########################################
         # Tell bot to shutdown
         # No inherent return value
         shutdown_message = {
@@ -278,22 +268,28 @@ def set_home(self, axis='all'):
 
     def find_home(self, axis='all', speed=100):
         # Move to 0,0,0
-        # Return new xyz position as values
         if speed > 100 or speed < 1:
             return print("ERROR: Speed constrained to 1-100.")
         else:
-            find_home_message = {
-                **RPC_REQUEST,
-                "body": {
-                    "kind": "find_home",
-                    "args": {
-                        "axis": axis,
-                        "speed": speed
+            message = {
+                "kind": "rpc_request",
+                "args": {
+                    "label": "",
+                    "priority": 600
+                },
+                "body": [
+                    {
+                        "kind": "find_home",
+                        "args": {
+                            "axis": axis,
+                            "speed": speed
+                        }
                     }
-                }
+                ]
             }
+            self.broker_connect.publish(message)
 
-            self.broker_connect.publish(find_home_message)
+        # Return new xyz position as values
 
     def axis_length(self, axis='all'):
         # Get axis length
@@ -629,7 +625,7 @@ def mark_coord(self, x, y, z, property, mark_as): # TODO: Fix "label"
 
     # TODO: water() --> all or single coords
         # Dispense water at all or single xyz coords
-        # No inherent return value
+        # No inherent return value✅
     # TODO: dispense() --> single coords?
         # Dispense from source at all or single xyz coords
         # No inherent return value