docs: Deprecate support for the pin_map config option

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2021-03-19 13:17:49 -04:00
parent 681ca5be62
commit dd4f2d81b6
3 changed files with 7 additions and 10 deletions

View File

@ -6,6 +6,11 @@ All dates in this document are approximate.
# Changes
20210325: Support for the `pin_map` config option is deprecated. Use
the [sample-aliases.cfg](../config/sample-aliases.cfg) file to
translate to the actual micro-controller pin names. The `pin_map`
config option will be removed in the near future.
20210313: Klipper's support for micro-controllers that communicate
with CAN bus has changed. If using CAN bus then all micro-controllers
must be reflashed and the [Klipper configuration must be

View File

@ -13,11 +13,6 @@ Klipper and choosing an initial config file.
Many config options require the name of a micro-controller pin.
Klipper uses the hardware names for these pins - for example `PA4`.
For AVR micro-controllers one may also use an Arduino alias (such as
"ar29" or "analog3"). In order to use Arduino names, the `pin_map`
variable in the `[mcu]` section must be present and have a value of
`arduino`.
Pin names may be preceded by `!` to indicate that a reverse polarity
should be used (eg, trigger on low instead of high).
@ -49,9 +44,6 @@ serial:
#canbus_interface:
# If using a device connected to a CAN bus then this sets the CAN
# network interface to use. The default is 'can0'.
#pin_map:
# This option may be used to enable Arduino pin name aliases. The
# default is to not enable the aliases.
#restart_method:
# This controls the mechanism the host will use to reset the
# micro-controller. The choices are 'arduino', 'cheetah', 'rpi_usb',

View File

@ -82,8 +82,8 @@ directory](../config/).
170` as that is already the default value.
7. Where possible, lines should not exceed 80 columns.
7. Do not use any deprecated features in the example config file. The
`step_distance` parameter is deprecated and should not be in any
example config file.
`step_distance` and `pin_map` parameters are deprecated and should
not be in any example config file.
8. Do not disable a default safety system in an example config file.
For example, a config should not specify a custom
`max_extrude_cross_section`. Do not enable debugging features. For