My Customisation

Printer Hardware

• Ender 3 Pro
• BTT SKR Mini E3 v3
• BTT TFT35 V3
• BTT Smart Filament Runout Sensor
• Creality BL-Touch v3.1
• NeoPixel LEDs x 7
• Raspberry Pi4 + OctoPrint + Night-light Pi-Cam

Software for builds

• Visual Studio Code + PlatformIO + Auto Marlin Builder
• Github Desktop for Windows

Fix for not flashing new firmware on new board (August stock firmware)

When my v3 board arrived then fitted the board work fine, but when it came time to upgrade the firmware, for some reason no amount things I tried with the same SD card I was already using with the v1.2 would flash. The printer simply started normally igoring the new firmware - I tried both my own custom firmware and the newer stock versions from BTT. This is what I did to fix the problem:

• Get the stock version of the latest firmware from BTT
• Using an SD card 4GB or lower, format it to FAT not FAT32
• Copy the new firmware to the SD card
• Flash the firmware This then worked for me and I then tried the same with my custom firmware and it to flashed fine. Afterwards I was even able to format the card back to FAT32 and it was still able to read from it.

Marlin Configurations (work in progress)

• platformio.ini
  • default environment: STM32G0B1RE_btt
• Marlin/Version.h
  • Get rid of "bugfix" from build version: "v2.1.x"
  • Set build date to date/time firmware was compiled: __DATE__ " " __TIME__
• Marlin/_Bootscreen.h
  • Copied from Ender 3 Pro configuration archive
• Marlin/_Statusscreen.h
  • Copied from Ender 3 Pro configuration archive
• Marlin/src/HAL/STM32F1/inc/SanityCheck.h
  • Disable probe margin checks to allow for greater coverage of bed
  • Commented out error PROBING_MARGIN_BACK must be >= 0
  • Commented out error PROBING_MARGIN_FRONT must be >= 0
  • Commented out error PROBING_MARGIN_LEFT must be >= 0
  • Commented out error PROBING_MARGIN_RIGHT must be >= 0
• Marlin/Configuration.h
  • Set author to "(Taomyn, for SKR-mini-E3-V3.0)"
  • Enable CUSTOM_VERSION_FILE
  • Enable SHOW_CUSTOM_BOOTSCREEN
  • Enable CUSTOM_STATUS_SCREEN_IMAGE
  • Set MOTHERBOARD BOARD_BTT_SKR_MINI_E3_V3_0
  • Set SERIAL_PORT 2
  • Set BAUDRATE 250000
  • Enable BAUD_RATE_GCODE
  • Enable SERIAL_PORT_2
  • Enable BAUDRATE_2
  • Set CUSTOM_MACHINE_NAME "Ender-3 Pro"
  • Set TEMP_SENSOR_BED 1
  • Set HEATER_0_MAXTEMP 315 to allow for some PETG filaments
  • Set DEFAULT_Kp, DEFAULT_Ki and DEFAULT_Kd to recent PID tune values to save repeating when flashed
  • Enable PIDTEMPBED
  • Set DEFAULT_bedKp, DEFAULT_bedKi and DEFAULT_bedKd to recent PID bed tune values to save repeating when flashed
  • Enable PID_EDIT_MENU
  • Enable PID_AUTOTUNE_MENU
  • Set EXTRUDE_MINTEMP to '180' as 170 seems too low
  • Set EXTRUDE_MAXLENGTH to '600'
  • Disable USE_ZMIN_PLUG as using BL-Touch and Z endstop not fitted
  • Set X, Y, Z and E0 driver types to 'TMC2209'
  • Set DEFAULT_AXIS_STEPS_PER_UNIT to recent calibration values to save repating when flashed
  • Set DEFAULT_MAX_FEEDRATE, DEFAULT_MAX_ACCELERATION, DEFAULT_ACCELERATION, DEFAULT_RETRACT_ACCELERATION, DEFAULT_TRAVEL_ACCELERATION, JUNCTION_DEVIATION_MM to more suitable values
  • Enable S_CURVE_ACCELERATION
  • Disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN Z endstop not fitted
  • Enable USE_PROBE_FOR_Z_HOMING for some reason needs this to force using the BL-Touch on Z homing
  • Enable BLTOUCH
  • Set NOZZLE_TO_PROBE_OFFSET to correct values of BL-Touch installed
  • Set PROBING_MARGIN 0
  • Set XY_PROBE_FEEDRATE (166*60)
  • Set Z_PROBE_FEEDRATE_FAST (10*60)
  • Set MULTIPLE_PROBING 2
  • Set Z_CLEARANCE_DEPLOY_PROBE 5
  • Set Z_CLEARANCE_BETWEEN_PROBES 4
  • Set Z_CLEARANCE_MULTI_PROBE 4
  • Enable Z_AFTER_PROBING
  • Enable Z_MIN_PROBE_REPEATABILITY_TEST
  • Set PROBING_BED_TEMP 60
  • Set INVERT_X_DIR true and INVERT_E0_DIR true - correct for Ender 3 Pro
  • Set Z_AFTER_HOMING 20 - leaves more room to see between nozzle and bed
  • Set X_BED_SIZE 235 and Y_BED_SIZE 235 - correct for Ender 3 Pro
  • Set X_MAX_POS (X_BED_SIZE+15) - allows for bed level probing further out
  • Set Z_MAX_POS 250 - correct for Ender 3 Pro
  • Enable FILAMENT_RUNOUT_SENSOR
  • Set FILAMENT_RUNOUT_SENSOR_DEBUG - useful for seeing distance info in terminal output
  • Set FILAMENT_RUNOUT_DISTANCE_MM 25 - BTT recommended 7mm is too short causing false alarms
  • Enable FILAMENT_MOTION_SENSOR
  • Enable AUTO_BED_LEVELING_BILINEAR
  • Enable RESTORE_LEVELING_AFTER_G28
  • Enable PREHEAT_BEFORE_LEVELING
  • Set LEVELING_NOZZLE_TEMP 0 never gets close to bed so no need to heat it up
  • Set LEVELING_BED_TEMP 60 make sure bed is heated to average temp when printing
  • Enable DEBUG_LEVELING_FEATURE - as we have the RAM this is useful
  • Enable G26_MESH_VALIDATION - must test this
  • Set GRID_MAX_POINTS_X 5 - 5 x 5 grid is more accurate
  • Enable EXTRAPOLATE_BEYOND_GRID
  • Enable ABL_BILINEAR_SUBDIVISION
  • Enable LCD_BED_LEVELING
  • Enable MESH_EDIT_MENU
  • Enable LEVEL_BED_CORNERS
  • Set LEVEL_CORNERS_HEIGHT 0.1 - need to find out why this was recommended
  • Enable LEVEL_CENTER_TOO
  • Enable Z_SAFE_HOMING
  • Set HOMING_FEEDRATE_MM_M { (50*60), (50*60), (10*60) } increased Z speed
  • Enable EEPROM_SETTINGS
  • Customised Preheat Constants to personal preferences, replaced ABS with PETG
  • Enable NOZZLE_PARK_FEATURE
  • Enable PRINTCOUNTER
  • Set PRINTCOUNTER_SAVE_INTERVAL 10
  • Set DISPLAY_CHARSET_HD44780 WESTERN
  • Enable SDSUPPORT
  • Enable SD_CHECK_AND_RETRY
  • Enable INDIVIDUAL_AXIS_HOMING_MENU
  • Enable INDIVIDUAL_AXIS_HOMING_SUBMENU
  • Enable CR10_STOCKDISPLAY
  • Enable FAN_SOFT_PWM
  • Enable NEOPIXEL_LED
  • Set NEOPIXEL_TYPE NEO_GRB - specfic to the LEDs I used
  • Set NEOPIXEL_PIXELS 7 - I have 7 LED strip connected
  • Set NEOPIXEL_BRIGHTNESS 255
  • Enable NEOPIXEL_STARTUP_TEST
