aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2022-06-16 18:38:31 -0400
committerKevin O'Connor <kevin@koconnor.net>2022-06-16 18:38:31 -0400
commit55d1c3728df1f2411dfe17bb4d52e1e1280f68f8 (patch)
treef3d1be767c4b288a24517b55c5b9775a28157811 /docs/Config_Reference.md
parent3f3713ee97ed58a5dcd8a196904a14e9c5b81ad9 (diff)
downloadkutter-55d1c3728df1f2411dfe17bb4d52e1e1280f68f8.tar.gz
kutter-55d1c3728df1f2411dfe17bb4d52e1e1280f68f8.tar.xz
kutter-55d1c3728df1f2411dfe17bb4d52e1e1280f68f8.zip
docs: Note that i2c is not noise resilient in Config_Reference.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 8d58e562..9d720d3c 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -4199,6 +4199,13 @@ SPI bus.
The following parameters are generally available for devices using an
I2C bus.
+Note that Klipper's current micro-controller support for i2c is
+generally not tolerant to line noise. Unexpected errors on the i2c
+wires may result in Klipper raising a run-time error. Klipper's
+support for error recovery varies between each micro-controller type.
+It is generally recommended to only use i2c devices that are on the
+same printed circuit board as the micro-controller.
+
```
#i2c_address:
# The i2c address of the device. This must specified as a decimal
@@ -4212,6 +4219,7 @@ I2C bus.
# the type of micro-controller.
#i2c_speed:
# The I2C speed (in Hz) to use when communicating with the device.
-# On some micro-controllers changing this value has no effect. The
-# default is 100000.
+# The Klipper implementation on most micro-controllers is hard-coded
+# to 100000 and changing this value has no effect. The default is
+# 100000.
```