Cartographer 3D
  • Welcome
  • 🗺️Cartographer Probe
    • Scan vs Touch Modes
    • 🏗️Installation and Setup
      • Before You Begin
      • Hardware Setup
        • CAN Termination
        • Stealthburner CW2 Mount
        • Wiring Diagrams
      • Software Configuration
        • Klipper Setup
        • Klipper Configuation
        • Calibration
        • Print Start Macro
        • First Print
        • Migrating from Cartographer to Scanner
      • Creality K1 & K1 Max Specific
      • Qidi Specific Installation Instructions
    • 📐Fine Tuning
      • Cartographer Models
      • Temperature Differential Calibration
      • Useful Macros
      • Extras
    • ♻️Firmware
      • Broken Katapult Bootloader
      • CANBUS Bitrate Switching
      • Firmware Switching
        • CANBUS to USB
        • USB to CANBUS
      • Firmware Updating
        • via Katapult
          • USB Flash
          • CANBUS Flash
        • via DFU
      • Manual Methods
        • ⬆️Firmware
        • Update or Re-Flash via ST-Link
        • Switching between CAN and USB Operation (v3 only)
        • Cartographer with Input Shaper
          • Update via Katapult (recommended)
          • Update via DFU Mode
        • Archive
          • Katapult
          • Re-Flashing Firmware
          • Cartographer (rp2040)
            • DFU / U2F Bootloader Mode
          • Which Firmware?
            • Cartographer v1 (RP2040 based probe)
            • Cartographer v2 or v3 w/ Input Shaper (USB/CAN)
              • Old Firmware
          • Update via STLink
    • ⚙️Settings & Commands
    • 😭Troubleshooting
    • 🆘Need Assistance?
    • 🔗Useful Links
    • ⁉️FAQ
    • 🔧Assembly
      • Standard
      • Low Profile
      • Right Angle
    • Archive
      • v1 (RP2040 Based Probes)
        • Klipper Configuration
        • Calibration
      • Classic Installation
        • Klipper Setup
        • Klipper Configuration
        • Calibration
      • Scan Based Calibration
  • 🚠Cartographer CNC Mount
    • 🚧Installation
  • 🌪️Linear Motor
    • 🗓️Coming Soon
Powered by GitBook
On this page
  • Installation of the Cartographer Klipper Module
  • Remember to update cartographer via the mainsail/fluidd UI
  • Managing Updates via Moonraker
  • Finding the Serial or UUID
  • New Firmware
  1. Cartographer Probe
  2. Archive
  3. Classic Installation

Klipper Setup

Klipper Setup for Classic Mode

PreviousClassic InstallationNextKlipper Configuration

Last updated 6 months ago

Installation of the Cartographer Klipper Module

Clone the Klipper module from GitHub using the following commands, you then need to run our installation script.

cd ~
git clone https://github.com/Cartographer3D/cartographer-klipper.git
./cartographer-klipper/install.sh

This step will automatically create a link to the script and place it in the klipper/klippy/extra directory.

If you are in Mainland China, use the following commands instead:

cd ~
git clone https://gitee.com/NBTP/cartographer-klipper.git
./cartographer-klipper/install.sh

Remember to update cartographer via the mainsail/fluidd UI

Legacy Klipper environements running on Python2 will need updating to Python 3.9 or later. The easiest way to do that is a complete fresh install, though we do have a guide that can help that is linked

Managing Updates via Moonraker

In order to keep up to date with our latest Klipper software, please add the following config to the bottom of your moonraker.conf file.

[update_manager cartographer]
type: git_repo
path: ~/cartographer-klipper
channel: stable
origin: https://github.com/Cartographer3D/cartographer-klipper.git
is_system_service: False
managed_services: klipper
info_tags:
  desc=Cartographer Probe

Are you from Mainland China? Use this alternate moonraker.conf instead.

[update_manager cartographer]
type: git_repo
path: ~/cartographer-klipper
channel: stable
origin: https://gitee.com/NBTP/cartographer-klipper.git
requirements: requirements.txt
is_system_service: False
managed_services: klipper
info_tags:
  desc=Cartographer Probe (Gitee)

upon completion, press SAVE & RESTART and it should now display in the update section of either Mainsail or Fluidd.

If you get "Repo is dirty. Detected the following modified files: ['install.sh']", a soft Recovery should fix it.

Finding the Serial or UUID

Note, you need to replace the serial path or UUID with your probes serial path or UUID, this can be found by running the following commands

For USB based probes

ls /dev/serial/by-id/

For CAN based probes

~/klippy-env/bin/python ~/klipper/scripts/canbus_query.py can0

Take note of either the Serial ID or the UUID.

New Firmware

Since late August, most probes shipping from directly from Cartographer3D, and a majority of our resellers have pre-flashed with the Cartographer Survey Firmware.

If your box or antistatic bag states "Survey Touch Ready", please go here

If it doesnt, don't worry. You can update your probe using our flashing tool. If you want to configure it as is, please go to the next page.

🗺️
here
Klipper Configuation
Cartographer Software updates managed via Moonraker.