Skip to content

Commit

Permalink
Rewrite
Browse files Browse the repository at this point in the history
  • Loading branch information
reemo3dp committed Jan 1, 2024
1 parent 4965f3c commit 7ab0342
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 4 deletions.
13 changes: 13 additions & 0 deletions docs/guides/Identifying_the_MCU_serial.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Identifying the mcu on your host maschine

This tutorial guides you through the steps of identifying the serial connection klipper needs to communicate with your mcu. It needs to be done for each mcu in your printer, e.g. for a display, input shaper, klipper expander, etc.

See also https://www.klipper3d.org/Installation.html#configuring-klipper

Power on the host and make sure all mcu‎s you want to use are connected and powered on.
[Connect to your host using SSH](https://docs.vorondesign.com/build/software/ssh.html) and run the following commands:


## Troubleshooting

### The folder `/dev/serial/` doesn't exist
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# Home
# Reemo's 3D Printing Notes

## Disclaimer (borrowed from GPL3)
> THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
Empty file.
Empty file removed docs/troubleshooting/index.md
Empty file.
3 changes: 3 additions & 0 deletions includes/glossary.md
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
*[lsusb]: A read-only utility on Linux that shows connected USB devices
*[host]: A linux machine (e.g. a raspberry pi, or a CB1 on a Manta board) that runs klippy, moonraker, mainsail etc.
*[klippy]: The part of klipper that runs on the host
*[mcu]: A microcontroller that runs klipper. Needs a host, and is manually flashed using CAN, HID, DFU or SDCards. A 3d printer can have multiple MCUs, but only one host.
14 changes: 11 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
site_name: Reemo's 3D Printing Notes
site_url: https://github.com/reemo3dp/notes
site_url: https://reemo3dp.github.io/
site_author: Reemo3dp
site_description: >-
Notes and snippets for various klipper / voron related topics
repo_name: reemo3dp/notes
repo_url: https://github.com/reemo3dp/notes
repo_name: reemo3dp/reemo3dp.github.io
repo_url: https://github.com/reemo3dp/reemo3dp.github.io

theme:
name: material
features:
- content.tooltips
- content.code.annotate
- content.code.copy
- navigation.tabs
palette:
scheme: slate
Expand All @@ -23,7 +25,13 @@ markdown_extensions:
- attr_list
- md_in_html
- pymdownx.details
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.snippets:
auto_append:
- includes/glossary.md
Expand Down

0 comments on commit 7ab0342

Please sign in to comment.