aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2021-03-19 13:17:49 -0400
committerKevin O'Connor <kevin@koconnor.net>2021-03-25 10:50:56 -0400
commitdd4f2d81b6683afb304c3d104fae2360a70cc644 (patch)
treea06b5cc906ac4436da89f8fb319b27a9a7af3225
parent681ca5be62652ffb5fe940d458e39b20c705eed5 (diff)
downloadkutter-dd4f2d81b6683afb304c3d104fae2360a70cc644.tar.gz
kutter-dd4f2d81b6683afb304c3d104fae2360a70cc644.tar.xz
kutter-dd4f2d81b6683afb304c3d104fae2360a70cc644.zip
docs: Deprecate support for the pin_map config option
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
-rw-r--r--docs/Config_Changes.md5
-rw-r--r--docs/Config_Reference.md8
-rw-r--r--docs/Example_Configs.md4
3 files changed, 7 insertions, 10 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md
index 2c44b1c5..bf8f1124 100644
--- a/docs/Config_Changes.md
+++ b/docs/Config_Changes.md
@@ -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
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index e69ac4ae..82264fd8 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -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',
diff --git a/docs/Example_Configs.md b/docs/Example_Configs.md
index 53823fcf..aa18b06c 100644
--- a/docs/Example_Configs.md
+++ b/docs/Example_Configs.md
@@ -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