Organized into separate files

Author: jmashon

.gitignore

@@ -1,2 +1,3 @@
 .coverage
 __pycache__
+DO_NOT_COMMIT

api.py api_connect.py

@@ -1,9 +1,8 @@
 import sys
-import os
 import json
 import requests
 
-class ApiFunctions():
+class ApiConnect():
     def __init__(self):
         self.token = None
         self.error = None
@@ -21,6 +20,8 @@ def __init__(self):
     # delete() --> delete endpoint info
 
     def token_handling(self, response):
+        """Handle errors relating to bad user auth token requests."""
+
         # Handle HTTP status codes
         if response.status_code == 200:
             return 200
@@ -44,6 +45,8 @@ def token_handling(self, response):
         return 0
 
     def request_handling(self, response):
+        """Handle errors relating to bad endpoints and user requests."""
+
         error_messages = {
             404: "The specified endpoint does not exist.",
             400: "The specified ID is invalid or you do not have access to it.",
@@ -64,22 +67,30 @@ def request_handling(self, response):
         return 0
 
     def get_token(self, email, password, server):
+        """Fetch user authentication token via API."""
+
         headers = {'content-type': 'application/json'}
         user = {'user': {'email': email, 'password': password}}
         response = requests.post(f'{server}/api/tokens', headers=headers, json=user)
 
         if self.token_handling(response) == 200:
+            user_data = response.json()
+            user_token = user_data['token']
             self.error = None
-            return response.json()
+            return user_token
         else:
             return self.error
 
     def check_token(self):
+        """Ensure user authentication token has been generated and persists."""
+
         if self.token is None:
             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."""
+
         self.check_token()
 
         if id is None:
@@ -98,13 +109,17 @@ def request(self, method, endpoint, id, payload):
             return self.error
 
     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)

api_functions.py

@@ -0,0 +1,88 @@
+from api_connect import ApiConnect
+
+class ApiFunctions():
+    def __init__(self):
+        self.connect = ApiConnect()
+
+        self.token = None
+        self.error = None
+
+    def get_token(self, email, password, server='https://my.farm.bot'):
+        # when get_token() is called, set self.token
+        self.token = self.connect.get_token(email, password, server)
+
+        # when get_token() is called, set api.token
+        self.connect.token = self.token
+        # when get_token() is called, set broker.token
+        self.broker.token = self.token
+
+        return self.token
+
+    def get_info(self, endpoint, id=None):
+        return self.connect.get(endpoint, id)
+        # return self.connect.get(endpoint, id)...
+
+    def set_info(self, endpoint, field, value, id=None):
+        new_value = {
+            field: value
+        }
+
+        self.connect.patch(endpoint, id, new_value)
+        return self.connect.get(endpoint, id)
+        # return self.connect.get(endpoint, id)...
+
+    def env(self, id=None, field=None, new_val=None):
+        if id is None:
+            data = self.connect.get('farmware_envs', id=None)
+            print(data)
+        else:
+            data = self.connect.get('farmware_envs', id)
+            print(data)
+
+    def log(self, message, type=None, channel=None):
+        log_message = {
+            "message": message,
+            "type": type,
+            "channel": channel # Specifying channel does not do anything
+        }
+
+        endpoint = 'logs'
+        id = None
+
+        self.connect.post(endpoint, id, log_message)
+        # return ...
+
+    def safe_z(self):
+        json_data = self.get_info('fbos_config')
+        return json_data['safe_height']
+        # return json_data['safe_height']...
+
+    def garden_size(self):
+        json_data = self.get_info('firmware_config')
+
+        # Get x axis length in steps
+        x_steps = json_data['movement_axis_nr_steps_x']
+
+        # Get number of steps per millimeter on the x axis
+        x_mm = json_data['movement_step_per_mm_x']
+
+        # Get y axis length in steps
+        y_steps = json_data['movement_axis_nr_steps_y']
+
+        # Get number of steps per millimeter on the y axis
+        y_mm = json_data['movement_step_per_mm_y']
+
+        length_x = x_steps / x_mm
+        length_y = y_steps / y_mm
+        area = length_x * length_y
+
+        size_value = {'x': length_x, 'y': length_y, 'area': area}
+        return size_value
+
+    def group(self, id):
+        return self.get_info('point_groups', id)
+        # return self.get_info('point_groups', id)...
+
+    def curve(self, id):
+        return self.get_info('curves', id)
+        # return self.get_info('curves', id)...

broker.py broker_connect.py

@@ -1,9 +1,9 @@
+import json
+
 from datetime import datetime
 import paho.mqtt.client as mqtt
 
-import json
-
-class BrokerFunctions():
+class BrokerConnect():
     def __init__(self):
         self.token = None
         self.client = None
@@ -29,6 +29,18 @@ def __init__(self):
     #     client.subscribe("bot/device_4652/status")
     #     print('connected via status_connect()')
 
+    def sub_all(self, client, *_args):
+        """Subscribe to all message broker channels."""
+
+        self.client.subscribe(f"bot/{self.token['token']['unencoded']['bot']}/#")
+        print("Connected to all channels.")
+
+    def sub_single(self, client, *_args, channel):
+        """Subscribe to specific message broker channel."""
+
+        self.client.subscribe("bot/{device_id}/{channel}")
+        print("Connected to "+channel+".")
+
     def on_message(self, _client, _userdata, msg):
         print('-' * 100)
         # print channel
@@ -63,7 +75,7 @@ def disconnect(self):
 
     def publish(self, message):
         if self.client is None:
-            self.connect(self.token)
+            self.connect()
 
         self.client.publish(
             f'bot/{self.token["token"]["unencoded"]["bot"]}/from_clients',