Develop into beta

.github/workflows/pull-request.yml

@@ -8,17 +8,30 @@ permissions:
 
 jobs:
   checks:
+    name: ${{ matrix.name }} Checks
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Standard
+            requirements: ./ci/standard-requirements.txt
+            python-version: 3.9
+          - name: K1
+            requirements: ./ci/k1-requirements.txt
+            python-version: 3.8
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - name: Set Up Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.12
+          python-version: ${{ matrix.python-version }}
           cache: "pip"
-      - run: pip install -r requirements.txt
+      - run: pip install cython wheel
+      - run: pip install -r ${{ matrix.requirements }}
       - name: Linting
         uses: astral-sh/ruff-action@v1
         continue-on-error: true # let's remove this once ruff has been implemented in scanner.py
       - name: Type check
-        run: pip install basedpyright && basedpyright
+        run: |
+          pip install basedpyright && basedpyright

DEVELOPMENT.md

@@ -25,3 +25,9 @@ Inside [./typings] is a file named after the module with some dummy classes.
 These are the modules that our code will be checked against when pyright is executed.
 We can improve our confidence by ensuring these are well defined and up to date with the actual code.
 The files that we import with `from . import probe` are reexported in [./__init__.py] to allow pyright to infer this.
+
+## Testing changes
+
+A convenience macro, [./cartographer_ci_test.cfg], has been made to help us test changes.
+This can be linked into your `printer_data/configs` and included in `printer.cfg` for ease of use.
+We should strive to keep this up to date.

cartographer_ci_test.cfg

@@ -0,0 +1,36 @@
+[respond]
+
+[gcode_macro CARTOGRAPHER_CI_TEST]
+variable_stages = ["G28", "PROBE", "PROBE_ACCURACY", "BED_MESH_CALIBRATE", "CARTOGRAPHER_CALIBRATE METHOD=manual", "CARTOGRAPHER_THRESHOLD_SCAN", "CARTOGRAPHER_CALIBRATE", "CARTOGRAPHER_TOUCH"]
+variable_stage_index = 0
+gcode:
+  {% set stage_count = stages | length %}
+  {action_respond_info("Executing %s" % (stages[stage_index]))}
+  {stages[stage_index]}
+  M400
+  G28 Z
+  {% set next_index = stage_index + 1 %}
+  RESPOND TYPE=command MSG='{"action:prompt_begin Cartographer CI Tests [%d / %d]" % (next_index, stage_count)}'
+  {% if next_index < stage_count %}
+    RESPOND TYPE=command MSG='{"action:prompt_text Next test is %s" % (stages[next_index])}'
+    RESPOND TYPE=command MSG="action:prompt_footer_button ABORT|_CARTOGRAPHER_CI_TEST_ABORT|error"
+    RESPOND TYPE=command MSG="action:prompt_footer_button Continue|_CARTOGRAPHER_CI_TEST_CONTINUE|primary"
+  {% else %}
+    RESPOND TYPE=command MSG="action:prompt_text All tests completed!!"
+    SET_GCODE_VARIABLE MACRO=CARTOGRAPHER_CI_TEST VARIABLE=stage_index VALUE=0
+  {% endif %}
+  RESPOND TYPE=command MSG="action:prompt_show"
+
+[gcode_macro _CARTOGRAPHER_CI_TEST_CONTINUE]
+gcode:
+  RESPOND TYPE=command MSG="action:prompt_end"
+  {% set vars = printer["gcode_macro CARTOGRAPHER_CI_TEST"]%}
+  SET_GCODE_VARIABLE MACRO=CARTOGRAPHER_CI_TEST VARIABLE=stage_index VALUE={vars.stage_index + 1}
+  CARTOGRAPHER_CI_TEST
+
+[gcode_macro _CARTOGRAPHER_CI_TEST_ABORT]
+gcode:
+  RESPOND TYPE=command MSG="action:prompt_end"
+  SET_GCODE_VARIABLE MACRO=CARTOGRAPHER_CI_TEST VARIABLE=stage_index VALUE=0
+  {action_respond_info("Cartographer CI tests aborted.")}
+

ci/k1-requirements.txt

