This is a fork of Klipper based on the code shipped by Artillery for the Sidewinder X4 Plus (mostly copy&pasted and slightly refactored). I'm not an Artillery employee, I just ported the changes shipped by Artillery to the latest master. Also, I'm new to klipper and 3d-printing in general, the changelog below might be completely wrong. Their Changes in the latest update were based on commit 3387a9c23d940c7d449f197b272616eda11a5e3d from Sun Jul 24 08:49:25 2022 -0400

How to update klipper:

1. Change klipper repo to this fork:

   sudo systemctl stop klipper
   cd ~
   mv klipper klipper_bak
   git clone https://github.com/Gordin/klipper.git
   cd klipper
   git checkout sidewinderX4Plus
   

2. Copy prepared printer.cfg from this repo

   cp ~/klipper/config/printer-artillery-sidewinder-x4-plus-1.5.cfg ~/klipper_config/printer.cfg
   

3. Flash/Install klipper with flash script. You can use this script later to flash again This will flash WITHOUT Bootloader for the MCU. If you need a Bootloader for some reason, you probably know how to adjust things yourself. The menuconfig config file used in the script is ./.config_stm32f401.

   cd ~/klipper
   ./flash.sh
   

4. restart klipper (or skip and continue with moonraker update)

   sudo systemctl restart klipper
   

How to update moonraker:

1. Change moonraker repo to fork with artillery additions:

   sudo systemctl stop klipper moonraker moonraker-obico.service makerbase-client
   cd ~
   mv moonraker moonraker_bak
   git clone https://github.com/Gordin/moonraker.git
   cd moonraker
   git checkout sidewinderX4Plus
   

2. Link custom moonraker.conf from the repo

   ln -sf ~/moonraker/artillery_stuff/moonraker.conf klipper_config/moonraker.conf
   

3. setup folder structure for moonraker

   mkdir -p ~/printer_data
   ln -nsf ~/klipper_config ~/printer_data/config
   ln -nsf ~/.moonraker_database ~/printer_data/database
   ln -nsf ~/gcode_files ~/printer_data/gcodes
   ln -nsf ~/klipper_logs ~/printer_data/logs
   

4. Setup timelaps plugin

   cd ~/moonraker-timelapse-main
   make install
   

5. Restart services

   sudo systemctl restart klipper moonraker moonraker-obico.service makerbase-client
   

Changelog (made by me, not Artillery):

• config/printer-artillery-sidewinder-x4-plus-1.5.cfg
  • This is the config file directly from the 1.5 system image. It will NOT work in the default place, this is just for reference. Their setup has a folder ~/klipper_config with different config files. This one is called printer.cfg there. it also imports some other configs that are found in that folder. At least one of those is probably updated by some automated script to populate it with the correct file under /dev/serial/by-id/... to communicate with the MCU.
• klippy/configfile.py
  • After saving the config file, firmware and host Software is restarted, instead of just the host
• klippy/extras/fan.py
  • Adds a max_power and value to the status of fans
  • max_power just has the internal max_power value of that fan
  • value is the value was set last with set_speed. The difference to the speed value is, that value will return the last value that set_speed was called with, ignoring if the speed that was ultimately set was actually different (because of other factors like off_below or max_power).
  • Adds HIGH_FAN_SPEED and LOW_FAN_SPEED command. Those set a max speed of 100% and 80% respectively, and scale the current fan speed down accordingly. I didn't like that approach, because setting the speed directly after using this would brake this scaling, so I made a change to the M106 command that will also apply this scaling. (No idea if this Artillery already accounted for this in their interface, but I care more about this behaving as expected when a scaling is applied. Maybe I'll take this out again if it acts strange 🤷)
• klippy/extras/filament_switch_sensor.py
  • Huge increase to the default pause_delay and event_delay for the Filament Runout Sensor from 0.5 to 10 and 3.0 to 30.0 respectively
