Fixing error when trying to turn leds back on, fixing spelling errors, and added comment for AFC_CLEAR_MESSAGE (#442)

Fixes LED reactivation errors, improves documentation for the AFC_CLEAR_MESSAGE macro, and surfaces led_state in the status API

Author: jimmyjon711

extras/AFC.py

@@ -83,6 +83,7 @@ def __init__(self, config):
         self.buffers    = {}
         self.tool_cmds  = {}
         self.led_obj    = {}
+        self.led_state  = True
         self.bypass     = None
         self.bypass_last_state = False
         self.message_queue = []
@@ -1584,6 +1585,7 @@ def get_status(self, eventtime=None):
         str["hubs"] = list(self.hubs.keys())
         str["buffers"] = list(self.buffers.keys())
         str["message"] = self._get_message()
+        str["led_state"] = self.led_state
         return str
 
     def _webhooks_status(self, web_request):
@@ -1613,6 +1615,7 @@ def _webhooks_status(self, web_request):
         str["system"]["extruders"]              = {}
         str["system"]["hubs"]                   = {}
         str["system"]["buffers"]                = {}
+        str["system"]["led_state"] = self.led_state
 
         for extruder in self.tools.values():
             str["system"]["extruders"][extruder.name] = extruder.get_status()
@@ -1712,6 +1715,7 @@ def cmd_TURN_OFF_AFC_LED(self, gcmd: Any) -> None:
         TURN_OFF_AFC_LED
         ```
         """
+        self.led_state = False
         for led in self.led_obj.values():
             led.turn_off_leds()
 
@@ -1730,6 +1734,7 @@ def cmd_TURN_ON_AFC_LED(self, gcmd):
         TURN_ON_AFC_LED
         ```
         """
+        self.led_state = True
         for led in self.led_obj.values():
             led.turn_on_leds()
 
@@ -1780,6 +1785,19 @@ def cmd_AFC_CHANGE_BLADE(self, gcmd):
 
     cmd_AFC_CLEAR_MESSAGE_help = "Macro to clear error and warning message from AFC message queue"
     def cmd_AFC_CLEAR_MESSAGE(self, gcmd):
+        """
+        This macro handles clearing one message at a time for messages that show up mainsail/klipperscreen/fluidd gui's.
+
+        USAGE
+        -----
+        `AFC_CLEAR_MESSAGE`
+
+        Example
+        -----
+        ```
+        AFC_CLEAR_MESSAGE
+        ```
+        """
         self._get_message(clear=True)
 
     cmd__AFC_TEST_MESSAGES_help = "Macro to send test messages for testing"

extras/AFC_HTLF.py

@@ -30,10 +30,10 @@ def __init__(self, config):
         self.selector_stepper_obj   = None
         self.current_selected_lane  = None
         self.home_state             = False
-        self.mm_move_per_rotation   = config.getint("mm_move_per_rotation", 32)                                     # How many mm moves pully a full rotation
+        self.mm_move_per_rotation   = config.getint("mm_move_per_rotation", 32)                                     # How many mm moves pulley a full rotation
         self.cam_angle              = config.getint("cam_angle")                                                    # CAM lobe angle thats currently installed. 30,45,60 (recommend using 60)
         self.home_pin               = config.get("home_pin")                                                        # Pin for homing sensor
-        self.MAX_ANGLE_MOVEMENT     = config.getint("MAX_ANGLE_MOVEMENT", 215)                                      # Max angle to move lobes, this is when lobe 1 is fully engauged with its lane
+        self.MAX_ANGLE_MOVEMENT     = config.getint("MAX_ANGLE_MOVEMENT", 215)                                      # Max angle to move lobes, this is when lobe 1 is fully engaged with its lane
         self.enable_sensors_in_gui  = config.getboolean("enable_sensors_in_gui", self.afc.enable_sensors_in_gui)    # Set to True to show prep and load sensors switches as filament sensors in mainsail/fluidd gui, overrides value set in AFC.cfg
         self.prep_homed             = False
         self.failed_to_home         = False

extras/AFC_led.py

@@ -51,6 +51,13 @@ def __init__(self, config):
         self.last_led_color = {}
         self.keep_leds_off = False
 
+        if hasattr(self.led_helper, "_set_color"):
+            self.ledHelper_set_color_fn = self.led_helper._set_color
+            self.check_transmit_fn = self.led_helper._check_transmit
+        else:
+            self.ledHelper_set_color_fn = self.led_helper.set_color
+            self.check_transmit_fn = self.led_helper.check_transmit
+
     def build_config(self):
         bmt = self.mcu.seconds_to_clock(BIT_MAX_TIME)
         rmt = self.mcu.seconds_to_clock(RESET_MIN_TIME)
@@ -115,34 +122,31 @@ def reactor_bgfunc(eventtime):
     def get_status(self, eventtime=None):
         return self.led_helper.get_status(eventtime)
 
-    def led_change(self, index, status, update_last=True):
-        if update_last: self.last_led_color[str(index)] = status
+    def set_color_fn(self, index, color, update_last=True):
+        if update_last: self.last_led_color[str(index)] = color
         if self.keep_leds_off: return
 
+        self.ledHelper_set_color_fn(index, color)
+
+    def led_change(self, index, status, update_last=True):
         if isinstance(status, list):
             colors = status
         else:
             colors=list(map(float,status.split(',')))
 
-        transmit = 1
+        transmit = not self.keep_leds_off
         def lookahead_bgfunc(print_time):
-            if hasattr(self.led_helper, "_set_color"):
-                set_color_fn = self.led_helper._set_color
-                check_transmit_fn = self.led_helper._check_transmit
-            else:
-                set_color_fn = self.led_helper.set_color
-                check_transmit_fn = self.led_helper.check_transmit
             if isinstance(index, str) and "-" in index:
                 start, end = map(int, index.split("-"))
                 for i in range(start, end + 1):
-                    set_color_fn(i, colors)
+                    self.set_color_fn(i, colors, update_last)
             elif isinstance(index, list):
                 for i in index:
-                    set_color_fn(i, colors)
+                    self.set_color_fn(i, colors, update_last)
             else:
-                set_color_fn(int(index), colors)
+                self.set_color_fn(int(index), colors, update_last)
             if transmit:
-                check_transmit_fn(print_time)
+                self.check_transmit_fn(print_time)
         toolhead = self.printer.lookup_object('toolhead')
         toolhead.register_lookahead_callback(lookahead_bgfunc)