aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKevin O'Connor <kevin@koconnor.net>2025-07-14 13:27:17 -0400
committerKevin O'Connor <kevin@koconnor.net>2025-07-22 14:04:50 -0400
commita209d4db5b99d62c745179aee407330da7e67e81 (patch)
tree36a4722e1009f2a1bc356632677ee0c5706c2a8a /docs
parent354b1e666b92d1b51bf19b3d834848d6ce1639df (diff)
downloadkutter-a209d4db5b99d62c745179aee407330da7e67e81.tar.gz
kutter-a209d4db5b99d62c745179aee407330da7e67e81.tar.xz
kutter-a209d4db5b99d62c745179aee407330da7e67e81.zip
mcp4018: Remove support for manual i2c - use standard mcu software i2c instead
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
-rw-r--r--docs/Config_Changes.md4
-rw-r--r--docs/Config_Reference.md19
2 files changed, 14 insertions, 9 deletions
diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md
index 00179192..559c84f8 100644
--- a/docs/Config_Changes.md
+++ b/docs/Config_Changes.md
@@ -8,8 +8,8 @@ All dates in this document are approximate.
## Changes
-20250721: The `[pca9632]` module no longer accepts the `scl_pin` and
-`sda_pin` options. Use `i2c_software_scl_pin` and
+20250721: The `[pca9632]` and `[mcp4018]` modules no longer accept the
+`scl_pin` and `sda_pin` options. Use `i2c_software_scl_pin` and
`i2c_software_sda_pin` instead.
20250428: The maximum `cycle_time` for pwm `[output_pin]`,
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index bc99bd94..3fd035a6 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -4392,16 +4392,21 @@ prefix).
### [mcp4018]
-Statically configured MCP4018 digipot connected via two gpio "bit
-banging" pins (one may define any number of sections with an "mcp4018"
-prefix).
+Statically configured MCP4018 digipot connected via i2c (one may
+define any number of sections with an "mcp4018" prefix).
```
[mcp4018 my_digipot]
-scl_pin:
-# The SCL "clock" pin. This parameter must be provided.
-sda_pin:
-# The SDA "data" pin. This parameter must be provided.
+#i2c_address: 47
+# The i2c address that the chip is using on the i2c bus. The default
+# is 47.
+#i2c_mcu:
+#i2c_bus:
+#i2c_software_scl_pin:
+#i2c_software_sda_pin:
+#i2c_speed:
+# See the "common I2C settings" section for a description of the
+# above parameters.
wiper:
# The value to statically set the given MCP4018 "wiper" to. This is
# typically set to a number between 0.0 and 1.0 with 1.0 being the