3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update Installation document to suggest using /dev/serial/by-id/ 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2019-02-27 19:47:16 -05:00
parent 264505a1b0
commit 88ebedcc63
1 changed files with 38 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/Installation.md
View File

@ -56,19 +56,41 @@ provided. Once configured, run:
make make
``` ```
Finally, for common micro-controllers, the code can be flashed with: It is necessary to determine the serial port connected to the
micro-controller. For micro-controllers that connect via USB, run the
following:
```
ls /dev/serial/by-id/*
```
It should report something similar to the following:
```
/dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
```
It's common for each printer to have its own unique serial port name.
This unique name will be used when flashing the micro-controller. It's
possible there may be multiple lines in the above output - if so,
choose the line corresponding to the micro-controller (see the
[FAQ](FAQ.md#wheres-my-serial-port) for more information).
For common micro-controllers, the code can be flashed with something
similar to:
``` ```
sudo service klipper stop sudo service klipper stop
make flash FLASH_DEVICE=/dev/ttyACM0 make flash FLASH_DEVICE=/dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
sudo service klipper start sudo service klipper start
``` ```
Be sure to update the FLASH_DEVICE with the printer's unique serial
port name.
When flashing for the first time, make sure that OctoPrint is not When flashing for the first time, make sure that OctoPrint is not
connected directly to the printer (from the OctoPrint web page, under connected directly to the printer (from the OctoPrint web page, under
the "Connection" section, click "Disconnect"). The most common the "Connection" section, click "Disconnect").
communication device is **/dev/ttyACM0** - see the
[FAQ](FAQ.md#wheres-my-serial-port) for other possibilities.
Configuring OctoPrint to use Klipper Configuring OctoPrint to use Klipper
==================================== ====================================
@ -127,6 +149,17 @@ nano ~/printer.cfg
Make sure to review and update each setting that is appropriate for Make sure to review and update each setting that is appropriate for
the hardware. the hardware.
It's common for each printer to have its own unique name for the
micro-controller. The name may change after flashing Klipper, so rerun
the `ls /dev/serial/by-id/*` command and then update the config file
with the unique name. For example, update the `[mcu]` section to look
something similar to:
```
[mcu]
serial: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0
```
After creating and editing the file it will be necessary to issue a After creating and editing the file it will be necessary to issue a
"restart" command in the OctoPrint web terminal to load the config. A "restart" command in the OctoPrint web terminal to load the config. A
"status" command will report the printer is ready if the Klipper "status" command will report the printer is ready if the Klipper