diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml new file mode 100644 index 0000000..d72a612 --- /dev/null +++ b/.github/workflows/mkdocs.yml @@ -0,0 +1,62 @@ +name: Deploy MkDocs to Pages +on: + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow one concurrent deployment +concurrency: + group: "pages" + cancel-in-progress: true + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v4 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v3 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - name: Setup Pages + id: pages + uses: actions/configure-pages@v3 + - name: Install Material for MkDocs + run: pip install mkdocs-material + - name: Build MkDocs + run: mkdocs build + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: ./site + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v3 diff --git a/.gitignore b/.gitignore index eaf930e..26be88b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ .DS_Store .vscode/ out/ +docs/site/ \ No newline at end of file diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/docs/BOM.md b/docs/BOM.md deleted file mode 100644 index 1cc98e2..0000000 --- a/docs/BOM.md +++ /dev/null @@ -1,73 +0,0 @@ -# Xol Toolhead Bill of Materials (BOM) -Read **ALL** of the sections below to understand your hardware requirements, there's some bits here that aren't on a standard Voron build BOM. -The chances are that something was missed, but if you have a good mix of M2, M2.5 and M3 hardware you'll probably still end up with a working printer. - -## Carriage - -#### Required Hardware -| Qty | Item | Notes | -| --- | ----------------- | --------------------------------------------------------------------------------------------------------------------------- | -| 5 | M3 Heatset Insert | Standard Voron spec: 5mm Outer Diameter x 4mm Length | -| 6* | M3 x 6 BHCS | `Only 4 required if using MGN9H carriage`
2x MGN12H carriage rear
2x Carriage front
2x probe module | -| 8* | M3 x 8 SHCS | `only 4 required if using MGN12H carriage`
4x Join carriage front to carriage rear
4x MGN9H carriage mounting | -| 4* | M3 Hex Nut | `Only 2 required if using MGN9H carriage`
4x Carriage rear | -| 2* | M3 x 26 Pin | Belt mounting system for 6mm belts `24mm, 25mm and 26mm pins have all been tested. 26mm is the strongest if pushing limits` | -| 2* | M3 x 30 Pin | Belt mounting system for 9mm belts | - -#### Optional Hardware -| Qty | Item | Notes | -| --- | ----------------- | ------------------------------------------------------- | -| 2 | M3 Heatset Insert | If not using m2.5 heatsets for toolhead feet attachment | - -#### Probe Hardware -Follow probe instructions for required hardware. Where possible, self tapping screws have been replaced with heatset hardware, usually M2. - -`* If using Voron Design TAP RC8+ it is recommended to replace the two M3 x 50 SHCS with M3 x 50 BHCS to improve build plate clearance.` - -## Toolhead - -#### Required Hardware -| Qty | Item | Notes | -| --- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| 4 | M3 Heatset Insert | Standard Voron spec: 5mm Outer Diameter x 4mm Length
* HE Mount | -| 1 | M3 Hex Nut | Hotend Mount mount for front of Extruder Block | -| 6* | M2.5 Heatset Insert | 3.5mm Outer Diameter x 4mm Length
2x HE Mount "Feet" rear mount
*4x hotend fan if using "fan HS" versions | -| 6 | M2 Heatset Insert | 3.5mm Outer Diameter x 4mm Length
Part cooling fan and duct mounting
* 2x Optional Bones | -| 2 | M3 x 20 Metal Stand-off | CAN/EBB Mounting | -| 2 | M3 x 20 SCHS | HE Mount | -| 2 | M3 x ?? SHCS | Extruder to HE Mount. Length varies depending on extruder used | -| 4* | M3 x 16 SHCS | 2x Extruder stepper to standoff
*2x HE Mount feet if using Voron TAP or not using M2.5 hardware | -| 2 | M3 x 12 SHCS | CAN/EBB 36 mount | -| 2 | M2 x 30 SHCS | Optional Bones | -| 3 | M3 x 8 SHCS | 2x HE Adapter to carriage, 1x EBB Mount | -| 1 | M3 x 6 BHCS | Extruder Mount to Hotend Mount at front | -| 4 | M2.5 x 20 SHCS | HE Fan
`The bottom two HE fan screws may impact on Dragon UHF silicone sock. Remove a couple of milimetres of thread with a file or cutters if needed.` | -| 2 | M2.5 x 10 SHCS | HE Mount "Feet" rear mount | -| 6 | M2 x 12 SHCS | Part cooling fan and duct mounting | -| 2 | M2 x 8 SHCS | Part cooling fan and duct mounting - top rear screws | -| 1 | Short PTFE tube | Between extruder and hotend | - -#### Fans -> :information_source: **Understand your electronics and voltages**
-> Do you have the correct voltage at your toolhead or will you need a converter?
-> If using the _recommended_ parts you need 5v, 12v and 24v at the toolhead. - -| Qty | Fan Type | Recommended Fan | Notes | -|-----|------|------|-----| -| 1 | 2510 Axial Fan
Hotend Fan | Delta Electronics 5v
ASB02505SHA-AY6B | Purchase Link
`This fan is highly recommended in heated chambers`
`No other 2510 fan comes close to the performance`
`of this fan.` | -| 2 | 4010 Blower Fan
Part Cooling Fans | Delta Electronics
BFB0412HHA-A (12V) Purchase Link
BFB0405HHA-A (5V) Purchase Link
| `24v GDStime fans are fine and many have used them successfully.`
`The Deltas, however, have better durability`
`in heated chambers and always hit their performance claims.`
`Its not uncommon for other fan manufacturers`
`to overstate performance, GDStime included.`| - -Additional notes: Delta's 5V and 12V variants provide the same airflow, pick whichever suits your setup better. If you only have 24V available, you can use a 24V-12V buck converter like [K78L12-500R3](https://www.digikey.com/en/products/detail/mornsun-america-llc/K78L12-500R3/16784476), or run an additional wire in your umbilical for 12v+. - -#### Optional Hardware -| Qty | Item | Notes| -|-----|------|------| -|1 | M3 Heatset Insert| Sherpa-Mini K-plate attachment| -|1 | M3 Heatset Insert| DFA Custom bottom| -|2 | M3 Heatset Insert| *If not using M2.5 hardware for HE Mount "feet" | -|1 | M2 Heatset Insert | 3.5mm Outer Diameter x 4mm Length
X End stop| -|1 | M2 x 10 SHCS | X End stop| -|1 | 3 LED Neopixel harness | If using LED ducts and faceplate
`Can be self-made for best wire fit, or re-use StealthBurner harness with a short extension to reach toolhead board.` | - -



