diff options
author | Yifei Ding <dingyifeiair@gmail.com> | 2021-11-20 23:23:56 -0800 |
---|---|---|
committer | Kevin O'Connor <kevin@koconnor.net> | 2021-11-22 21:03:32 -0500 |
commit | a1af78cb83eb91c20126d02012ad8a20405470b4 (patch) | |
tree | cd2507ce1f81a80d1dcb9387e65f629eed4d1c47 /docs/Beaglebone.md | |
parent | 85667649d1422e4b88f9137ffeae58898f66ea50 (diff) | |
download | kutter-a1af78cb83eb91c20126d02012ad8a20405470b4.tar.gz kutter-a1af78cb83eb91c20126d02012ad8a20405470b4.tar.xz kutter-a1af78cb83eb91c20126d02012ad8a20405470b4.zip |
docs: Rename Documents
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
Diffstat (limited to 'docs/Beaglebone.md')
-rw-r--r-- | docs/Beaglebone.md | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/docs/Beaglebone.md b/docs/Beaglebone.md new file mode 100644 index 00000000..67fc9657 --- /dev/null +++ b/docs/Beaglebone.md @@ -0,0 +1,100 @@ +# Beaglebone + +This document describes the process of running Klipper on a Beaglebone +PRU. + +## Building an OS image + +Start by installing the +[Debian 9.9 2019-08-03 4GB SD IoT](https://beagleboard.org/latest-images) +image. One may run the image from either a micro-SD card or from +builtin eMMC. If using the eMMC, install it to eMMC now by following +the instructions from the above link. + +Then ssh into the Beaglebone machine (`ssh debian@beaglebone` -- +password is `temppwd`) and install Klipper by running the following +commands: + +``` +git clone https://github.com/Klipper3d/klipper +./klipper/scripts/install-beaglebone.sh +``` + +## Install Octoprint + +One may then install Octoprint: +``` +git clone https://github.com/foosel/OctoPrint.git +cd OctoPrint/ +virtualenv venv +./venv/bin/python setup.py install +``` + +And setup OctoPrint to start at bootup: +``` +sudo cp ~/OctoPrint/scripts/octoprint.init /etc/init.d/octoprint +sudo chmod +x /etc/init.d/octoprint +sudo cp ~/OctoPrint/scripts/octoprint.default /etc/default/octoprint +sudo update-rc.d octoprint defaults +``` + +It is necessary to modify OctoPrint's **/etc/default/octoprint** +configuration file. One must change the `OCTOPRINT_USER` user to +`debian`, change `NICELEVEL` to `0`, uncomment the `BASEDIR`, `CONFIGFILE`, +and `DAEMON` settings and change the references from `/home/pi/` to +`/home/debian/`: +``` +sudo nano /etc/default/octoprint +``` + +Then start the Octoprint service: +``` +sudo systemctl start octoprint +``` + +Make sure the OctoPrint web server is accessible - it should be at: +[http://beaglebone:5000/](http://beaglebone:5000/) + +## Building the micro-controller code + +To compile the Klipper micro-controller code, start by configuring it +for the "Beaglebone PRU": +``` +cd ~/klipper/ +make menuconfig +``` + +To build and install the new micro-controller code, run: +``` +sudo service klipper stop +make flash +sudo service klipper start +``` + +It is also necessary to compile and install the micro-controller code +for a Linux host process. Configure it a second time for a "Linux process": +``` +make menuconfig +``` + +Then install this micro-controller code as well: +``` +sudo service klipper stop +make flash +sudo service klipper start +``` + +## Remaining configuration + +Complete the installation by configuring Klipper and Octoprint +following the instructions in +the main [Installation](Installation.md#configuring-klipper) document. + +## Printing on the Beaglebone + +Unfortunately, the Beaglebone processor can sometimes struggle to run +OctoPrint well. Print stalls have been known to occur on complex +prints (the printer may move faster than OctoPrint can send movement +commands). If this occurs, consider using the "virtual_sdcard" feature +(see [Config Reference](Config_Reference.md#virtual_sdcard) for +details) to print directly from Klipper. |