aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2023-06-20 12:00:59 -0400
committerKevin O'Connor <kevin@koconnor.net>2023-06-20 12:00:59 -0400
commit2ae3dd2f78ddcae98df445ace4f24c9931c35564 (patch)
tree7a3cff2b3182164c24a79dffd812050a1e0a8bd6 /docs
parent9a77d8859bb5d53d194e5e0360e4f82e9637f801 (diff)
downloadkutter-2ae3dd2f78ddcae98df445ace4f24c9931c35564.tar.gz
kutter-2ae3dd2f78ddcae98df445ace4f24c9931c35564.tar.xz
kutter-2ae3dd2f78ddcae98df445ace4f24c9931c35564.zip
docs: Improve documentation of i2c_software_scl_pin/i2c_software_sda_pin
Reported by @rootiest Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Reference.md15
1 files changed, 7 insertions, 8 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index fa770408..e16007fe 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -4343,12 +4343,6 @@ i2c_address:
#i2c_speed:
# See the "common I2C settings" section for a description of the
# above parameters.
-#i2c_bus:
-#i2c_software_scl_pin:
-#i2c_software_sda_pin:
-# If the I2C implementation of your micro-controller supports
-# multiple I2C busses, you may specify the bus name here. The
-# default is to use the default micro-controller i2c bus.
```
### [samd_sercom]
@@ -4595,11 +4589,16 @@ via the `i2c_speed` parameter. All other Klipper micro-controllers use a
# The name of the micro-controller that the chip is connected to.
# The default is "mcu".
#i2c_bus:
-#i2c_software_scl_pin:
-#i2c_software_sda_pin:
# If the micro-controller supports multiple I2C busses then one may
# specify the micro-controller bus name here. The default depends on
# the type of micro-controller.
+#i2c_software_scl_pin:
+#i2c_software_sda_pin:
+# Specify these parameters to use micro-controller software based
+# I2C "bit-banging" support. The two parameters should the two pins
+# on the micro-controller to use for the scl and sda wires. The
+# default is to use hardware based I2C support as specified by the
+# i2c_bus parameter.
#i2c_speed:
# The I2C speed (in Hz) to use when communicating with the device.
# The Klipper implementation on most micro-controllers is hard-coded