CreatBot/CreatBotKlipper
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs : make modifications to all md files to make them compatible with mkdocs

Browse Source 
all markdown files must have a single H1 heading at the top.

Signed-off-by: Damien Martin <damlobster@gmail.com>

Update CNAME
This commit is contained in:
Damien
2021-07-22 00:40:40 +02:00
committed by KevinOConnor
parent 7e88f9220c
commit cff61605fb
44 changed files with 565 additions and 536 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/RPi_microcontroller.md
View File

@@ -1,8 +1,10 @@
# RPi microcontroller
This document describes the process of running Klipper on a RPi
and use the same RPi as secondary mcu.
Why use RPi as a secondary MCU?
===============================
## Why use RPi as a secondary MCU?
Often the MCUs dedicated to controlling 3D printers have a limited and
pre-configured number of exposed pins to manage the main printing
functions (thermal resistors, extruders, steppers ...).
@@ -13,8 +15,7 @@ programs giving the ability to control everything within the print GCODE.
**Warning**: If your platform is a _Beaglebone_ and you have correctly followed the installation steps, the linux mcu is already installed and configured for your system.
Install the rc script
=====================
## Install the rc script
If you want to use the host as a secondary MCU the klipper_mcu process must run before the klippy process.
@@ -25,12 +26,11 @@ sudo cp "./scripts/klipper-mcu-start.sh" /etc/init.d/klipper_mcu
sudo update-rc.d klipper_mcu defaults
```
Enabling SPI
============
## Enabling SPI
Make sure the Linux SPI driver is enabled by running sudo raspi-config and enabling SPI under the "Interfacing options" menu.
Building the micro-controller code
==================================
## Building the micro-controller code
To compile the Klipper micro-controller code, start by configuring it
for the "Linux process":
@@ -54,16 +54,15 @@ The following command will add the "pi" user to the tty group:
sudo usermod -a -G tty pi
```
Remaining configuration
=======================
## Remaining configuration
Complete the installation by configuring Klipper secondary MCU
following the instructions in
[RaspberryPi sample config](../config/sample-raspberry-pi.cfg) and
[Multi MCU sample config](../config/sample-multi-mcu.cfg).
Optional: Identify the correct gpiochip
=======================================
## Optional: Identify the correct gpiochip
On Rasperry and on many clones the pins exposed on the GPIO belong to the first gpiochip. They can therefore be used on klipper simply by referring them with the name `gpio0..n`.
However, there are cases in which the exposed pins belong to gpiochips other than the first. For example in the case of some OrangePi models or if a Port Expander is used. In these cases it is useful to use the commands to access the _Linux GPIO character device_ to verify the configuration.
@@ -159,8 +158,8 @@ gpiochip1 - 8 lines:
line 7: unnamed unused input active-high
```
Optional: Hardware PWM
=======================================
## Optional: Hardware PWM
Raspberry Pi's have two PWM channels (PWM0 and PWM1) which are exposed on the header or if not, can be routed to existing gpio pins.
The Linux mcu daemon uses the pwmchip sysfs interface to control hardware pwm devices on Linux hosts.
The pwm sysfs interface is not exposed by default on a Raspberry and can be activated by adding a line to ```/boot/config.txt```: