Merge pull request #12 from AFCProject/emu_claymore_updates

  * Updated installation guide with clearer wording and expanded post-install setup, including AFC splash screen options and verification steps.
  * Added HTLF2-Claymore coverage to startup self-test and additional test lane-selection guidance, with shared lane-selection instructions.
  * Improved `PRINT_START` macro documentation by clarifying the example flow and initial tool handling.
  * Refined `enable_kick_start` help text and added HTLF2-Claymore’s inherited settings/macro documentation.

Author: jimmyjon711

AFC-Klipper-Add-On

@@ -259,7 +259,7 @@ timer_delay: 5
 #    overrides values set in unit (AFC_BoxTurtle/NightOwl/etc) section.
 enable_kick_start: True
 #    Default: True
-#    Enables full speed espoolers for `kick_start_time` amount to
+#    Enables full speed espooler's for `kick_start_time` amount to
 #    help spools to start moving. Setting value here overrides values
 #    set in unit (AFC_BoxTurtle/NightOwl/etc) section.
 kick_start_time: 0.070
@@ -734,7 +734,7 @@ timer_delay: 5
 #    Can be overridden in the [AFC_stepper] section.
 enable_kick_start: True
 #    Default: True
-#    Enables full speed espoolers for `kick_start_time` amount to
+#    Enables full speed espooler's for `kick_start_time` amount to
 #    help spools to start moving
 #    Can be overridden in the [AFC_stepper] section.
 kick_start_time: 0.070
@@ -1091,6 +1091,11 @@ To switch to a hub that uses a sensor, remove `use_dist_hub: True` and set your
 update `dist_hub` in each `AFC_stepper` section to be around what the PTFE length is between the load sensor and hub sensor. Make sure you run calibration as this
 will then be calibrated to the correct distance.
 