@@ -0,0 +1,11 @@
+greenlet==0.4.15
+Jinja2==2.11.3
+kiwisolver==1.1.0
+MarkupSafe==1.1.1
+matplotlib==2.2.3
+numpy==1.16.4
+Pillow==7.0.0
+pyparsing==2.4.2
+pyserial==3.4
+python-dateutil==2.8.1
+numpy-stubs@git+https://github.com/numpy/numpy-stubs.git

ci/standard-requirements.txt

@@ -0,0 +1,13 @@
+greenlet==2.0.2
+importlib_resources==6.4.5
+Jinja2==2.11.3
+kiwisolver==1.4.7
+MarkupSafe==1.1.1
+matplotlib==3.9.2
+numpy==1.23.4
+pillow==11.0.0
+pyparsing==3.2.0
+pyserial==3.4
+python-can==3.3.4
+python-dateutil==2.9.0.post0
+scipy==1.13.1

firmware.sh

@@ -1,13 +1,20 @@
 #!/bin/bash
 
-SCRIPT_VERSION="v1.2.0"
+SCRIPT_VERSION="v1.2.1"
 
-while getopts s:t:f:b: flag; do
+while getopts s:t:f:b:ht flag; do
   case "${flag}" in
-  s) switch=${OPTARG} ;;
-  t) ftype=${OPTARG} ;;
-  f) flash=${OPTARG} ;;
-  b) branch=${OPTARG} ;;
+  s) switch=${OPTARG} ;; # Argument for -s
+  t) ftype=${OPTARG} ;;  # Argument for -t
+  f) flash=${OPTARG} ;;  # Argument for -f
+  b) branch=${OPTARG} ;; # Argument for -b
+  h) hightemp=true ;;    # Set hightemp to true if -h flag is present
+  t)                     # Handle 't' as required, though there may be a conflict with `ht` as written
+    ;;
+  *)
+    echo "Invalid option: -$flag" >&2
+    exit 1
+    ;;
   esac
 done
 # Define repository URLs
@@ -85,7 +92,9 @@ ${NC}"
   printf "${RED}Firmware Script ${NC} ${SCRIPT_VERSION}\n"
   printf "Created by ${GREEN}KrauTech${NC} ${BLUE}(https://github.com/krautech)${NC}\n"
   echo
-  echo
+  if [[ $hightemp ]]; then
+    printf "${BLUE}Flashing High Temp Firmware${NC}\n"
+  fi
   printf "${RED}###################################################################################${NC}\n"
   #echo $switch
   #echo $ftype
