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

docs: Minor rewording of Marlin pin number section of FAQ 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2018-08-26 10:09:08 -04:00
parent e6208c6f02
commit 96acfdc6d2
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/FAQ.md
View File

@ -266,10 +266,10 @@ details.
### 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?
Short answer: There isn't an easy way to do that reliably. In some Short answer: In some cases one can use Klipper's `pin_map: arduino`
cases one can use Klipper's `pin_map: arduino` feature. Otherwise, for feature. Otherwise, for "digital" pins, one method is to search for
"digital" pins, one method is to search for the requested pin in the requested pin in Marlin's fastio header files. The Atmega2560 and
Marlin's fastio header files. The Atmega2560 and Atmega1280 chips use Atmega1280 chips use
[fastio_1280.h](https://github.com/MarlinFirmware/Marlin/blob/1.1.9/Marlin/fastio_1280.h), [fastio_1280.h](https://github.com/MarlinFirmware/Marlin/blob/1.1.9/Marlin/fastio_1280.h),
while the Atmega644p and Atmega1284p chips use while the Atmega644p and Atmega1284p chips use
[fastio_644.h](https://github.com/MarlinFirmware/Marlin/blob/1.1.9/Marlin/fastio_644.h). [fastio_644.h](https://github.com/MarlinFirmware/Marlin/blob/1.1.9/Marlin/fastio_644.h).
@ -288,12 +288,12 @@ micro-controller. On the Atmega chips these hardware pins have names
like `PA4`, `PC7`, or `PD2`. like `PA4`, `PC7`, or `PD2`.
Long ago, the Arduino project decided to avoid using the standard Long ago, the Arduino project decided to avoid using the standard
hardware names in favor of pin names based on incrementing numbers - hardware names in favor of their own pin names based on incrementing
these Arduino names generally look like `D23` or `A14`. This was an numbers - these Arduino names generally look like `D23` or `A14`. This
unfortunate choice that has lead to great deal of confusion. In was an unfortunate choice that has lead to a great deal of confusion.
particular the Arduino pin numbers frequently don't translate to the In particular the Arduino pin numbers frequently don't translate to
same hardware names. For example, `D21` is `PD0` on one common Arduino the same hardware names. For example, `D21` is `PD0` on one common
board, but is `PC7` on another common Arduino board. Arduino board, but is `PC7` on another common Arduino board.
In order to support 3d printers based on real Arduino boards, Klipper In order to support 3d printers based on real Arduino boards, Klipper
supports the Arduino pin aliases. This feature is enabled by adding supports the Arduino pin aliases. This feature is enabled by adding
@ -308,9 +308,9 @@ Marlin primarily follows the Arduino pin numbering scheme. However,
Marlin supports a few chips that Arduino does not support and in some Marlin supports a few chips that Arduino does not support and in some
cases it supports pins that Arduino boards do not expose. In these cases it supports pins that Arduino boards do not expose. In these
cases, Marlin chose their own pin numbering scheme. Klipper does not cases, Marlin chose their own pin numbering scheme. Klipper does not
support these custom pin numbers - see the "short answer" section support these custom pin numbers - check Marlin's fastio headers (see
above for information on translating these pin numbers to their above) to translate these pin numbers to their standard hardware
standard hardware names. names.
### How do I upgrade to the latest software? ### How do I upgrade to the latest software?