-
Notifications
You must be signed in to change notification settings - Fork 7
Simple AF
I AM NOT RESPONSIBLE FOR DAMAGE TO YOUR PRINTER - INSTALLING CUSTOM FIRMWARE IS A RISK
The Simple AF project is for anyone who wants to use a different probe with their K1, K1C or K1 Max and use vanilla klipper and no Creality Gcode.
This project supports the following probes:
- Cartographer
- Beacon EXPERIMENTAL
- BTT Eddy
- Microprobe
- BLTouch, 3dTouch, CrTouch
There is a separate guide for each probe
-
If you have a Cartographer follow the Cartographer guide
-
If you have a Beacon follow the Beacon guide
-
If you have a BTT Eddy, follow the BTT Eddy guide
-
If you have a Microprobe, follow the Microprobe guide
-
If you have a BLTouch, 3dTouch or CrTouch follow the Bltouch guide
The installation script will perform the following steps:
- Disable creality services
- Install Emergency Factory Reset feature
- Install Bash
- Replace Creality cam_app and old mjpg_streamer with entware mjpg_streamer
- Install Moonraker
- Install Moonraker Timelapse - no longer enabled by default
- Install Nginx
- Install Fluidd and Fluidd Config
- Install Mainsail
- Install KAMP
- Install Vanilla Klipper
- Install Guppyscreen
- Setup the probe of course
Octoeverywhere cannot be installed onto the K1 when running the Cartographer, the stress placed on the system by running octoeverywhere is too great, however the octoeverywhere companion running on another device on the same WIFI network as the K1 works great.
https://blog.octoeverywhere.com/octoeverywhere-companion-remote-access-for-any-klipper-printer/
It is also possible to install mobileraker companion on a separate device
https://github.com/Clon1998/mobileraker_companion?tab=readme-ov-file#standalone-installation
Moonraker timelapse is installed but not enabled by default. To enable it there are a few steps, you need to add the following include to printer.cfg:
[include timelapse.cfg]
And uncomment the [include timelapse.conf]
in moonraker.conf, you will need to restart moonraker and klipper after this, you can that via the fluidd or mainsail services section.
If you see these messages:
15:14:24 // Unknown command:"_SET_TIMELAPSE_SETUP"
15:14:24 // Unknown command:"HYPERLAPSE"
It means you have not as yet properly restarted moonraker and/or klipper. If in doubt just power cycle your machine.
Because the single web cam is controlled via moonraker with the webcam.conf file, the Timelapse camera dropdown menu won't let you choose a camera, this is expected.
The /etc/init.d/S58factoryreset has recently been updated not to delete the /etc/localtime, so you can configure it once and it should survive any number of factory resets, following the excellent guide here: https://guilouz.github.io/Creality-Helper-Script-Wiki/firmwares/change-date-and-time/
To update your installation with the latest fixes you should run:
/usr/data/pellcorp/k1/installer.sh --branch main
/usr/data/pellcorp/k1/installer.sh --update
This backs up your customisations, updates the creality repo, applies all changes to your /usr/data/printer_data/config
directory and then reapplies your customisations over the top.
Refer to Update or Reinstall - What gets overriden
A reinstall is only needed if you are switching probes or one or more github repos have got into an inconsistent state, so you can force a reinstall with the --reinstall
argument in place of the --install
argument. The difference to a --install
, is a --install
will only finish up a partial install that failed due to a network failure or the like.
Refer to Update or Reinstall - What gets overriden
If the worst happens and you somehow get locked out (for instance for whatever reason the dropbear ssh session does not start or wifi config gets all screwy, it is possible to trigger a emergency factory reset.
It is very easy, you just need to create a empty file called emergency_factory_reset
on a USB key and make sure the USB key is plugged in, then power cycle the printer, this will initiate a factory reset.
IMPORTANT: This factory reset method will rename the emergency_factory_reset
to emergency_factory_reset.old
to avoid a boot loop, so if you need to use this method again you will need to rename the file.
IMPORTANT: This factory reset method will not remove the special service file /etc/init.d/S58factoryreset
from the k1, so if you need it you can redo a factory reset even before reinstalling.
Note: This method does not reset wifi or root access
Simple AF Beacon EXPERIMENTAL
Simple AF Bltouch, CrTouch and 3dTouch
If you are looking for a way to support the project, and its entirely optional, this is my preferred approach. I am conducting a fundraiser to purchase a K1M printer, just so I can push out fixes and new features a bit faster, but also specifically test the K1M as well as the K1.
If you can't donate via go fund me directly, I have also added a kofi account.