diff options
| -rw-r--r-- | docs/CANBUS.md | 2 | ||||
| -rw-r--r-- | docs/Command_Templates.md | 3 | ||||
| -rw-r--r-- | docs/Config_Reference.md | 2 | ||||
| -rw-r--r-- | docs/Config_checks.md | 6 | ||||
| -rw-r--r-- | docs/FAQ.md | 4 | ||||
| -rw-r--r-- | docs/Hall_Filament_Width_Sensor.md | 2 | ||||
| -rw-r--r-- | docs/Measuring_Resonances.md | 2 | ||||
| -rw-r--r-- | docs/RPi_microcontroller.md | 4 |
8 files changed, 12 insertions, 13 deletions
diff --git a/docs/CANBUS.md b/docs/CANBUS.md index 5d5b2a08..fc85dc76 100644 --- a/docs/CANBUS.md +++ b/docs/CANBUS.md @@ -8,7 +8,7 @@ Klipper currently only supports CAN on stm32 chips. In addition, the micro-controller chip must support CAN and it must be on a board that has a CAN transceiver. -To compile for CAN, run "make menuconfig" and select "CAN bus" as the +To compile for CAN, run `make menuconfig` and select "CAN bus" as the communication interface. Finally, compile the micro-controller code and flash it to the target board. diff --git a/docs/Command_Templates.md b/docs/Command_Templates.md index 7d5b229e..3aa68c13 100644 --- a/docs/Command_Templates.md +++ b/docs/Command_Templates.md @@ -45,8 +45,7 @@ gcode: SET_PIN PIN=my_led VALUE=0 ``` -This will be showing is you use the `HELP` command or use the autocomplete -function. +The terminal will display the description when you use the `HELP` command or the autocomplete function. ## Save/Restore state for G-Code moves diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index fd77f9e3..f7781484 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -2211,7 +2211,7 @@ sensor_type: ### LM75 temperature sensor LM75/LM75A two wire (I2C) connected temperature sensors. These sensors -have range up to 125 C, so are usable for e.g. chamber temperature +have a range of -55~125 C, so are usable for e.g. chamber temperature monitoring. They can also function as simple fan/heater controllers. ``` diff --git a/docs/Config_checks.md b/docs/Config_checks.md index 1707be74..5a86693a 100644 --- a/docs/Config_checks.md +++ b/docs/Config_checks.md @@ -132,10 +132,10 @@ troubleshooting tips in the previous section to confirm the Klipper supports [PID control](https://en.wikipedia.org/wiki/PID_controller) for the -extruder and bed heaters. In order to use this control mechanism it is -necessary to calibrate the PID settings on each printer. (PID settings +extruder and bed heaters. In order to use this control mechanism, it is +necessary to calibrate the PID settings on each printer (PID settings found in other firmwares or in the example configuration files often -work poorly.) +work poorly). To calibrate the extruder, navigate to the OctoPrint terminal tab and run the PID_CALIBRATE command. For example: `PID_CALIBRATE diff --git a/docs/FAQ.md b/docs/FAQ.md index a9a91ee6..daa92c62 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -15,7 +15,7 @@ 13. [My TMC motor driver turns off in the middle of a print](#my-tmc-motor-driver-turns-off-in-the-middle-of-a-print) 14. [I keep getting random "Lost communication with MCU" errors](#i-keep-getting-random-lost-communication-with-mcu-errors) 15. [My Raspberry Pi keeps rebooting during prints](#my-raspberry-pi-keeps-rebooting-during-prints) -16. [When I set "restart_method=command" my AVR device just hangs on a restart](#when-i-set-restart_methodcommand-my-avr-device-just-hangs-on-a-restart) +16. [When I set `restart_method=command` my AVR device just hangs on a restart](#when-i-set-restart_methodcommand-my-avr-device-just-hangs-on-a-restart) 17. [Will the heaters be left on if the Raspberry Pi crashes?](#will-the-heaters-be-left-on-if-the-raspberry-pi-crashes) 18. [How do I convert a Marlin pin number to a Klipper pin name?](#how-do-i-convert-a-marlin-pin-number-to-a-klipper-pin-name) 19. [Do I have to wire my device to a specific type of micro-controller pin?](#do-i-have-to-wire-my-device-to-a-specific-type-of-micro-controller-pin) @@ -293,7 +293,7 @@ troubleshooting steps for a ["Lost communication with MCU"](#i-keep-getting-random-lost-communication-with-mcu-errors) error. -## When I set "restart_method=command" my AVR device just hangs on a restart +## When I set `restart_method=command` my AVR device just hangs on a restart Some old versions of the AVR bootloader have a known bug in watchdog event handling. This typically manifests when the printer.cfg file has diff --git a/docs/Hall_Filament_Width_Sensor.md b/docs/Hall_Filament_Width_Sensor.md index 2b859a66..978d6450 100644 --- a/docs/Hall_Filament_Width_Sensor.md +++ b/docs/Hall_Filament_Width_Sensor.md @@ -54,7 +54,7 @@ command in terminal. By default, the sensor is disabled at power-on. To enable the sensor, issue **ENABLE_FILAMENT_WIDTH_SENSOR** command or -set the `enable` parameter to `true.` +set the `enable` parameter to `true`. ## Logging diff --git a/docs/Measuring_Resonances.md b/docs/Measuring_Resonances.md index f829a082..6be076b7 100644 --- a/docs/Measuring_Resonances.md +++ b/docs/Measuring_Resonances.md @@ -163,7 +163,7 @@ TEST_RESONANCES AXIS=Y ``` This will generate 2 CSV files (`/tmp/resonances_x_*.csv` and `/tmp/resonances_y_*.csv`). These files can be processed with the stand-alone -script on a Raspberry Pi. To do that, run running the following commands: +script on a Raspberry Pi. To do that, run the following commands: ``` ~/klipper/scripts/calibrate_shaper.py /tmp/resonances_x_*.csv -o /tmp/shaper_calibrate_x.png ~/klipper/scripts/calibrate_shaper.py /tmp/resonances_y_*.csv -o /tmp/shaper_calibrate_y.png diff --git a/docs/RPi_microcontroller.md b/docs/RPi_microcontroller.md index b05c3e8f..591d2864 100644 --- a/docs/RPi_microcontroller.md +++ b/docs/RPi_microcontroller.md @@ -63,10 +63,10 @@ following the instructions in ## 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`. +On Rasperry Pi 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. -To install the _Linux GPIO character device - binary_ on a debian based distro like octopi run: +To install the _Linux GPIO character device - binary_ on a debian based distro like OctoPi run: ``` sudo apt-get install gpiod ``` |