• klippy/extras/gcode_move.py
  • Adds new GET_GCODE_STATE handler for GCodeMove and a new MKS_GET_STATE command. I'm not entirely sure what those do, but I'm guessing it reads stuff from /home/mks/mks_plr/gcode_move/... to sync the state of the mcu and the rpi?
• klippy/extras/heater_bed.py
  • respond_info call when starting and finishing bed heating with M190. (Is respond_info just logging or does it do stuff?)
• klippy/extras/probe.py
  • Instead of stopping when Probe samples exceed samples_tolerance, just ignore it, stop probing, and calculate the average whith the values that are already there. (wtf?) I reverted that change and put it in a comment. Now it works like normal (When the maximum amount of failures is exceeded, probing is aborted and printing doesn't start).
  • Adds z-offset to get_status of probes
  • Adds MKS28 and RESET_ZOFFSET commands to the probing stuff MKS28 sems to be G28, but it compensates for the probe position/offset. RESET_ZOFFSET sets the z-offset to 0 in the config file
  • they added their own counter for how many times each point is probed. I removed this, since current klipper has its own counter for this
• klippy/extras/virtual_sdcard.py

  • Adds POC_PRINT_FILE command ("Loads a SD file and resume the print.") Literally just gcmd.respond_raw("POC"). No idea what that does though 🤷

  • Adds MKS_LOAD_FILE_POSITION command. Reads some files under /home/mks/mks_plr/... and then does

    G28
    G90
    G1 X<X-POS> Y<Y-POS> Z<Z-POS> (values from mks_plr/gcode_move/position)
    M109 S<mks_plr/extruder/target>
    M190 S<mks_plr/heater_bed/target>
    

    And sets current file_position to a value from mks_plr/virtual_sdcard/file_position.

    Looks like a recovery routine for interrupted prints?

  • Adds SDCARD_SELECT_FILE command ("Select a SD file. May include files in subdirectories."). Does exactly the same as SDCARD_PRINT_FILE, but it just loads the file but then doesn't try to do_resume (print it) after. I refactored that part a bit. In the Artillery code, they literally copy&pasted SDCARD_PRINT_FILE and commented out the self.do_resume() at the end.

  • They also left a # logging.info("%s", lines) for debugging. I left them in case someone else wants to debug stuff...

• klippy/extras/shaper_calibrate.py
  • Replaced original AUTOTUNE_SHAPERS array that has 5 different shapers with just array with just ['zv']
  • Gave the find_best_shaper method an extra parameter axis_name
  • They use this parameter to force the frequency to be between 33 and 38 for the y-axis:

    if (shaper.freq < 33 and axis_name == 'y'):
        shaper = shaper._replace(freq=33)
    if (shaper.freq > 38 and axis_name == 'y'):
        shaper = shaper._replace(freq=38)
    

  • I removed their modifications here since I want to test the different methods for myself
• klippy/extras/resonance_tester.py
  • Added axis_name to the call to find_best_shaper. I also removed this change
• klippy/gcode.py
  • they commented out self.gcode_handlers = self.base_gcode_handlers in _handleShutdown(self). I'm guessing they don't want their custom handlers to be cleared? I don't know where they are changing anything with the handlers that wouldn't also change it in the base handlers, so I commented it in again and kept the extra commented line in the file.
• klippy/kinematics/extruder.py
  • Adds K109 as an alias to M109?
  • Adds respond_infos around M109 command to log when heating starts and finishes
  • I'm not sure why they not either just use M109 instead of their custom K109. The change to the M109 command suggests that they ALWAYS assume M109 be called by the MKS anyway?
• klippy/mcu.py
  • Doubles TRSYNC_TIMEOUT from 0.025 to 0.05 (in seconds I guess)

Welcome to the Klipper project!

https://www.klipper3d.org/

Klipper is a 3d-Printer firmware. It combines the power of a general purpose computer with one or more micro-controllers. See the features document for more information on why you should use Klipper.

To begin using Klipper start by installing it.

Klipper is Free Software. See the license or read the documentation. We depend on the generous support from our sponsors.