• Marlin/Configuration_adv.h
  • Set WATCH_TEMP_PERIOD 40
  • Set WATCH_BED_TEMP_PERIOD 90
  • Enable HOTEND_IDLE_TIMEOUT
  • Set HOTEND_IDLE_TIMEOUT_SEC (10*60)
  • Enable USE_CONTROLLER_FAN
  • Set CONTROLLER_FAN_PIN PB15
  • Enable CONTROLLER_FAN_EDITABLE
  • Set E0_AUTO_FAN_PIN PC7
  • Enable CASE_LIGHT_ENABLE
  • Set CASE_LIGHT_PIN 0
  • Set CASE_LIGHT_DEFAULT_BRIGHTNESS 255
  • Enable CASE_LIGHT_MENU
  • Enable CASE_LIGHT_USE_NEOPIXEL - use the same LED strip as the main ones
  • Enable QUICK_HOME
  • Set SLOWDOWN_DIVISOR 8 - need to find out why this was recommended
  • Enable XY_FREQUENCY_LIMIT
  • Enable ADAPTIVE_STEP_SMOOTHING
  • Enable BEEP_ON_FEEDRATE_CHANGE
  • Enable PROBE_OFFSET_WIZARD
  • Enable PROBE_OFFSET_WIZARD_START_Z
  • Set PROBE_OFFSET_WIZARD_XY_POS { X_CENTER + 40, Y_CENTER } - pushes probe back to centre of bed
  • Enable LCD_INFO_MENU
  • Enable TURBO_BACK_MENU_ITEM
  • Enable LED_CONTROL_MENU
  • Set LED_USER_PRESET_GREEN 255 and LED_USER_PRESET_BLUE 255 - correct for my LEDs
  • Enable LED_USER_PRESET_STARTUP
  • Set LCD_TIMEOUT_TO_STATUS 30000 - stops it dimming too quickly
  • Enable SOUND_MENU_ITEM
  • Disable BOOT_MARLIN_LOGO_SMALL
  • Enable STATUS_MESSAGE_SCROLLING
  • Enable LCD_DECIMAL_SMALL_XY
  • Enable LCD_SET_PROGRESS_MANUALLY
  • Enable SHOW_REMAINING_TIME
  • Enable USE_M73_REMAINING_TIME
  • Enable ROTATE_PROGRESS_DISPLAY
  • Enable PRINT_PROGRESS_SHOW_DECIMALS
  • Enable LCD_PROGRESS_BAR
  • Enable LCD_PROGRESS_BAR_TEST
  • Enable SD_IGNORE_AT_STARTUP
  • Enable GCODE_REPEAT_MARKERS
  • Enable BROWSE_MEDIA_ON_INSERT
  • Enable SDCARD_SORT_ALPHA
  • Set SDSORT_LIMIT 255
  • Set SDSORT_GCODE true
  • Set SDSORT_USES_RAM true
  • Set SDSORT_CACHE_NAMES true
  • Enable UTF_FILENAME_SUPPORT
  • Enable LONG_FILENAME_HOST_SUPPORT
  • Enable LONG_FILENAME_WRITE_SUPPORT - currently disabled as it fails to compile
  • Enable SCROLL_LONG_FILENAMES
  • Enable SD_ABORT_ON_ENDSTOP_HIT
  • Enable AUTO_REPORT_SD_STATUS
  • Set SDCARD_CONNECTION ONBOARD - correct for BTT SKR Mini E3 v3.0
  • Enable XYZ_NO_FRAME
  • Disable XYZ_HOLLOW_FRAME
  • Disable STATUS_CHAMBER_ANIM
  • Enable STATUS_ALT_BED_BITMAP and STATUS_ALT_FAN_BITMAP - I think they look better
  • Set STATUS_FAN_FRAMES 4
  • Enable BOOT_MARLIN_LOGO_ANIMATED
  • Enable BABYSTEPPING
  • Set BABYSTEP_MULTIPLICATOR_Z 4
  • Enable DOUBLECLICK_FOR_Z_BABYSTEPPING
  • Enable BABYSTEP_ZPROBE_OFFSET
  • Enable BABYSTEP_ZPROBE_GFX_OVERLAY - reminds you which way to turn for adjustment
  • Enable PROBING_MARGIN_LEFT, PROBING_MARGIN_RIGHT, PROBING_MARGIN_FRONT, PROBING_MARGIN_BACK - to avoid clips holding bed
  • Set PROBING_MARGIN_xxxx nn - to avoid clips holding bed
  • Set BLOCK_BUFFER_SIZE 32, BUFSIZE 32 and TX_BUFFER_SIZE 32 - better USB comms performance
  • Enable BEZIER_CURVE_SUPPORT
  • Enable EMERGENCY_PARSER
  • Enable ADVANCED_OK
  • Enable SERIAL_FLOAT_PRECISION
  • Enable ADVANCED_PAUSE_FEATURE
  • Set FILAMENT_CHANGE_UNLOAD_FEEDRATE 100
  • Set FILAMENT_CHANGE_UNLOAD_LENGTH 600
  • Set FILAMENT_CHANGE_SLOW_LOAD_FEEDRATE 10
  • Set FILAMENT_CHANGE_SLOW_LOAD_LENGTH 25
  • Set FILAMENT_CHANGE_FAST_LOAD_FEEDRATE 10
  • Set FILAMENT_CHANGE_FAST_LOAD_LENGTH 300
  • Set ADVANCED_PAUSE_CONTINUOUS_PURGE
  • Enable PARK_HEAD_ON_PAUSE
  • Enable FILAMENT_LOAD_UNLOAD_GCODES
  • Set X_CURRENT 580, Y_CURRENT 580, Z_CURRENT 580 and E0_CURRENT 650 - correct for Ender 3 Pro
  • Set X_CURRENT_HOME X_CURRENT /2
  • Set Y_CURRENT_HOME Y_CURRENT /2
  • Set Z_CURRENT_HOME Z_CURRENT /2
  • Set CHOPPER_TIMING CHOPPER_DEFAULT_24V- correct for Ender 3 Pro with 24v PSU
  • Enable MONITOR_DRIVER_STATUS
  • Set Z_HYBRID_THRESHOLD 20
  • Added DIAG_JUMPERS_REMOVED - Motherboard DIAG jumpers must be removed when SENSORLESS_HOMING is disabled. Define DIAG_JUMPERS_REMOVED to suppress this warning.
  • Set X_STALL_SENSITIVITY 72
  • Set Y_STALL_SENSITIVITY 70
  • Set Z_STALL_SENSITIVITY 10
  • Enable IMPROVE_HOMING_RELIABILITY
  • Enable SQUARE_WAVE_STEPPING
  • Enable TMC_DEBUG
  • Enable M115_GEOMETRY_REPORT
  • Enable M114_DETAIL
  • Enable M114_REALTIME
  • Enable REPORT_FAN_CHANGE
  • Enable GCODE_QUOTED_STRINGS
  • Enable GCODE_CASE_INSENSITIVE - personal hate of mine
  • Enable HOST_ACTION_COMMANDS
  • Enable HOST_PAUSE_M76
  • Enable HOST_PROMPT_SUPPORT
  • Enable HOST_STATUS_NOTIFICATIONS
  • Enable CANCEL_OBJECTS
  • Enable FWRETRACT