+## [AFC_Claymore unit_name] Section
+
+HTLF2-Claymore logic is setup to inherit the same settings and macros as an AFC_vivid unit, please refer to the [AFC_vivid](#afc_vivid-unit_name-section) section for macros and configs that are specific to a HTLF2-Claymore unit.
+
+
 ## [servo tool_cut] Section
 
 The following options are available for all units (BoxTurtle, HTLF, and NightOwl) and allow for the configuration and 

docs/configuration/AFC_UnitType_1.cfg.md

@@ -1,6 +1,6 @@
 ## Install the AFC Klipper Add-On
 
-=== "All Automated Filament Changers"
+=== "Supported Automated Filament Changers"
 
     Your AFC unit works with the [AFC Klipper Add-On](https://github.com/AFCProject/AFC-Klipper-Add-On). The rest of
     this guide will focus on configuring AFC for use with your unit.
@@ -15,6 +15,15 @@
     ./install-afc.sh
     ```
 
+    After running `./install-afc.sh` you should now see an AFC splash screen with multiple options
+
+    1. Hit `I` then enter to start installing a new system
+    1. Installer defaults to a BoxTurtle unit, if you have something else, hit `T` then enter to cycle through the different supported units.
+    1. If you would like to enable/disable options 1-8, choose that option then hit enter to cycle through the options.
+    1. Installer defaults to using a buffer as a toolhead sensor, if you would like to use a toolhead sensor, hit `9` then enter to cycle until you see sensor. 
+        1. If you know you toolhead sensor pin now, hit `A` then enter and input your pin. If you need to add a pullup(`^`) add this to your pin definition now. ex: `^nh36_0:gpio3`
+    1. If there are unit specific options for your unit, please make sure these are selected correctly for your setup. ex. If you have a 2 lane EMU with a SLB board, make sure EMU Lane option is set to 2 and EMU board option is set to SLB.
+    1. Once everything is selected correctly, hit `I` then enter to install AFC and have the proper config files moved into your `printer_data/config/AFC` folder.
     The default options for the park, cut, kick, wipe, and tip forming macros can be used if you don't know what to choose.
     These can all be changed later by editing `AFC/AFC.cfg` and doing a firmware restart.
 
@@ -28,6 +37,7 @@
     ### Post-Installation Configuration
     After installation, please ensure you update the following settings:
 
+
     - In your unit-specific config file (e.g., `AFC/AFC_Turtle_1.cfg` for BoxTurtle):
         - `canbus_uuid` if using CAN bus
         - `serial` if using USB
@@ -48,6 +58,97 @@
 
     Review all x,y,z positions in the `AFC/AFC_Macro_Vars.cfg` file to ensure they are correct for your printer for any macros
     you have enabled.
+    
+    ### Unit specific checks
+    === "EMU"
+        !!! note
+            Throughout this guide you will see text like `EMU_(x)_lane(x)`, you will not see this in your config file. Instead you will see something like `EMU_1_lane1`, the x's are a place holder to signify a generic unit/lane number for your setup.
+        
+        #### Verify MCU config file
+        In AFC/mcu/EMU_(x).cfg file verify that mcu entries looks correct and has all your MCU lanes listed
+
+        #### Verify Temperature Sensor
+        Config file defaults to using BME280 temperature, if you are using the AHT20 sensor then the following needs to be updated in your AFC/AFC_EMU_(x).cfg file. There are also comments in this file to help you update to use the correct settings
+
+        1. In `[temperature_sensor lane(x)]` config sections comment out:
+            ```ini
+            sensor_type: BME280
+            i2c_address: 118
+            ```
+            and uncomment:
+            ```
+            sensor_type: AHT2X
+            i2c_address: 56
+            ```
+        1. If using SLB board and would like to use hardware I2C, comment out:
+            ```
+            i2c_software_scl_pin: EMU_(x)_lane(x):TEMP_SCL
+            i2c_software_sda_pin: EMU_(x)_lane(x):TEMP_SCA
+            ```
+            and uncomment:
+            ```
+            i2c_bus: i2c2_PB10_PB11
+            ```
+        1. Repeat for all lanes
+
+        #### Verifying Led Indicator Settings
+        Config file defaults to using ebb36/42 settings, if using SLB board make the following changes for all your lanes.
+
+        === "EBB36/42"
+            1. Uncomment the following AFC_led config section:
+                ```
+                [AFC_led EMU_(x)_Indicator_(x)]
+                pin: EMU_(x)_lane(x):RGB
+                chain_count: 5
+                color_order: GRBW
+                initial_RED: 0.0
+                initial_GREEN: 0.0
+                initial_BLUE: 0.0
+                initial_WHITE: 0.0
+                ```
+            1. Repeat for all lanes
+        === "SLB"
+
+            1. In `[AFC_stepper lane(x)]` config section comment out:
+                ```
+                led_index: EMU_(x)_Indicator_(x):1
+                led_spool_index: EMU_(x)_Indicator_(x):2
+                ```
+                and uncomment:
+                ```
+                led_index: EMU_(x)_Indicator_Button_(x):1-4
+                led_spool_index: EMU_(x)_Indicator_Box_(x):1
+                ```
+
+            1. Uncomment the following AFC_led config sections
+                ```
+                [AFC_led EMU_(x)_Indicator_Button_1]
+                pin: EMU_(x)_lane(x):RGB_button
+                chain_count: 4
+                color_order: GRBW
+                initial_RED: 0.0
+                initial_GREEN: 0.0
+                initial_BLUE: 0.0
+                initial_WHITE: 0.0
+
+                [AFC_led EMU_(x)_Indicator_Box_1]
+                pin: EMU_(x)_lane(x):RGB_box
+                chain_count: 1
+                color_order: GRBW
+                initial_RED: 0.0
+                initial_GREEN: 0.0
+                initial_BLUE: 0.0
+                initial_WHITE: 0.0
+                ```
+            1. Repeat for all lanes
+
+        #### Using non sensorless hubs
+        By default AFC EMU configs are setup to run with ["sensorless" hubs](../configuration/AFC_UnitType_1.cfg.md#notes-about-default-emu-config-setup), if you would like to use a hub sensor then make the following changes to your `[AFC_hub EMU_(x)_HUB]` section:
+
+        1. For `switch_pin` variable, replace `virtual` with the actual sensor pin you are using for you hub
+        1. In each `[AFC_stepper lane(x)]` sections update `dist_hub` to be closer to what your actual length is between your lanes load sensor and hub sensor.
+        1. Remove `use_dist_hub: True` line
+        1. Update `hub_clear_move_dis: 5` value to be closer to the value that AFC needs to move the filament so its not blocking the hub. Or this value can be removed and AFC will use the default value of 65
 
 
     For best results, reboot your printer after installing the Add-On and including it in your printer.cfg. This will ensure

docs/initial-startup/03-install-plugin.md

@@ -17,6 +17,13 @@ AFC will run a self-test automatically on startup, this is called the PREP routi
     After the self-test completes, you hopefully will see a `HTLF Ready` print out in the console log. If you get `HTLF Not Ready`, you may have a misconfigured AFC
     setting, broken pin or some other issue that needs attention.
 
+=== "HTLF2-Claymore"
+
+    The self-test will run through each lane from lane1 to lane2 selecting them if filament is loaded into a lane. AFC will also update the LED indicating status for each lane.
+
+    After the self-test completes, you hopefully will see a `Claymore Ready` print out in the console log. If you get `Claymore Not Ready`, you may have a misconfigured AFC
+    setting, broken pin or some other issue that needs attention.
+
 === "ViViD"
 
     The self-test will run through each lane from lane1 to lane2 selecting them and if filament is loaded into a lane AFC will try and feed to the load sensor to verify that the filament is loaded. AFC will also update the LED indicating status for each lane.

docs/initial-startup/04-self-test.md

@@ -49,31 +49,21 @@
     reports no errors, move on to the next step.
 === "HTLF"
 
-    ### Lane selection
-
-    Run ``AFC_SELECT_LANE`` command against each lane (once at a time) to verify proper lane selection operation:
-
-    - `AFC_SELECT_LANE LANE=lane1`
-    - `AFC_SELECT_LANE LANE=lane2`
-    - `AFC_SELECT_LANE LANE=lane3`
-    - `AFC_SELECT_LANE LANE=lane4`
+    --8<-- "includes/install/additional_tests_lane_selection.md"
 
     ### Homing Unit
 
     Run ``AFC_HOME_UNIT`` command to verify that unit moves selector back to home pin:
 
     - `AFC_HOME_UNIT UNIT=HTLF_1`
 
-=== "ViViD"
+=== "HTLF2-Claymore"
 
-    ### Lane selection
+    --8<-- "includes/install/additional_tests_lane_selection.md"
 
-    Run ``AFC_SELECT_LANE`` command against each lane (once at a time) to verify proper lane selection operation:
+=== "ViViD"
 
-    - `AFC_SELECT_LANE LANE=lane1`
-    - `AFC_SELECT_LANE LANE=lane2`
-    - `AFC_SELECT_LANE LANE=lane3`
-    - `AFC_SELECT_LANE LANE=lane4`
+    --8<-- "includes/install/additional_tests_lane_selection.md"
 
 === "EMU"
 

docs/initial-startup/05-additional-tests.md

@@ -1,8 +1,8 @@
 ## Updating your PRINT_START macro
 
 !!!info
-        Please note this is just an example macro to show how to incorporate the initial tool into your 
-        print start macro.
+    Please note this is just an example macro to show how to incorporate the initial tool into your 
+    print start macro.
 
 Please adjust it to match your printer setup. A good starting point for a PRINT_START macro
 is [jontek2's "A Better PRINT_START macro"](https://github.com/jontek2/A-better-print_start-macro)
@@ -28,8 +28,6 @@ gcode:
   AFC_PARK
 
   M140 S{BED_TEMP} # Set bed temp
-  M109 S{EXTRUDER_TEMP} # wait for extruder temp
-  T{initial_tool} #Load Initial Tool
 
   M104 S{S_EXTRUDER_TEMP} # set standby extruder temp
   M190 S{BED_TEMP} # wait for bed temp
@@ -39,7 +37,9 @@ gcode:
   # Bedmesh or load bedmesh
 
   AFC_PARK
-  M109 S{EXTRUDER_TEMP} ; wait for extruder temp
+
+  M109 S{EXTRUDER_TEMP} # wait for extruder temp
+  T{initial_tool} #Load Initial Tool
 
   # Add any pre print prime/purge line here
   # Start Print

docs/initial-startup/10-print-start-macro.md

@@ -0,0 +1,8 @@
+### Lane selection
+
+Run ``AFC_SELECT_LANE`` command against each lane (once at a time) to verify proper lane selection operation:
+
+- `AFC_SELECT_LANE LANE=lane1`
+- `AFC_SELECT_LANE LANE=lane2`
+- `AFC_SELECT_LANE LANE=lane3`
+- `AFC_SELECT_LANE LANE=lane4`