This has fully replaced the klipper_config repository.
A CustomPiOS built on top of FullPageOS (Debian Bookworm) which includes Klipper firmware and additional dependencies needed to operate the re:3D Gigabot printers.
Every new commit an image is created, streamlining development and removing the need to go through the entire build chain.
- Fork this repository
- Commit changes
- A new image will be built through Github Actions.
- Klipper: The 3D-printer firmware.
- Moonraker: The API server for Klipper.
- Mainsail: User interface for Klipper.
- Crowsnest: The webcam streamer wrapper.
- Beacon3D: Klipper module for the Beacon Eddy Current Scanner.
- Chromium: The browser used to display Mainsail on the touchscreen.
- (WIP)
- Klipper shell commands: Klipper plugin to allow shell commands to run from gcode.
- Moonraker timelapse: Create timelapses of prints.
- Pi-usb-automount: Auto mounts USB drives with a symbolic link to /printer_data/gcodes.
- Automated firmware flashing: Attempts to flash the microcontroller with Klipper firmware on first boot.
- Multi-machine configuration: Checks for printer type and uses the appropriate configuration files.
- re:3D Configurator
- Download the latest re3D-Klipper-OS-x.x.x.img.gz file from the releases page.
- Download and install Raspberry Pi Imager
- Insert a MicroSD card into your computer. (Must be atleast 32GB)
- Use Raspberry Pi Imager to flash the image file to the MicroSD card.
- For Device, choose "Raspberry Pi 4".
- For Operating System, scroll down and choose "Use custom" and use the re3D-Klipper-OS-x.x.x.img.gz file.
- For Storage, select your MicroSD card.
- After selecting next, a message will appear asking if you would like to apply customisation.
- Select "Edit Settings".
- Select and choose a hostname: This will be the display name and a connection method for your printer. This can also be changed in the configurator.
- Set a username and password. The username MUST be pi. The password can be anything, and is only used for command line access. Note that if support is needed we will require that password. It is not recommended to use a sensitive password and we can not recover this password if forgotten. A default password that can be used is: raspberry.
- (Optional) - You can configure wireless LAN if you expect to use the WIFI capabilities. Enter the network SSID and password, and set the country. This can also be done in the configurator.
- Select "Save", then "YES" on applying customisation settings.
- Wait for the writing and verification process.
- Remove the MicroSD card from your computer and insert into the Raspberry Pi in the top section of the electrical enclosure while powered off.
- Turn the printer on and wait for the boot process. This can take a few minutes.
- The preparing printer screen will come up and will detect which state the Archimajor board is in.
- If the board is already erased it will automatically attempt flashing.
- If the board isn't detected, check the USB cabling. Contact support if this is a persistant issue.
- (Most common) If the board is not erased, it will prompt you to erase the mainboard. This involves pressing and holding the "ERASE" button, then clicking the "RESET" button. After manually erasing the board, you should see the flash process progress on the touchscreen.
- When the board has been flashed, you will be prompted to powercycle the machine. Turn the machine off, wait 10-15 seconds, and power back on.
- This will now boot into the printer control interface (Mainsail).
- By default the printer configuration is set for a Gigabot 4. If you have a different printer, you will need to select it in the configurator.
- To navigate to the configurator, slect the three navigation lines in the top left hand corner and select the bottom option.
- Select your machine, and reboot when prompted for changes to take effect.