summaryrefslogtreecommitdiffstats
path: root/Documentation/hwmon/shtc1.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 10:05:51 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 10:05:51 +0000
commit5d1646d90e1f2cceb9f0828f4b28318cd0ec7744 (patch)
treea94efe259b9009378be6d90eb30d2b019d95c194 /Documentation/hwmon/shtc1.rst
parentInitial commit. (diff)
downloadlinux-upstream/5.10.209.tar.xz
linux-upstream/5.10.209.zip
Adding upstream version 5.10.209.upstream/5.10.209upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/hwmon/shtc1.rst')
-rw-r--r--Documentation/hwmon/shtc1.rst67
1 files changed, 67 insertions, 0 deletions
diff --git a/Documentation/hwmon/shtc1.rst b/Documentation/hwmon/shtc1.rst
new file mode 100644
index 000000000..f38c4c9d2
--- /dev/null
+++ b/Documentation/hwmon/shtc1.rst
@@ -0,0 +1,67 @@
+Kernel driver shtc1
+===================
+
+Supported chips:
+
+ * Sensirion SHTC1
+
+ Prefix: 'shtc1'
+
+ Addresses scanned: none
+
+ Datasheet: https://www.sensirion.com/file/datasheet_shtc1
+
+
+
+ * Sensirion SHTW1
+
+ Prefix: 'shtw1'
+
+ Addresses scanned: none
+
+ Datasheet: https://www.sensirion.com/file/datasheet_shtw1
+
+
+
+ * Sensirion SHTC3
+
+ Prefix: 'shtc3'
+
+ Addresses scanned: none
+
+ Datasheet: https://www.sensirion.com/file/datasheet_shtc3
+
+
+
+Author:
+
+ Johannes Winkelmann <johannes.winkelmann@sensirion.com>
+
+Description
+-----------
+
+This driver implements support for the Sensirion SHTC1, SHTW1, and SHTC3
+chips, a humidity and temperature sensor. Temperature is measured in degrees
+celsius, relative humidity is expressed as a percentage.
+
+The device communicates with the I2C protocol. All sensors are set to I2C
+address 0x70. See Documentation/i2c/instantiating-devices.rst for methods to
+instantiate the device.
+
+There are two options configurable by means of shtc1_platform_data:
+
+1. blocking (pull the I2C clock line down while performing the measurement) or
+ non-blocking mode. Blocking mode will guarantee the fastest result but
+ the I2C bus will be busy during that time. By default, non-blocking mode
+ is used. Make sure clock-stretching works properly on your device if you
+ want to use blocking mode.
+2. high or low accuracy. High accuracy is used by default and using it is
+ strongly recommended.
+
+sysfs-Interface
+---------------
+
+temp1_input
+ - temperature input
+humidity1_input
+ - humidity input