aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
diff options
context:
space:
mode:
authorGareth Farrington <gareth@waves.ky>2024-10-24 08:07:05 -0700
committerGitHub <noreply@github.com>2024-10-24 11:07:05 -0400
commit0c806d84f706384d7274f17c155f194b3bfcb7c7 (patch)
treebe2b1663a105166d3d7c941f707b39f02710c7b8 /docs/Config_Reference.md
parent55339998e5e7e3931f35331d97a1da31a91748ef (diff)
downloadkutter-0c806d84f706384d7274f17c155f194b3bfcb7c7.tar.gz
kutter-0c806d84f706384d7274f17c155f194b3bfcb7c7.tar.xz
kutter-0c806d84f706384d7274f17c155f194b3bfcb7c7.zip
ads1220: Add input_mux and vref options to ADS1220 sensor (#6713)
* fix type comparison bug that stopped the sensor from initializing * correct mismatch between docs and code for `sample_rate` (fixed to work same as hx71x) * add input_mux, pga_bypass and vref options * update configuration reference & fix typo Signed-off-by: Gareth Farrington <gareth@waves.ky>
Diffstat (limited to 'docs/Config_Reference.md')
-rw-r--r--docs/Config_Reference.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md
index a06b928c..94379a75 100644
--- a/docs/Config_Reference.md
+++ b/docs/Config_Reference.md
@@ -4729,13 +4729,30 @@ data_ready_pin:
#gain: 128
# Valid gain values are 128, 64, 32, 16, 8, 4, 2, 1
# The default is 128
+#pga_bypass: False
+# Disable the internal Programmable Gain Amplifier. If
+# True the PGA will be disabled for gains 1, 2, and 4. The PGA is always
+# enabled for gain settings 8 to 128, regardless of the pga_bypass setting.
+# If AVSS is used as an input pga_bypass is forced to True.
+# The default is False.
#sample_rate: 660
# This chip supports two ranges of sample rates, Normal and Turbo. In turbo
-# mode the chips c internal clock runs twice as fast and the SPI communication
+# mode the chip's internal clock runs twice as fast and the SPI communication
# speed is also doubled.
# Normal sample rates: 20, 45, 90, 175, 330, 600, 1000
# Turbo sample rates: 40, 90, 180, 350, 660, 1200, 2000
# The default is 660
+#input_mux:
+# Input multiplexer configuration, select a pair of pins to use. The first pin
+# is the positive, AINP, and the second pin is the negative, AINN. Valid
+# values are: 'AIN0_AIN1', 'AIN0_AIN2', 'AIN0_AIN3', 'AIN1_AIN2', 'AIN1_AIN3',
+# 'AIN2_AIN3', 'AIN1_AIN0', 'AIN3_AIN2', 'AIN0_AVSS', 'AIN1_AVSS', 'AIN2_AVSS'
+# and 'AIN3_AVSS'. If AVSS is used the PGA is bypassed and the pga_bypass
+# setting will be forced to True.
+# The default is AIN0_AIN1.
+#vref:
+# The selected voltage reference. Valid values are: 'internal', 'REF0', 'REF1'
+# and 'analog_supply'. Default is 'internal'.
```
## Board specific hardware support