Marlin 3D Printer Firmware

Marlin 3D Printer Firmware

Additional documentation can be found at the Marlin Home Page. Please test this firmware and let us know if it misbehaves in any way. Volunteers are standing by!

Marlin 2.1 Bugfix Branch

Not for production use. Use with caution!

Marlin 2.1 takes this popular RepRap firmware to the next level by adding support for much faster 32-bit and ARM-based boards while improving support for 8-bit AVR boards. Read about Marlin's decision to use a "Hardware Abstraction Layer" below.

This branch is for patches to the latest 2.1.x release version. Periodically this branch will form the basis for the next minor 2.1.x release.

Download earlier versions of Marlin on the Releases page.

Example Configurations

Before you can build Marlin for your machine you'll need a configuration for your specific hardware. Upon request, your vendor will be happy to provide you with the complete source code and configurations for your machine, but you'll need to get updated configuration files if you want to install a newer version of Marlin. Fortunately, Marlin users have contributed dozens of tested configurations to get you started. Visit the MarlinFirmware/Configurations repository to find the right configuration for your hardware.

Building Marlin 2.1

To build and upload Marlin you will use one of these tools:

• The free Visual Studio Code using the Auto Build Marlin extension.
• The free Arduino IDE : See Building Marlin with Arduino
• You can also use VSCode with devcontainer : See Installing Marlin (VSCode devcontainer).

Marlin is optimized to build with the PlatformIO IDE extension for Visual Studio Code. You can still build Marlin with Arduino IDE, and we hope to improve the Arduino build experience, but at this time PlatformIO is the better choice.

8-Bit AVR Boards

We intend to continue supporting 8-bit AVR boards in perpetuity, maintaining a single codebase that can apply to all machines. We want casual hobbyists and tinkerers and owners of older machines to benefit from the community's innovations just as much as those with fancier machines. Plus, those old AVR-based machines are often the best for your testing and feedback!

Hardware Abstraction Layer (HAL)

Marlin includes an abstraction layer to provide a common API for all the platforms it targets. This allows Marlin code to address the details of motion and user interface tasks at the lowest and highest levels with no system overhead, tying all events directly to the hardware clock.

Every new HAL opens up a world of hardware. At this time we need HALs for RP2040 and the Duet3D family of boards. A HAL that wraps an RTOS is an interesting concept that could be explored. Did you know that Marlin includes a Simulator that can run on Windows, macOS, and Linux? Join the Discord to help move these sub-projects forward!

Supported Platforms

