move status prints to top of functions

Author: gabrielburnworth

README.md

@@ -97,7 +97,7 @@ bot.set_verbosity(2)
 | Verbosity | Example using `e_stop()` |
 | :--- | :--- |
 | `0` The function will return with no output. | No output. |
-| `1` A description of the action will be output with any additional results data. | `Triggered device emergency stop` |
+| `1` A description of the action will be output with any additional results data. | `Emergency stopping device` |
 | `2` The name of the function and the timestamp will be output. | `'e_stop()' called at: 2024-08-21 11:16:18.547813` |
 
 ### Test 1: Add a new plant to your garden

functions/basic_commands.py

@@ -34,7 +34,7 @@ def wait(self, duration):
     def e_stop(self):
         """Emergency locks (E-stops) the Farmduino microcontroller."""
 
-        self.state.print_status(description="Triggered device emergency stop")
+        self.state.print_status(description="Emergency stopping device")
 
         stop_message = {
             "kind": "emergency_lock",
@@ -47,7 +47,7 @@ def e_stop(self):
     def unlock(self):
         """Unlocks a locked (E-stopped) device."""
 
-        self.state.print_status(description="Triggered device unlock")
+        self.state.print_status(description="Unlocking device")
 
         unlock_message = {
             "kind": "emergency_unlock",
@@ -60,7 +60,7 @@ def unlock(self):
     def reboot(self):
         """Reboots the FarmBot OS and re-initializes the device."""
 
-        self.state.print_status(description="Triggered device reboot")
+        self.state.print_status(description="Rebooting device")
 
         reboot_message = {
             "kind": "reboot",
@@ -74,7 +74,7 @@ def reboot(self):
     def shutdown(self):
         """Shuts down the FarmBot OS and turns the device off."""
 
-        self.state.print_status(description="Triggered device shutdown")
+        self.state.print_status(description="Shutting down device")
 
         shutdown_message = {
             "kind": "power_off",

functions/camera.py

@@ -18,7 +18,7 @@ def __init__(self, state):
     def calibrate_camera(self):
         """Performs camera calibration. This action will reset camera calibration settings."""
 
-        self.state.print_status(description="Triggered camera calibration")
+        self.state.print_status(description="Calibrating camera")
 
         calibrate_message = {
             "kind": "execute_script",
@@ -32,7 +32,7 @@ def calibrate_camera(self):
     def take_photo(self):
         """Takes photo using the device camera and uploads it to the web app."""
 
-        self.state.print_status(description="Took a photo")
+        self.state.print_status(description="Taking a photo")
 
         photo_message = {
             "kind": "take_photo",

functions/information.py

@@ -67,15 +67,17 @@ def api_delete(self, endpoint, database_id=None):
 
     def safe_z(self):
         """Returns the highest safe point along the z-axis."""
+        self.state.print_status(description="Retrieving safe z value...")
 
         config_data = self.api_get('fbos_config')
         z_value = config_data["safe_height"]
 
-        self.state.print_status(description=f"Safe z={z_value}")
+        self.state.print_status(description=f"Safe z={z_value}", update_only=True)
         return z_value
 
     def garden_size(self):
         """Return size of garden bed."""
+        self.state.print_status(description="Retrieving garden size...")
 
         json_data = self.api_get('firmware_config')
 
@@ -94,33 +96,36 @@ def garden_size(self):
             "z": z_steps / z_mm,
         }
 
-        self.state.print_status(endpoint_json=garden_size)
+        self.state.print_status(endpoint_json=garden_size, update_only=True)
         return garden_size
 
     def group(self, group_id=None):
         """Returns all group info or single by id."""
+        self.state.print_status(description="Retrieving group information...")
 
         if group_id is None:
             group_data = self.api_get("point_groups")
         else:
             group_data = self.api_get('point_groups', group_id)
 
-        self.state.print_status(endpoint_json=group_data)
+        self.state.print_status(endpoint_json=group_data, update_only=True)
         return group_data
 
     def curve(self, curve_id=None):
         """Returns all curve info or single by id."""
+        self.state.print_status(description="Retrieving curve information...")
 
         if curve_id is None:
             curve_data = self.api_get("curves")
         else:
             curve_data = self.api_get('curves', curve_id)
 
-        self.state.print_status(endpoint_json=curve_data)
+        self.state.print_status(endpoint_json=curve_data, update_only=True)
         return curve_data
 
     def measure_soil_height(self):
         """Use the camera to measure the soil height at the current location."""
+        self.state.print_status(description="Measuring soil height...")
 
         measure_soil_height_message = {
             "kind": "execute_script",

functions/jobs.py

@@ -22,6 +22,7 @@ def __init__(self, state):
 
     def get_job(self, job_str=None):
         """Retrieves the status or details of the specified job."""
+        self.state.print_status(description="Retrieving job data...")
 
         status_data = self.info.read_status()
 
@@ -36,11 +37,12 @@ def get_job(self, job_str=None):
         else:
             jobs = status_data["jobs"][job_str]
 
-        self.state.print_status(endpoint_json=jobs)
+        self.state.print_status(endpoint_json=jobs, update_only=True)
         return jobs
 
     def set_job(self, job_str, status_message, value):
         """Initiates or modifies job with given parameters."""
+        self.state.print_status(description=f"Marking job {job_str} as {value}% {status_message}.")
 
         lua_code = f"""
             local job_name = "{job_str}"
@@ -55,15 +57,12 @@ def set_job(self, job_str, status_message, value):
 
         self.resource.lua(lua_code)
 
-        self.state.print_status(description=f"Marked job {job_str} as {value}% complete.")
-
     def complete_job(self, job_str):
         """Marks job as completed and triggers any associated actions."""
+        self.state.print_status(description=f"Marking job {job_str} as `complete`.")
 
         lua_code = f"""
             complete_job("{job_str}")
         """
 
         self.resource.lua(lua_code)
-
-        self.state.print_status(description=f"Marked job {job_str} as `complete`.")

functions/messages.py

@@ -36,6 +36,7 @@ def __init__(self, state):
 
     def log(self, message_str, message_type="info", channel="ticker"):
         """Sends new log message via the API."""
+        self.state.print_status(description="Sending new log message to the API.")
 
         validate_log_options(message_type, channel)
 
@@ -47,10 +48,9 @@ def log(self, message_str, message_type="info", channel="ticker"):
 
         self.info.api_post("logs", log_message)
 
-        self.state.print_status(description="New log message sent via API.")
-
     def message(self, message_str, message_type="info", channel="ticker"):
         """Sends new log message via the message broker."""
+        self.state.print_status(description="Sending new log message to the message broker.")
 
         validate_log_options(message_type, channel)
 
@@ -70,18 +70,14 @@ def message(self, message_str, message_type="info", channel="ticker"):
 
         self.broker.publish(message)
 
-        self.state.print_status(description="New log message sent via message broker.")
-
     def debug(self, message_str):
         """Sends debug message used for developer information or troubleshooting."""
+        self.state.print_status(description="Sending debug message to the message broker.")
 
         self.message(message_str, "debug", "ticker")
 
-        self.state.print_status(description="New debug message sent via message broker.")
-
     def toast(self, message_str):
         """Sends a message that pops up on the user interface briefly."""
+        self.state.print_status(description="Sending toast message to the message broker.")
 
         self.message(message_str, "info", "toast")
-
-        self.state.print_status(description="New toast message sent via message broker.")

functions/movements.py

@@ -13,6 +13,13 @@
 from .broker import BrokerConnect
 from .information import Information
 
+AXES = ["x", "y", "z", "all"]
+
+def validate_axis(axis):
+    """Validate axis."""
+    if axis not in AXES:
+        raise ValueError(f"Invalid axis: {axis} not in {AXES}")
+
 class MovementControls():
     """MovementControls class."""
     def __init__(self, state):
@@ -22,6 +29,7 @@ def __init__(self, state):
 
     def move(self, x, y, z):
         """Moves to the specified (x, y, z) coordinate."""
+        self.state.print_status(description=f"Moving to ({x}, {y}, {z}).")
 
         def axis_overwrite(axis, value):
             return {
@@ -49,11 +57,11 @@ def axis_overwrite(axis, value):
 
         self.broker.publish(move_message)
 
-        self.state.print_status(description=f"Moved to coordinates: ({x}, {y}, {z}).")
-        return x, y, z
-
     def set_home(self, axis="all"):
         """Sets the current position as the home position for a specific axis."""
+        self.state.print_status(description="Setting home position")
+
+        validate_axis(axis)
 
         set_home_message = {
             "kind": "zero",
@@ -63,10 +71,11 @@ def set_home(self, axis="all"):
         }
         self.broker.publish(set_home_message)
 
-        self.state.print_status(description="Updated home coordinate.")
-
     def find_home(self, axis="all", speed=100):
         """Moves the device to the home position for a specified axis."""
+        self.state.print_status(description="Finding home position")
+
+        validate_axis(axis)
 
         if speed > 100 or speed < 1:
             error = "ERROR: Speed constrained to 1-100."
@@ -83,10 +92,11 @@ def find_home(self, axis="all", speed=100):
         }
         self.broker.publish(message)
 
-        self.state.print_status(description="Moved to home position.")
-
     def find_axis_length(self, axis="all"):
         """Finds the length of a specified axis."""
+        self.state.print_status(description="Finding axis length")
+
+        validate_axis(axis)
 
         find_axis_length_message = {
             "kind": "calibrate",
@@ -99,6 +109,7 @@ def find_axis_length(self, axis="all"):
 
     def get_xyz(self):
         """Returns the current (x, y, z) coordinates of the FarmBot."""
+        self.state.print_status(description="Getting current coordinates")
 
         tree_data = self.info.read_status()
         if tree_data is None:
@@ -112,13 +123,15 @@ def get_xyz(self):
         y_val = position["y"]
         z_val = position["z"]
 
-        self.state.print_status(description=f"Current coordinate: ({x_val}, {y_val}, {z_val}).")
+        self.state.print_status(description=f"Current position: {position}.", update_only=True)
         return position
 
     def check_position(self, user_x, user_y, user_z, tolerance):
         """Verifies position of the FarmBot within specified tolerance range."""
 
         user_values = {'x': user_x, 'y': user_y, 'z': user_z}
+        self.state.print_status(description=f"Checking if position is {user_values} with tolerance: {tolerance}.")
+
         actual_vals = self.get_xyz()
 
         if actual_vals is None:
@@ -132,8 +145,12 @@ def check_position(self, user_x, user_y, user_z, tolerance):
             user_value = user_values[axis]
             actual_value = actual_vals[axis]
             if not actual_value - tolerance <= user_value <= actual_value + tolerance:
-                self.state.print_status(description=f"Farmbot is NOT at position\n Current coordinates: ({x_val}, {y_val}, {z_val}).")
+                self.state.print_status(
+                    description=f"Farmbot is NOT at position.\n Current position: {actual_vals}.",
+                    update_only=True)
                 return False
 
-        self.state.print_status(description=f"Farmbot is at position: ({x_val}, {y_val}, {z_val}).")
+        self.state.print_status(
+            description=f"Farmbot is at position: {actual_vals}.",
+            update_only=True)
         return True

functions/peripherals.py

@@ -21,6 +21,7 @@ def __init__(self, state):
 
     def control_servo(self, pin, angle):
         """Set servo angle between 0-100 degrees."""
+        self.state.print_status(description=f"Setting servo angle to {angle}.")
 
         if angle < 0 or angle > 180:
             error = "ERROR: Servo angle constrained to 0-180 degrees."
@@ -38,7 +39,6 @@ def control_servo(self, pin, angle):
 
         self.broker.publish(control_servo_message)
 
-        self.state.print_status(description=f"Set servo angle to {angle}.")
         return
 
     def control_peripheral(self, peripheral_name, value, mode=None):

functions/resources.py

@@ -47,7 +47,7 @@ def __init__(self, state):
 
     def sequence(self, sequence_name):
         """Executes a predefined sequence."""
-        self.state.print_status(description="Triggering {sequence_name} sequence.")
+        self.state.print_status(description="Running {sequence_name} sequence.")
 
         sequence = self.info.get_resource_by_name("sequences", sequence_name, "name")
         if sequence is None:
@@ -140,6 +140,7 @@ def get_seed_tray_cell(self, tray_name, tray_cell):
 
     def detect_weeds(self):
         """Scans the garden to detect weeds."""
+        self.state.print_status(description="Detecting weeds...")
 
         detect_weeds_message = {
             "kind": "execute_script",
@@ -152,6 +153,7 @@ def detect_weeds(self):
 
     def lua(self, code_snippet):
         """Executes custom Lua code snippets to perform complex tasks or automations."""
+        self.state.print_status(description="Running Lua code")
 
         lua_message = {
             "kind": "lua",
@@ -162,12 +164,10 @@ def lua(self, code_snippet):
 
         self.broker.publish(lua_message)
 
-        self.state.print_status(description="Triggered lua code execution .")
-
     def if_statement(self, variable, operator, value, then_sequence_name=None, else_sequence_name=None, named_pin_type=None):
         """Performs conditional check and executes actions based on the outcome."""
 
-        self.state.print_status(description="Triggering if statement.")
+        self.state.print_status(description="Executing if statement.")
 
         validate_if_statement_args(named_pin_type, variable, operator)
         if named_pin_type is not None:
@@ -213,7 +213,7 @@ def if_statement(self, variable, operator, value, then_sequence_name=None, else_
 
     def assertion(self, code, assertion_type, recovery_sequence_name=None):
         """Evaluates an expression."""
-        self.state.print_status(description="Triggering assertion.")
+        self.state.print_status(description="Executing assertion.")
 
         validate_assertion_type(assertion_type)