Skip to content

Commit

Permalink
📝 Use new Markdown Alert styles (MarlinFirmware#964)
Browse files Browse the repository at this point in the history
  • Loading branch information
thisiskeithb authored Oct 5, 2023
1 parent d64c8bb commit 401b40c
Show file tree
Hide file tree
Showing 16 changed files with 45 additions and 30 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Configurations
Pre-tested Configurations for Marlin Firmware. Links below…

*Before downloading configurations in ZIP format using the CODE button above you must select the correct branch for your version of Marlin.*
> [!IMPORTANT]
> Before downloading configurations in ZIP format using the CODE button above you must select the correct branch for your version of Marlin.
## Branches

Expand Down
3 changes: 2 additions & 1 deletion config/examples/AliExpress/CL-260/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

Example configuration for the [AliExpress CL-260](https://www.aliexpress.com/item/32812528331.html) Ultimaker 2 clone.

*Note: Change `Z_MAX_POS` to 300 for the CL-260MAX.*
> [!NOTE]
> Change `Z_MAX_POS` to 300 for the CL-260MAX.
The setting "works" for my printer and the extruder using my calibration value, but you might want to tweak some settings, e.g enable EEPROM, increase default Z speed, adjust homing speeds,...

Expand Down
9 changes: 6 additions & 3 deletions config/examples/BIQU/Hurakan/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Biqu Hurakan Configuration

*Note:* Early Hurakan printers have a raised bed power switch, so enable (uncomment) `#define PROBING_MARGIN_BACK` in `Configuration_adv.h` to prevent the hotend from potentially colliding with the switch assembly while probing.
> [!NOTE]
> Early Hurakan printers have a raised bed power switch, so enable (uncomment) `#define PROBING_MARGIN_BACK` in `Configuration_adv.h` to prevent the hotend from potentially colliding with the switch assembly while probing.
The Biqu Hurakan ships with a BigTreeTech Manta M4P motherboard which includes an integrated BigTreeTech CB1 single board computer running Klipper. See below for instructions on how to update the CB1 to run OctoPrint.

Expand Down Expand Up @@ -31,7 +32,8 @@ Password: `biqu`

## Update Timezone

*See [Wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) or run `timedatectl list-timezones` for list of valid time zone names. `America/Los_Angeles` is used as an example below:*
> [!NOTE]
> See [Wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) or run `timedatectl list-timezones` for list of valid time zone names. `America/Los_Angeles` is used in the example below.
```shell
sudo timedatectl set-timezone America/Los_Angeles
Expand Down Expand Up @@ -86,7 +88,8 @@ git clone https://github.com/th33xitus/kiauh.git
./kiauh/kiauh.sh
```

*Note: Klipper, Moonraker, Mainsail, and KlipperScreen come preinstalled on the Hurakan image.*
> [!NOTE]
> Klipper, Moonraker, Mainsail, and KlipperScreen come preinstalled on the Hurakan image.
Type 1 to install an app:

Expand Down
3 changes: 2 additions & 1 deletion config/examples/BQ/Hephestos_2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Based on the original configuration file shipped with the heavily modified Marlin fork by BQ.
The forked firmware and configuration files can be found at the [BQ Github repository](https://github.com/bq/Marlin).

NOTE: The look and feel of the LCD menu will change dramatically when using the original Marlin firmware.
> [!NOTE]
> The look and feel of the LCD menu will change dramatically when using the original Marlin firmware.
## Changelog
* 2018/05/30 - Configuration updated to the latest Marlin version (43a55a9af).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ To make a custom boot screen there are 5 requirements:
2. Progressive must be tuned off in the export settings (under "Advanced" in GIMP).
3. The Sub-sampling format must be chroma quartered (4:2:0) (also under "Advanced" in GIMP).
4. The resolution must be 480x272.
Note: The left side of the image will be the top. You can compose the image oriented upright as 272x480, but it must be
rotated prior to export. (Rotating *during* export only applies a "rotation" attribute that won't be parsed by DWIN / DACAI.)
> [!NOTE]
> The left side of the image will be the top. You can compose the image oriented upright as 272x480, but it must be rotated prior to export. (Rotating *during* export only applies a "rotation" attribute that won't be parsed by DWIN / DACAI.)
5. For DACAI the file must be named "`0`" and placed in `private/image`. For DWIN the file must be named "`0_start`" and placed in `DWIN_SET`.

After replacing the Boot Screen follow the usual screen flashing instructions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ default_envs = STM32F103RC_btt_512K

## Older Leadscrew

**Note:** This Ender-5 `Configuration.h` applies to the newer leadscrew with 800 steps/mm. If your printer has the older leadscrew, change the Z component of `DEFAULT_AXIS_STEP_PER_UNIT` to 400 as in the example below:
> [!NOTE]
> This Ender-5 `Configuration.h` applies to the newer leadscrew with 800 steps/mm. If your printer has the older leadscrew, change the Z component of `DEFAULT_AXIS_STEP_PER_UNIT` to 400 as in the example below:
```cpp
#define DEFAULT_AXIS_STEPS_PER_UNIT { 80, 80, 400, 93 }
Expand Down
9 changes: 6 additions & 3 deletions config/examples/Creality/Ender-6/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,18 @@ The Ender-6 doesn't have an accessible USB port, so it's a good idea to connect

To use an installed BLTouch probe, enable the custom option `E6_USE_BLTOUCH` at the top of `Configuration.h` to get all the settings needed to support the probe. Creality isn't shipping printers with a BLTouch option at this time, but the existence of factory mounts, wiring, and OEM firmware supporting it suggests this may change in the future.

NOTE: Due to slight manufacturing differences, you will still need to tune your probe's `NOZZLE_TO_PROBE_OFFSET` values, at least for Z. For best results use the Probe Offset Wizard.
> [!NOTE]
> Due to slight manufacturing differences, you will still need to tune your probe's `NOZZLE_TO_PROBE_OFFSET` values, at least for Z. For best results use the Probe Offset Wizard.
## Flashing Instructions

NOTE: The bootloader on this printer remembers the name of the most recent firmware file that was flashed from SD, so you must give the firmware file a unique name or it will be ignored.
> [!NOTE]
> The bootloader on this printer remembers the name of the most recent firmware file that was flashed from SD, so you must give the firmware file a unique name or it will be ignored.
Copy the compiled "`firmware.bin`" file to an SD card, giving it a distinct name. Turn off the printer, insert the SD card, and turn the printer on. The update will take a few seconds.

NOTE: The factory LCD firmware is only compatible with Creality's firmware. The LCD will not show the progress bar increment and the standard UI will not function. This is expected.
> [!NOTE]
> The factory LCD firmware is only compatible with Creality's firmware. The LCD will not show the progress bar increment and the standard UI will not function. This is expected.
## Marlin DGUS UI Instructions

Expand Down
3 changes: 2 additions & 1 deletion config/examples/Labists/ET4/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Marlin for Labists ET4

_Note: The Labists ET4 is OEM'd by Anet, so the update process is very similar._
> [!NOTE]
> The Labists ET4 is OEM'd by Anet, so the update process is very similar.
A debugging/programming probe (_e.g._, ST-Link, J-Link, or Black Magic Probe) is required to flash the the [OpenBLT bootloader for Anet ET4/ET5 series printers](https://github.com/davidtgbe/openblt/releases) due to incompatibility with the stock bootloader. Once OpenBLT is flashed, Marlin can be updated by SD card just like the original firmware.

Expand Down
5 changes: 4 additions & 1 deletion config/examples/Two Trees/Sapphire Plus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,7 @@ By default the standard Marlin Touch UI will be used. Enable the `SAPPHIRE_PLUS_

Enable the `SAPPHIRE_PLUS_BLTOUCH` option for BLTouch support.

Enable the `SAPPHIRE_PLUS_TMC_UART` option for TMC UART support for the X, Y and E steppers. Note: you will need some hardware modification skills to modify the stepper sticks. A solder pad needs to be bridged to connect PDN to USART pin. Then a 1K resistor and wire is needed to connect the USART pin to the appropriate spare pin on MKS Robin Nano V1.2 board.
Enable the `SAPPHIRE_PLUS_TMC_UART` option for TMC UART support for the X, Y and E steppers.

> [!NOTE]
> You will need some hardware modification skills to modify the stepper sticks. A solder pad needs to be bridged to connect PDN to USART pin. Then a 1K resistor and wire is needed to connect the USART pin to the appropriate spare pin on MKS Robin Nano V1.2 board.
3 changes: 2 additions & 1 deletion config/examples/Velleman/K8400/Dual-head/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ Like its predecessor, (K8200), the K8400 is a 3Drag clone. There are some minor

Single and dual head configurations provided. Copy the correct Configuration.h and Configuration_adv.h to the /src/config directory.

**NOTE: This configuration includes the community sourced feed rate fix. Use 100% feed rate in Repetier!**
> [!NOTE]
> This configuration includes the community sourced feed rate fix. Use 100% feed rate in Repetier!
For implementation and updated K8400 firmware, see https://github.com/birkett/Velleman-K8400-Firmware

Expand Down
13 changes: 5 additions & 8 deletions config/examples/Wanhao/Duplicator i3 2.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,16 @@ Configuration for the Wanhao Duplicator i3 v2.1
[Made by Bot-In-a-Box Educational Robotics](https://botinabox.ca)
[See original configuration repo](https://github.com/BotInABoxER/marlin2-for-wanhao-i3)

Notes:
- YMMV, but the included thermistor table has been tested to work with a 100k bed thermistor with a 10K pull-up resistor
- The smaller Marlin logo is used to save memory
- You may have a 4.7K pull-up resistor, in which case the included thermistor table will be off
- The included thermistor table was generated with `buildroot/share/scripts/createTemperatureLookupMarlin.py --rp=10000`
- Includes an optional custom Wanhao logo bootscreen designed to fit the stock LCD
- Includes an optional custom Chippy from Bot-In-a-Box bootscreen designed to fit the stock LCD
> [!NOTE]
> - The smaller Marlin logo is used to save memory
> - You may have a 4.7K pull-up resistor, in which case the included thermistor table will be off
> - Includes an optional custom Wanhao logo bootscreen designed to fit the stock LCD
> - Includes an optional custom Chippy from Bot-In-a-Box bootscreen designed to fit the stock LCD
Inspirations:
- https://www.thingiverse.com/thing:3378807 (Custom firmware 1.x by Nitrogen777)
- https://www.thingiverse.com/thing:3378807 (Custom firmware 2.x by Remotheman)

Instructions:
- Copy the `Configuration.h`, `_Bootscreen.h` (or `Chippy_Bootscreen.h`; rename it `_Bootscreen.h`), and `Configuration_adv.h` to the `Marlin/ directory`
- Copy the `thermistor_99.h` and `thermistors.h` files to the `Marlin/src/modules/thermistors` directory
- Flash the firmware onto your Melzi (https://www.fission3d.com/guides/flash-bootloader-and-install-firmware-with-raspberry-pi might help)
3 changes: 2 additions & 1 deletion config/examples/Wanhao/Duplicator i3 Plus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ The following similar models are not supported by this configuration out of the
* Wanhao Duplicator i3 Plus Mk 2
* Aldi Balco 3D Printer

Note that the touchscreen LCD is not currently supported by Marlin; you must either replace the LCD with another supported display, or operate the printer entirely through G-code.
> [!NOTE]
> The touchscreen LCD is not currently supported by Marlin; you must either replace the LCD with another supported display, or operate the printer entirely through G-code.
3 changes: 2 additions & 1 deletion config/examples/Weedo/Tina2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
- TINA2 WIFI: TINA2 standard version with ESP32 WIFI module installed. Support remote control, send files via wifi, and online 3d model library.
- TINA2 BASIC: TINA2 lite version, without WIFI module and protective shell.

Please note the monorpice cadet printer is a rebranded version of these printers and the provided configuration should work.
> [!NOTE]
> The Monorprice cadet printer is a rebranded version of these printers and the provided configuration should work.
## Hardware version

Expand Down
3 changes: 2 additions & 1 deletion config/examples/delta/Velleman/K8800/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ The firmware here is for the stock Velleman K8800, without any modifications. Fo

## WARNINGS

**NOTE: UBL REQUIRES CHANGES TO THE CURA CONFIGURATION (SEE BELOW)**
> [!IMPORTANT]
> UBL REQUIRES CHANGES TO THE CURA CONFIGURATION (SEE BELOW)
I use this configuration of the Marlin firmware now on an almost daily basis for both small and large prints, but you will no doubt encounter use cases I do not, and may therefore find bugs I have missed. The K8800 is particularly unforgiving of your supposed mistakes and I make no warranty of any kind that this firmware will work correctly for you. Start small and work up, use slower settings on Cura, especially for larger prints.

Expand Down
4 changes: 2 additions & 2 deletions config/examples/linear_axes/Octopus 8 LINEAR_AXES/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The axes are controlled with parameters `X`, `Y`, `Z`, `A`, `B`, `C`, `U`, and `

All axes in this example use the same steps/mm, acceleration, etc.

NOTE: Internal to Marlin the first five additional axes are called I, J, K, U and V. However,
the G-code parameters for extra axes are assigned using AXIS4_NAME, AXIS5_NAME, AXIS6_NAME, etc.
> [!NOTE]
> Internal to Marlin the first five additional axes are called I, J, K, U and V. However, the G-code parameters for extra axes are assigned using AXIS4_NAME, AXIS5_NAME, AXIS6_NAME, etc.
In this example Marlin automatically maps extra axes to the unused E0, E1, E2, E3 and E4 (Z2) stepper ports.
Endstop pins must be assigned manually, so this example assigns endstops as follows:
Expand Down
4 changes: 2 additions & 2 deletions config/examples/linear_axes/RAMPS 5 LINEAR_AXES/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ The axes are controlled with parameters `X`, `Y`, `Z`, `U`, and `V`.

All axes in this example are given the same steps/mm, acceleration, etc.

NOTE: Internal to Marlin the first three additional axes are called I, J, and K. However, the
G-code parameters for extra axes are assigned using AXIS4_NAME, AXIS5_NAME, AXIS6_NAME, etc.
> [!NOTE]
> Internal to Marlin the first three additional axes are called I, J, and K. However, the G-code parameters for extra axes are assigned using AXIS4_NAME, AXIS5_NAME, AXIS6_NAME, etc.
In this example Marlin automatically maps the extra axes to the unused E0 and E1 stepper ports.
Endstop pins must be assigned manually, so this example assigns I_STOP_PIN and J_STOP_PIN to
Expand Down

0 comments on commit 401b40c

Please sign in to comment.