Platform	MCU	Example Boards
Arduino AVR	ATmega	RAMPS, Melzi, RAMBo
Teensy++ 2.0	AT90USB1286	Printrboard
Arduino Due	SAM3X8E	RAMPS-FD, RADDS, RAMPS4DUE
ESP32	ESP32	FYSETC E4, E4d@BOX, MRR
LPC1768	ARM® Cortex-M3	MKS SBASE, Re-ARM, Selena Compact
LPC1769	ARM® Cortex-M3	Smoothieboard, Azteeg X5 mini, TH3D EZBoard
STM32F103	ARM® Cortex-M3	Malyan M200, GTM32 Pro, MKS Robin, BTT SKR Mini
STM32F401	ARM® Cortex-M4	ARMED, Rumba32, SKR Pro, Lerdge, FYSETC S6, Artillery Ruby
STM32F7x6	ARM® Cortex-M7	The Borg, RemRam V1
STM32G0B1RET6	ARM® Cortex-M0+	BigTreeTech SKR mini E3 V3.0
STM32H743xIT6	ARM® Cortex-M7	BigTreeTech SKR V3.0, SKR EZ V3.0, SKR SE BX V2.0/V3.0
SAMD51P20A	ARM® Cortex-M4	Adafruit Grand Central M4
Teensy 3.5	ARM® Cortex-M4
Teensy 3.6	ARM® Cortex-M4
Teensy 4.0	ARM® Cortex-M7
Teensy 4.1	ARM® Cortex-M7
Linux Native	x86/ARM/etc.	Raspberry Pi

Marlin Support

The Issue Queue is reserved for Bug Reports and Feature Requests. Please use the following resources for help with configuration and troubleshooting:

• Marlin Documentation - Official Marlin documentation
• Marlin Discord - Discuss issues with Marlin users and developers
• Facebook Group "Marlin Firmware"
• RepRap.org Marlin Forum
• Facebook Group "Marlin Firmware for 3D Printers"
• Marlin Configuration on YouTube

Contributing Patches

You can contribute patches by submitting a Pull Request to the (bugfix-2.1.x) branch.

• We use branches named with a "bugfix" or "dev" prefix to fix bugs and integrate new features.
• Follow the Coding Standards to gain points with the maintainers.
• Please submit Feature Requests and Bug Reports to the Issue Queue. See above for user support.
• Whenever you add new features, be sure to add one or more build tests to buildroot/tests. Any tests added to a PR will be run within that PR on GitHub servers as soon as they are pushed. To minimize iteration be sure to run your new tests locally, if possible.
  • Local build tests:
    • All: make tests-config-all-local
    • Single: make tests-config-single-local TEST_TARGET=...
  • Local build tests in Docker:
    • All: make tests-config-all-local-docker
    • Single: make tests-config-all-local-docker TEST_TARGET=...
  • To run all unit test suites:
    • Using PIO: platformio run -t test-marlin
    • Using Make: make unit-test-all-local
    • Using Docker + make: maker unit-test-all-local-docker
  • To run a single unit test suite:
    • Using PIO: platformio run -t marlin_<test-suite-name>
    • Using make: make unit-test-single-local TEST_TARGET=<test-suite-name>
    • Using Docker + make: maker unit-test-single-local-docker TEST_TARGET=<test-suite-name>
• If your feature can be unit tested, add one or more unit tests. For more information see our documentation on Unit Tests.

Contributors

Marlin is constantly improving thanks to a huge number of contributors from all over the world bringing their specialties and talents. Huge thanks are due to all the contributors who regularly patch up bugs, help direct traffic, and basically keep Marlin from falling apart. Marlin's continued existence would not be possible without them.

Project Leadership

Name	Role	Link	Donate
🇺🇸 Scott Lahteine	Project Lead	[@thinkyhead]	💸 Donate
🇺🇸 Roxanne Neufeld	Admin	[@Roxy-3D]
🇺🇸 Keith Bennett	Admin	[@thisiskeithb]	💸 Donate
🇺🇸 Jason Smith	Admin	[@sjasonsmith]
🇧🇷 Victor Oliveira	Admin	[@rhapsodyv]
🇬🇧 Chris Pepper	Admin	[@p3p]
🇳🇿 Peter Ellens	Admin	[@ellensp]	💸 Donate
🇺🇸 Bob Kuhn	Admin	[@Bob-the-Kuhn]
🇳🇱 Erik van der Zalm	Founder	[@ErikZalm]

License

Marlin is published under the GPL license because we believe in open development. The GPL comes with both rights and obligations. Whether you use Marlin firmware as the driver for your open or closed-source product, you must keep Marlin open, and you must provide your compatible Marlin source code to end users upon request. The most straightforward way to comply with the Marlin license is to make a fork of Marlin on Github, perform your modifications, and direct users to your modified fork.