-⬅ [README](README.md) - [Printed Parts](printing.md) ➡ diff --git a/docs/DFA_MOD_License.md b/docs/DFA_MOD_License.md deleted file mode 100644 index f1039d9..0000000 --- a/docs/DFA_MOD_License.md +++ /dev/null @@ -1,3 +0,0 @@ -The custom STLs that enable support for the Annex Double Folded Ascender are derived from an Annex Engineering design, they are bound by their license. -

-The License Agreement for this "product" can be found here: https://github.com/Annex-Engineering/ANNEX-Engineering-License-Agreement \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index c169058..3f0e073 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,113 +8,3 @@ Project lead: [DW-Tas](https://github.com/DW-Tas) [![Join me on Discord](https://discord.com/api/guilds/1029426383614648421/widget.png?style=banner2)](https://discord.gg/armchairengineeringsux) - -## What's new -`Xol-Toolhead Release 2023-12-21` -* Quality of life improvements - * Cable routing holes are now on both sides of the toolhead - * Cable routing holes can now fit MF3.0 commonly used on hotends - * Awkward M3 Heatset insert replaced with easier to install M3 hex nut for front extruder mount connection - * Rapido hotend mounting points rotated to improve wire routing -* Minimal BOM change - * 1x M3 Hex Nut replaces 1x M3 Heatset Insert - * 1x M3x6 BHCS replaces 1x M3x8 BHCS -* Reworked Extruder mount to Hotend mount interface - * Old Hotend mounts will not work with new Extruder mounts and vice-versa - -`Xol-Toolhead Release 2023-09-15` -* Modular approach to hotend mounts and extruders - * Hotend mounts and extruder mounts are now separate parts - * Extruder mounts incorporate the old Xol-Carriage or TAP adapter plates (same number of printed parts overall) - * "Xol with bones" option: Add some screws for extra rigidity in the hotend mount -* Minimal BOM change - * 1x M3x8 BHCS - * 1x M3 Heatset - * Optional "bones" - * 2x M2x30 SHCS - * 2x M2 Heatset -* Xol-Carriage update - * Stronger belt clips - * bigger probe cable channel with cable tie slot - -`Xol-Toolhead Release 2023-07-14` -* Standardised hotend mounts around the Voron Design CW2/TAP carriage bolt hole pattern. - * This approach reduces the number of hotend mounts and ducts by half - You don't have to search for TAP or non-TAP and we don't have to maintain twice as many parts -* Xol-Carriage - * A new carriage built for Xol-Toolhead - * Uses metal pins and a belt clip to secure the belts instead of having them squashed between mgn9/12 carriage and toolhead carriage - * Improved serviceability - remove the toolhead from the carriage without disassembly in the printer. Unless you use Voron TAP or refuse to buy M2.5 hardware for Xol Carriage. Buy the m2.5 hardware, it's worth it trust us. - * Modular probe mounting system - change probes without changing the whole carriage _`*Except for KlickyNG`_ -* These carriage changes mean you can use any carriage that a Stealthburner bolts onto. (Our Xol-Carriage, or the stock voron carriage even.) - -## Supported hardware -### Hotends -* Rapido -* DropEffect XG -* DropEffect NeXt-G `when released` -* Red Lizard K1-UHF -* Dragon UHF/Mini -* Dragon ST/HF -* Dragon Ace -* Revo Voron -* NF-Crazy (*without duct LEDs) - -### Extruders -* Sherpa Mini -* Annex Double Folded Ascender -* Galileo G2SA -* Escapement -* Vz-Hextrudort-Low -* LGX-Lite -* Orbiter v2.0 - -### Probes -* PCB Klicky -* Klicky -* KlickyNG -* Beacon -* Euclid -* Voron Design TAP `For RC8+ we suggest to use m3x50 BHCS instead of SHCS` - -### X-Rail/Belts -* MGN12H - 6mm Belts -* MGN9H - 6mm Belts -* MGN9H - 9mm Belts - -### Front Idlers -Xol-Toolhead can colide with the stock voron front idlers for Trident and 2.4 when the toolhead is in the front corners of the build area. This can cause also issues with the homing sequence when homing X if the toolhead is at the front of the gantry on Y.
-Fully compatible idlers: -* clee's [BFI (Beefy Front Idlers)](https://github.com/clee/VoronBFI) -* Ramalama2's [Front Idlers](https://github.com/Ramalama2/Voron-2-Mods/tree/main/Front_Idlers) - -## We've made some instructions for printing and assembly. -They took ages to make, please read them. -* [Bill of Materials (BOM)](BOM.md) -* [Printing parts](printing.md) -* [Carriage assembly](xol_carriage_assembly.md) -* [Toolhead assembly](toolhead_assembly.md) - - -## Acknowledgements -* [DW-Tas](https://github.com/DW-Tas) for giving Xol the giant refresh it needed. -* [CorvidBuilds](https://github.com/CorvidBuilds) for Xol1 and Xol2, the predecessors to this project. -* [Long/Mandryd](https://github.com/mandryd/VoronUsers/tree/master/printer_mods/Long/Mantis_Dual_5015) for the Mantis toolhead. -* [Derpimus](https://github.com/lraithel15133) for the exegesis, some CAD work, feedback, and just being a rad dude. -* [KayosMaker](https://github.com/KayosMaker) for the CAN board mounts and spacers. -* [JosAr](https://github.com/jlas1/Klicky-Probe) for Klicky. -* [WhoppingPochard](https://github.com/tanaes) and [VinnyCordeiro](https://github.com/VinnyCordeiro/) for PCB Klicky. -* [Nionio6915](https://github.com/nionio6915/Euclid_Probe) for Euclid. -* [VoronDesign](https://github.com/VoronDesign) for this particular CoreXY flavor. -* [AnnexEngineering](https://github.com/Annex-Engineering) for the Sherpa Mini and Double Folded Ascender extruders, and the K3 that influenced the air management of the ducts. And also for giving access to an early revision of the DFA so it could be adapted for this toolhead. -* [clee](https://github.com/clee), you know what you did. - -



- -This work is licensed under a -[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa]. - -[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa] - -[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/ -[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png -[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg \ No newline at end of file diff --git a/docs/assets/images/logo.png b/docs/assets/images/logo.png new file mode 100644 index 0000000..28e9b81 Binary files /dev/null and b/docs/assets/images/logo.png differ diff --git a/docs/xol_carriage_assembly.md b/docs/carriage/assembly.md similarity index 96% rename from docs/xol_carriage_assembly.md rename to docs/carriage/assembly.md index f9ac33e..d871e30 100644 --- a/docs/xol_carriage_assembly.md +++ b/docs/carriage/assembly.md @@ -1,4 +1,10 @@ -# Xol Carriage Assembly +--- +title: Carriage assembly +description: Assembly instructions for the Xol Carriage +--- + +# Assembly instructions + ![Xol Carriage Image](assets/images/xol_carriage/xol_carriage.png) diff --git a/docs/carriage/bom.md b/docs/carriage/bom.md new file mode 100644 index 0000000..feb9532 --- /dev/null +++ b/docs/carriage/bom.md @@ -0,0 +1,31 @@ +--- +title: Carriage BOM +description: Bill Of Materials and required parts for the Xol Carriage +--- + +# Bill Of Materials + +## Required Hardware + +| Qty | Item | Notes | +| --- | ----------------- | -------------------------------------------------------------------------------------------------------- | +| 5 | M3 Heatset Insert | Standard Voron spec: 5mm Outer Diameter x 4mm Length | +| 6\* | M3 x 6 BHCS | `Only 4 for MGN9H carriage`
2x MGN12H carriage rear
2x Carriage front
2x probe module | +| 8\* | M3 x 8 SHCS | `only 4 for MGN12H carriage`
4x Join carriage front to carriage rear
4x MGN9H carriage mounting | +| 4\* | M3 Hex Nut | `Only 2 for MGN9H carriage`
4x Carriage rear | +| 2\* | M3 x 26 Pin | Belt mounting system for 6mm belts. 24, 25 and 26mm pins have all been tested. 26mm is the strongest if pushing limits | +| 2\* | M3 x 30 Pin | Belt mounting system for 9mm belts | + +* See [Probe Hardware](#probe-hardware) below for footnotes on M3 screws when using a Voron Design TAP RC8+. + +## Optional Hardware + +| Qty | Item | Notes | +| --- | ----------------- | ------------------------------------------------------- | +| 2 | M3 Heatset insert | If not using m2.5 heatsets for toolhead feet attachment | + +## Probe Hardware + +Follow probe instructions for required hardware. Where possible, self tapping screws have been replaced with heatset hardware, usually M2. + +If using Voron Design TAP RC8+ it is recommended to replace the two M3 x 50 **SHCS** with M3 x 50 **BHCS** to improve build plate clearance. diff --git a/docs/carriage/index.md b/docs/carriage/index.md new file mode 100644 index 0000000..62ee966 --- /dev/null +++ b/docs/carriage/index.md @@ -0,0 +1,6 @@ +--- +title: Carriage guide +description: Documentation relating to the Carriage within the Xol ecosystem +--- + +# Xol carriage diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..f7a988d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,61 @@ +--- +title: Introduction +description: Introduction to the Xol toolhead system +--- + +# Introduction + +The Xol Toolhead is a soft reboot of the [Mantis Xol 2 toolhead](https://github.com/Armchair-Engineering/Mantis-Xol). + +The Xol Toolhead was designed with modularity, low barrier of entry, ease of maintenance and quality of life in mind. Several quality-of-life improvements have been implemented over the original Mantis Xol 2 toolhead, making this toolhead truly a worthy successor to the original. + +![Xol Toolhead assembly](assets/images/full_assembly.png) + +--- + +We have left the Mantis carriage behind, and thus are now just Xol-sans-Mantis. +*Don't worry, it's still ugly, we couldn't fix that.* + +## Atrocity + +"Atrocity" is a local meme. + +!["commit atrocity every day" quoted from Discord](https://media.discordapp.net/attachments/1034245907622924348/1062902237329895444/image.png) + +## Join us + +Join us on discord, where an avid and enthusiastic community gathers for *true atrocity* [^1](#Atrocity) + +[![Join me on Discord](https://discord.com/api/guilds/1029426383614648421/widget.png?style=banner2)](https://discord.gg/armchairengineeringsux) + +## Acknowledgements + +* [DW-Tas](https://github.com/DW-Tas) for giving Xol the giant refresh it needed. +* [CorvidBuilds](https://github.com/CorvidBuilds) for Xol1 and Xol2, the predecessors to this project. +* [Long/Mandryd](https://github.com/mandryd/VoronUsers/tree/master/printer_mods/Long/Mantis_Dual_5015) for the Mantis toolhead. +* [Derpimus](https://github.com/lraithel15133) for the exegesis, some CAD work, feedback, and just being a rad dude. +* [KayosMaker](https://github.com/KayosMaker) for the CAN board mounts and spacers. +* [JosAr](https://github.com/jlas1/Klicky-Probe) for Klicky. +* [WhoppingPochard](https://github.com/tanaes) and [VinnyCordeiro](https://github.com/VinnyCordeiro/) for PCB Klicky. +* [Nionio6915](https://github.com/nionio6915/Euclid_Probe) for Euclid. +* [VoronDesign](https://github.com/VoronDesign) for this particular CoreXY flavor. +* [AnnexEngineering](https://github.com/Annex-Engineering) for the Sherpa Mini and Double Folded Ascender extruders, and the K3 that influenced the air management of the ducts. And also for giving access to an early revision of the DFA so it could be adapted for this toolhead. +* [clee](https://github.com/clee), you know what you did. + +## Licensing + +This work is licensed under a[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa]. + +[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa] + +--- + +A disclaimer regarding the **printed parts and models** that provide support for the [Annex Engineering Double Folded Ascender](https://github.com/Annex-Engineering/Folded_Ascender-Extruder) extruder. + +The custom parts that enable support for the [Annex Engineering Double Folded Ascender](https://github.com/Annex-Engineering/Folded_Ascender-Extruder) are **derived from designs by Annex Engineering**, and are therefor bound to adhering by **their license**. These parts are accordingly licensed under the same license as the Annex Engineering design and parts. + +This license agreement can be read through in the [Annex Engineering License Agreement](https://github.com/Annex-Engineering/ANNEX-Engineering-License-Agreement) + +[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/ +[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png +[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg diff --git a/docs/supported-hardware.md b/docs/supported-hardware.md new file mode 100644 index 0000000..5b5c0a7 --- /dev/null +++ b/docs/supported-hardware.md @@ -0,0 +1,61 @@ +--- +title: Supported hardware +description: A list of hot ends, extruders and other printer toolhead parts that are currently compatible with the Xol toolhead and carriage through the provided parts and components +--- + +# Supported hardware + +This list provides a comprehensive yet incomplete summary of the hardware parts and setups that are deemed compatible with the currently available Xol toolhead and carriage parts and components. + +## Hotends + +* Phætus [Rapido](https://www.phaetus.com/products/rapido-hotend) +* DropEffect [XG](https://www.dropeffect.com/products/xg-hotend) +* DropEffect NeXt-G `when released` +* Haldis 3D Red Lizard K1-UHF +* Phætus [Dragon UHF/Mini](https://github.com/Phaetus/Dragon-UHF) +* Phætus [Dragon ST](https://github.com/Phaetus/Dragon-ST) +* Phætus [Dragon HF](https://github.com/Phaetus/Dragon-HF) +* Trianglelab [Dragon Ace](https://www.trianglelab.net/products/dragon-ace%E2%84%A2-hotend) +* E3D [Revo Voron](https://e3d-online.com/products/revo-voron) +* Mellow3D [NF-Crazy](https://github.com/Mellow-3D/NF-Crazy) (*without duct LEDs) + +## Extruders + +* Annex Engineering [Sherpa Mini](https://github.com/Annex-Engineering/Sherpa_Mini-Extruder) +* Annex Engineering [Double Folded Ascender](https://github.com/Annex-Engineering/Folded_Ascender-Extruder) +* [Galileo G2SA](https://github.com/JaredC01/Galileo2) (Standalone) +* Escapement +* [Vz-Hextrudort-Low](https://github.com/VzBoT3D/Vz-HextrudORT) +* Bondtech [LGX-Lite](https://www.bondtech.se/product/lgx-lite-large-gears-extruder/) +* [Orbiter V2.0](https://www.orbiterprojects.com/orbiter-v2-0/) + +## Probes + +* PCB Klicky +* Klicky +* KlickyNG +* Beacon +* Euclid +* Voron Design TAP `For RC8+ we suggest to use m3x50 BHCS instead of SHCS` + +## X-axis rail & belts + +The following combinations of linear rail and timing belt are currently supported: + +* MGN12H - 6mm Belts +* MGN9H - 6mm Belts +* MGN9H - 9mm Belts + +All belts are assumed to be Gates 2GT specification belts + +## Front Idlers + +!!! note "Voron front idlers" + + Xol-Toolhead can colide with the stock voron front idlers for Trident and 2.4 when the toolhead is in the front corners of the build area. This can cause also issues with the homing sequence when homing X if the toolhead is at the front of the gantry on Y. + +Fully compatible idlers: + +* clee's [BFI (Beefy Front Idlers)](https://github.com/clee/VoronBFI) +* Ramalama2's [Front Idlers](https://github.com/Ramalama2/Voron-2-Mods/tree/main/Front_Idlers) diff --git a/docs/theme/.icons/xbox_button_down.svg b/docs/theme/.icons/xbox_button_down.svg new file mode 100644 index 0000000..f361d1a --- /dev/null +++ b/docs/theme/.icons/xbox_button_down.svg @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/theme/.icons/xbox_button_left.svg b/docs/theme/.icons/xbox_button_left.svg new file mode 100644 index 0000000..959df55 --- /dev/null +++ b/docs/theme/.icons/xbox_button_left.svg @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/theme/.icons/xbox_button_right.svg b/docs/theme/.icons/xbox_button_right.svg new file mode 100644 index 0000000..456d03a --- /dev/null +++ b/docs/theme/.icons/xbox_button_right.svg @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/theme/.icons/xbox_button_up.svg b/docs/theme/.icons/xbox_button_up.svg new file mode 100644 index 0000000..38da6a1 --- /dev/null +++ b/docs/theme/.icons/xbox_button_up.svg @@ -0,0 +1,177 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/theme/.icons/xbox_button_x.svg b/docs/theme/.icons/xbox_button_x.svg new file mode 100644 index 0000000..fe27eb0 --- /dev/null +++ b/docs/theme/.icons/xbox_button_x.svg @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/toolhead_assembly.md b/docs/toolhead/assembly.md similarity index 99% rename from docs/toolhead_assembly.md rename to docs/toolhead/assembly.md index 1f9cf03..4d6184d 100644 --- a/docs/toolhead_assembly.md +++ b/docs/toolhead/assembly.md @@ -1,4 +1,9 @@ -# Xol Toolhead Assembly +--- +title: Toolhead assembly +description: Assembly instructions for the Xol Toolhead +--- + +# Assembly instructions diff --git a/docs/toolhead/bom.md b/docs/toolhead/bom.md new file mode 100644 index 0000000..cb8af55 --- /dev/null +++ b/docs/toolhead/bom.md @@ -0,0 +1,83 @@ +--- +title: Toolhead BOM +description: Bill Of Materials and required parts for the Xol Toolhead +--- + +# Bill Of Materials + +## Required Hardware + +| Qty | Item | Notes | +| --- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 4 | M3 Heatset Insert | Standard Voron spec: 5mm Outer Diameter x 4mm Length
* HE Mount | +| 1 | M3 Hex Nut | Hotend Mount mount for front of Extruder Block | +| 6* | M2.5 Heatset Insert | 3.5mm Outer Diameter x 4mm Length
2x HE Mount "Feet" rear mount
*4x hotend fan if using "fan HS" versions | +| 6 | M2 Heatset Insert | 3.5mm Outer Diameter x 4mm Length
Part cooling fan and duct mounting
* 2x Optional Bones | +| 2 | M3 x 20 Metal Stand-off | CAN/EBB Mounting | +| 2 | M3 x 20 SCHS | HE Mount | +| 2 | M3 x ?? SHCS | Extruder to HE Mount. Length varies depending on extruder used | +| 4* | M3 x 16 SHCS | 2x Extruder stepper to standoff
*2x HE Mount feet if using Voron TAP or not using M2.5 hardware | +| 2 | M3 x 12 SHCS | CAN/EBB 36 mount | +| 2 | M2 x 30 SHCS | Optional Bones | +| 3 | M3 x 8 SHCS | 2x HE Adapter to carriage, 1x EBB Mount | +| 1 | M3 x 6 BHCS | Extruder Mount to Hotend Mount at front | +| 4 | M2.5 x 20 SHCS | HE Fan
`The bottom two HE fan screws may impact on Dragon UHF silicone sock. Remove a couple of milimetres of thread with a file or cutters if needed.` | +| 2 | M2.5 x 10 SHCS | HE Mount "Feet" rear mount | +| 6 | M2 x 12 SHCS | Part cooling fan and duct mounting | +| 2 | M2 x 8 SHCS | Part cooling fan and duct mounting - top rear screws | +| 1 | Short PTFE tube | Between extruder and hotend | + +## Fans + +| Qty | Item | Purpose | Notes | +| --- | --------------- | ----------------------------- | --------- | +| 1 | 2510 axial fan | [Hot end](#hot-end) | See below | +| 2 | 4010 radial fan | [Part cooling](#part-cooling) | See below | + +> :information_source: **Understand your electronics and voltages** +> +> Do you have the correct voltage at your toolhead or will you need a converter? +> If using the _recommended_ parts you need 5v, 12v and 24v at the toolhead. + +### Hot end + +Recommendations: + +1. Delta Electronics ASB02505SHA-AY6B + - 5V + - This fan is highly recommended in heated chambers. No other 2510 fan comes close to the performance of this fan. + - Available at [Digikey][ASB02505SHA-AY6B] + +### Part cooling + +Recommendations: + +1. Delta Electronics BFB0412HHA-A + - 12V + - Available at [Digikey][BFB0412HHA-A] +2. Delta Electronics BFB0405HHA-A + - 5V + - Available at [Digikey][BFB0405HHA-A] + +The Delta Electronics BFB0412HHA-A and BFB0405HHA-A provide the same airflow; pick whichever suits your setup better. Higher voltage (V) fans require less current (A) for the same power consumption (W). + +Alternatively, 24V GDStime fans are fine and have been used with some success. Known negatives are the sometimes short or inconsistent lifetime, often overstated specifications, and overall worse durability. +The Delta Electronics fans are our recommendation. They have better durability in heated chambers and always hit their performance claims. +It's not uncommon for other fan manufacturers to overstate performance, GDStime included. + +If you only have 24V available, you can use a step-down regulator like the [K78L12-500R3](https://www.digikey.com/en/products/detail/mornsun-america-llc/K78L12-500R3/16784476), or add an additional 12V power supply. If necessary, run an additional wire in your umbilical cord for this separate voltage rail. + +## Optional Hardware + +| Qty | Item | Notes | +| --- | ----------------- | ------------------------------------------------- | +| 1 | M3 Heatset Insert | Sherpa-Mini K-plate attachment | +| 1 | M3 Heatset Insert | DFA Custom bottom | +| 2 | M3 Heatset Insert | *If not using M2.5 hardware for HE Mount "feet" | +| 1 | M2 Heatset Insert | 3.5mm Outer Diameter x 4mm Length
X End stop | +| 1 | M2 x 10 SHCS | X End stop | +|1 | 3 LED Neopixel harness | If using LED ducts and faceplate
`Can be self-made for best wire fit, or re-use StealthBurner harness with a short extension to reach toolhead board.` | + +[ASB02505SHA-AY6B]: https://www.digikey.com/en/products/detail/delta-electronics/ASB02505SHA-AY6B/7491489 +[BFB0412HHA-A]: https://www.digikey.com/en/products/detail/delta-electronics/BFB0412HHA-A/2560487 +[BFB0405HHA-A]: https://www.digikey.com/en/products/detail/delta-electronics/BFB0405HHA-A/1014444 diff --git a/docs/toolhead/index.md b/docs/toolhead/index.md new file mode 100644 index 0000000..d8298ae --- /dev/null +++ b/docs/toolhead/index.md @@ -0,0 +1,6 @@ +--- +title: Toolhead guide +description: Documentation relating to the Toolhead within the Xol system +--- + +# Xol toolhead diff --git a/docs/updates.md b/docs/updates.md new file mode 100644 index 0000000..9847c16 --- /dev/null +++ b/docs/updates.md @@ -0,0 +1,33 @@ +--- +title: Update log +description: Release update logs documenting changes, additions, removals and fixes. +--- + +# Update log + +## `Xol-Toolhead Release 2023-09-15` + +* Modular approach to hotend mounts and extruders + * Hotend mounts and extruder mounts are now separate parts + * Extruder mounts incorporate the old Xol-Carriage or TAP adapter plates (same number of printed parts overall) + * "Xol with bones" option: Add some screws for extra rigidity in the hotend mount +* Minimal BOM change + * 1x M3x8 BHCS + * 1x M3 Heatset + * Optional "bones" + * 2x M2x30 SHCS + * 2x M2 Heatset +* Xol-Carriage update + * Stronger belt clips + * bigger probe cable channel with cable tie slot + +## `Xol-Toolhead Release 2023-07-14` + +* Standardised hotend mounts around the Voron Design CW2/TAP carriage bolt hole pattern. + * This approach reduces the number of hotend mounts and ducts by half - You don't have to search for TAP or non-TAP and we don't have to maintain twice as many parts +* Xol-Carriage + * A new carriage built for Xol-Toolhead + * Uses metal pins and a belt clip to secure the belts instead of having them squashed between mgn9/12 carriage and toolhead carriage + * Improved serviceability - remove the toolhead from the carriage without disassembly in the printer. Unless you use Voron TAP or refuse to buy M2.5 hardware for Xol Carriage. Buy the m2.5 hardware, it's worth it trust us. + * Modular probe mounting system - change probes without changing the whole carriage _`*Except for KlickyNG`_ +* These carriage changes mean you can use any carriage that a Stealthburner bolts onto. (Our Xol-Carriage, or the stock voron carriage even.) diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..55d0c74 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,65 @@ +site_name: Xol-Toolhead +site_url: https://armchair-engineering.github.io/Xol-Toolhead +repo_url: https://github.com/Armchair-Engineering/Xol-Toolhead +repo_name: Armchair-Engineering/Xol-Toolhead +theme: + name: material + custom_dir: docs/theme + + logo: assets/images/logo.png + favicon: assets/images/logo.png + icon: + admonition: + # Default/stock Material for MkDocs icons + note: octicons/tag-16 + abstract: octicons/checklist-16 + info: octicons/info-16 + tip: octicons/squirrel-16 + success: octicons/check-16 + question: octicons/question-16 + warning: octicons/alert-16 + failure: octicons/x-circle-16 + danger: octicons/zap-16 + bug: octicons/bug-16 + example: octicons/beaker-16 + quote: octicons/quote-16 + repo: fontawesome/brands/github + next: xbox_button_right + previous: xbox_button_left + close: xbox_button_x + + palette: + # Palette toggle for automatic mode + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to system preference + + features: + - navigation.tracking + - navigation.indexes + - navigation.sections + - toc.follow + +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.superfences + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + options: + custom_icons: + - docs/theme/.icons