aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDr. Matthew Swabey <matthew@swabey.org>2023-03-21 15:02:58 -0400
committerGitHub <noreply@github.com>2023-03-21 15:02:58 -0400
commit2466b7a2c6544fb585acb47871c75f2816629a2b (patch)
tree911cc498f71e26e891373161aaca2e6b2d003293 /docs
parente2d7c59812ef192c1d495b6702cb5f56271118a8 (diff)
downloadkutter-2466b7a2c6544fb585acb47871c75f2816629a2b.tar.gz
kutter-2466b7a2c6544fb585acb47871c75f2816629a2b.tar.xz
kutter-2466b7a2c6544fb585acb47871c75f2816629a2b.zip
avr: Allow I2C bus speed to be set by Klipper (#6111)
Allow I2C bus speed to be set by appropriate Klipper commands. Signed-off-by: Matthew Swabey <matthew@swabey.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Reference.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index 494a4733..4e648847 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -4508,20 +4508,20 @@ 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
+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
+It is generally recommended to only use I2C devices that are on the
same printed circuit board as the micro-controller.
Most Klipper micro-controller implementations only support an
-`i2c_speed` of 100000. The Klipper "linux" micro-controller supports a
-400000 speed, but it must be
+`i2c_speed` of 100000 (*standard mode*, 100kbit/s). The Klipper "Linux"
+micro-controller supports a 400000 speed (*fast mode*, 400kbit/s), but it must be
[set in the operating system](RPi_microcontroller.md#optional-enabling-i2c)
and the `i2c_speed` parameter is otherwise ignored. The Klipper
-"rp2040" micro-controller supports a rate of 400000 via the
-`i2c_speed` parameter. All other Klipper micro-controllers use a
+"RP2040" micro-controller and ATmega AVR family support a rate of 400000
+via the `i2c_speed` parameter. All other Klipper micro-controllers use a
100000 rate and ignore the `i2c_speed` parameter.
```
@@ -4539,5 +4539,5 @@ and the `i2c_speed` parameter is otherwise ignored. The Klipper
# The I2C speed (in Hz) to use when communicating with the device.
# The Klipper implementation on most micro-controllers is hard-coded
# to 100000 and changing this value has no effect. The default is
-# 100000.
+# 100000. Linux, RP2040 and ATmega support 400000.
```