Runbooks on Sovol on mainline Klipper

Over stock firmware

Mon, 01 Jan 0001 00:00:00 +0000

Runbook — migrating in place over the stock firmware#

The printer works and you migrate on top of it. The vendor OS stays, the application and MCU firmware move to upstream, and the OS is an optional last step. This is the incremental de-vendoring path.

Each step below is a link into the component that does the work — this page is only the order.

1. Back up everything first#

Vendor stack rsync, an SWD dump of the toolhead, and ideally a full eMMC image. The backups are what make every later step reversible. → Recovery: back up first

With an eMMC reader

Mon, 01 Jan 0001 00:00:00 +0000

Runbook — clean-slate build with an eMMC reader#

The path a recovery or a fresh build actually takes: OS first, application on top, MCUs usually last — and often untouched, because layer 2 survived whatever killed layer 3. This is the order verified end-to-end on the reference machine.

1. Inventory your backups#

Minimum viable: the config set (git repo or any copy) and the MCU state. Already-mainline MCUs need nothing here; vendor MCUs need the firmware steps below. A full eMMC image makes this a restore instead of a rebuild. → Recovery

Recovery

Mon, 01 Jan 0001 00:00:00 +0000

Runbook — recovering a machine that won’t come up#

Route by what actually failed. Because layer 2 survives layer 3, most recoveries are narrower than they feel — a dead OS doesn’t touch the MCUs, and a bad app flash doesn’t touch the OS.

The backup checklist and the detailed rollbacks live on the recovery page; this is the routing.

The OS won’t boot#

The MCUs are fine. Rebuild only the OS, then reconnect.