Add getting started docs

This commit is contained in:
Endorphin3D
2023-05-11 00:06:16 -04:00
parent c84a600284
commit 083a482659
4 changed files with 70 additions and 22 deletions

View File

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
gem "jekyll", "~> 4.3" # installed by `gem jekyll`
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
gem "just-the-docs", "0.5.0" # pinned to the current release
gem "just-the-docs", "0.5.1" # pinned to the current release
# gem "just-the-docs" # always download the latest release

View File

@@ -1,20 +1,21 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.1)
addressable (2.8.4)
public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
concurrent-ruby (1.1.10)
concurrent-ruby (1.2.2)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.15.5)
forwardable-extended (2.6.0)
google-protobuf (3.23.0-arm64-darwin)
http_parser.rb (0.8.0)
i18n (1.12.0)
i18n (1.13.0)
concurrent-ruby (~> 1.0)
jekyll (4.3.0)
jekyll (4.3.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
@@ -30,13 +31,13 @@ GEM
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-sass-converter (2.2.0)
sassc (> 2.0.1, < 3.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
just-the-docs (0.5.0)
just-the-docs (0.5.1)
jekyll (>= 3.8.5)
jekyll-seo-tag (>= 2.0)
rake (>= 12.3.1)
@@ -44,37 +45,34 @@ GEM
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
liquid (4.0.4)
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.0)
public_suffix (5.0.1)
rake (13.0.6)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (4.0.0)
rouge (4.1.0)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
sass-embedded (1.62.1-arm64-darwin)
google-protobuf (~> 3.21)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.3.0)
webrick (1.7.0)
unicode-display_width (2.4.2)
webrick (1.8.1)
PLATFORMS
arm64-darwin-21
x86_64-darwin-19
x86_64-darwin-22
x86_64-linux
arm64-darwin-22
DEPENDENCIES
jekyll (~> 4.3)
just-the-docs (= 0.5.0)
just-the-docs (= 0.5.1)
BUNDLED WITH
2.3.9
2.4.13

Binary file not shown.

After

Width:  |  Height:  |  Size: 836 KiB

50
docs/getting-started.md Normal file
View File

@@ -0,0 +1,50 @@
---
layout: default
title: Getting Started
nav_order: 1
permalink: docs/getting-started
has_toc: true
---
## Software
You might have noticed from the pictures that the Endorphin uses a slightly different belt setup from the original Ender 5, but it's not exactly a CoreXY either. This is known as the "Markforged kinematic" or a "Hybrid CoreXY" and is the central idea behind the Endorphin which allows us the benefits of a CoreXY with far less modification (more on that later). Luckily this kinematic is supported by both Klipper and the stock Marlin firmware with a small modification.
{: .warning }
Don't make these configuration changes until *AFTER* you've printed out all the parts for at least stage 1! You need a working printer (or a second printer) to get stage 1 off the ground.
### Klipper
If you've been thinking about making the leap to Klipper, this might be the push you've been needing. Making config changes to a machine running Klipper is roughly 1000% easier than Marlin. All that's required to configure Klipper to use the new kinematic is editing `printer.cfg` and changing `kinematics` under the `[printer]` section:
```yml
[printer]
kinematics: hybrid_corexy
...
```
Now save and restart and you're done. Seriously, you're done.
### Marlin (Original Firmware)
The Marlin firmware is a bit trickier. To change the kinematics here you need to recompile and flash the firmware on your board.
Start by following the instructions on the [Marlin site](https://marlinfw.org/docs/basics/install_platformio_vscode.html) until you reach the section on example configurations where you're told to "find the configuration files for your printer." Now you'll need to pick the folder that corresponds to the printer + board version. The surest way to figure which board you have is to open up the case and check. If you have a 4.2.7 or a 4.2.2, it'll be printed right under the Creality logo in the center of the board. If you have a v1 board, there will be no version printed at all.
![Endorphin stage 1](/assets/images/docs/getting-started/board.png)
So for example if you have an Ender 5 Pro with a 4.2.2 board, you'll find the correct configuration in the folder `config/examples/Creality/Ender-5 Pro/CrealityV422`.
Next we need to configure the firmware to use the Markforged kinematic. This only requires editing a single line in the `Configuration.h` file. If you search the file for "MARKFORGED_XY" you should see this line several hundred lines down:
```c
//#define MARKFORGED_XY
```
You'll want to un-comment this line, like so:
```c
#define MARKFORGED_XY
```
Now you can continue following the Marlin guide exactly as you normally would. Once you've compiled, you can put the new firmware file (usually `firmware.bin`) at the root of your microSD card. Just to be 100% certain the printer will recognize the new firmware, rename the file `firmware-endorphin.bin`. Then with your printer powered off, insert the SD card and power the printer on. Wait a few minutes to ensure the install finishes, then power the printer down and remove the card. Delete `firmware-endorphin.bin` and you're done!