@@ -634,12 +643,25 @@ flashFirmware() {
         for folder in "${folders[@]}"; do
           if [[ -d "$folder" ]]; then
             folder_name=$(basename "$folder")
-            # List the files inside each folder using the same search pattern
-            for file in "$folder"/$search_pattern; do
-              if [[ -f "$file" ]]; then
-                options+=("${folder_name}/$(basename "$file")")
+
+            # Check if $hightemp is true
+            if [[ $hightemp ]]; then
+              # Process only if "HT" subdirectory exists
+              if [[ -d "$folder/HT" ]]; then
+                for file in "$folder"/$search_pattern; do
+                  if [[ -f "$file" ]]; then
+                    options+=("${folder_name}/HT/$(basename "$file")")
+                  fi
+                done
               fi
-            done
+            else
+              # Process all folders regardless of "HT" subdirectory
+              for file in "$folder"/$search_pattern; do
+                if [[ -f "$file" ]]; then
+                  options+=("${folder_name}/$(basename "$file")")
+                fi
+              done
+            fi
           fi
         done
       fi
@@ -722,12 +744,25 @@ flashFirmware() {
         for folder in "${folders[@]}"; do
           if [[ -d "$folder" ]]; then
             folder_name=$(basename "$folder")
-            # List the files inside each folder using the same search pattern
-            for file in "$folder"/$search_pattern; do
-              if [[ -f "$file" ]]; then
-                options+=("${folder_name}/$(basename "$file")")
+
+            # Check if $hightemp is true
+            if [[ $hightemp ]]; then
+              # Process only if "HT" subdirectory exists
+              if [[ -d "$folder/HT" ]]; then
+                for file in "$folder"/$search_pattern; do
+                  if [[ -f "$file" ]]; then
+                    options+=("${folder_name}/HT/$(basename "$file")")
+                  fi
+                done
               fi
-            done
+            else
+              # Process all folders regardless of "HT" subdirectory
+              for file in "$folder"/$search_pattern; do
+                if [[ -f "$file" ]]; then
+                  options+=("${folder_name}/$(basename "$file")")
+                fi
+              done
+            fi
           fi
         done
       fi
@@ -764,18 +799,30 @@ flashFirmware() {
     archive_dir="$CARTOGRAPHER_KLIPPER_DIR/firmware/v2-v3/combined-firmware" # Corrected path
     if [[ -d $archive_dir ]]; then
       # Get the folder names sorted from largest to smallest version
-      cd $archive_dir
       folders=($(ls -d "$archive_dir"/*/ | sort -rV))
 
       for folder in "${folders[@]}"; do
         if [[ -d "$folder" ]]; then
           folder_name=$(basename "$folder")
-          # List the files inside each folder using the same search pattern
-          for file in "$folder"/$search_pattern; do
-            if [[ -f "$file" ]]; then
-              options+=("${folder_name}/$(basename "$file")")
+
+          # Check if $hightemp is true
+          if [[ $hightemp ]]; then
+            # Process only if "HT" subdirectory exists
+            if [[ -d "$folder/HT" ]]; then
+              for file in "$folder"/$search_pattern; do
+                if [[ -f "$file" ]]; then
+                  options+=("${folder_name}/HT/$(basename "$file")")
+                fi
+              done
             fi
-          done
+          else
+            # Process all folders regardless of "HT" subdirectory
+            for file in "$folder"/$search_pattern; do
+              if [[ -f "$file" ]]; then
+                options+=("${folder_name}/$(basename "$file")")
+              fi
+            done
+          fi
         fi
       done
     fi
@@ -855,12 +902,25 @@ flashFirmware() {
         for folder in "${folders[@]}"; do
           if [[ -d "$folder" ]]; then
             folder_name=$(basename "$folder")
-            # List the files inside each folder using the same search pattern
-            for file in "$folder"/$search_pattern; do
-              if [[ -f "$file" ]]; then
-                options+=("${folder_name}/$(basename "$file")")
+
+            # Check if $hightemp is true
+            if [[ $hightemp ]]; then
+              # Process only if "HT" subdirectory exists
+              if [[ -d "$folder/HT" ]]; then
+                for file in "$folder"/$search_pattern; do
+                  if [[ -f "$file" ]]; then
+                    options+=("${folder_name}/HT/$(basename "$file")")
+                  fi
+                done
               fi
-            done
+            else
+              # Process all folders regardless of "HT" subdirectory
+              for file in "$folder"/$search_pattern; do
+                if [[ -f "$file" ]]; then
+                  options+=("${folder_name}/$(basename "$file")")
+                fi
+              done
+            fi
           fi
         done
       fi
@@ -968,7 +1028,7 @@ flashing() {
     if [[ $usbID != "" ]] && [[ $3 == "usb" ]] && [[ $flashed == 0 ]]; then
       echo "Flashing USB Device $usbID"
       # FLash USB Firmware
-      ~/klippy-env/bin/python ~/klipper/lib/canboot/flash_can.py -f $firmwareFile -d /dev/serial/by-id/$usbID
+      python3 ~/katapult/scripts/flash_can.py -f $firmwareFile -d /dev/serial/by-id/$usbID
       read -p "Press enter to continue"
       display_flashed $cartoID "usb" $survey
       flashed=1

pyproject.toml

@@ -1,4 +1,5 @@
 [tool.pyright]
+pythonVersion = "3.8"
 include = ["scanner.py"]
 reportMissingModuleSource = false     # klippy imports are always missing sources
 reportPrivateLocalImportUsage = false
@@ -8,4 +9,5 @@ reportUninitializedInstanceVariable = false
 failOnWarnings = false
 
 [tool.ruff]
+target-version = "py38"
 include = ["scanner.py"]

requirements.txt

@@ -1,4 +1,4 @@
 # klipper python virtual environment requirements for Cartographer
-numpy>=1.16.6
-scipy>=1.10.0
-matplotlib>=3.7.0
+numpy~=1.16
+scipy~=1.10
+matplotlib~=3.7