GNU Linux-libre 4.19.211-gnu1
[releases.git] / Documentation / hwmon / shtc1
1 Kernel driver shtc1
2 ===================
3
4 Supported chips:
5   * Sensirion SHTC1
6     Prefix: 'shtc1'
7     Addresses scanned: none
8     Datasheet: http://www.sensirion.com/file/datasheet_shtc1
9
10   * Sensirion SHTW1
11     Prefix: 'shtw1'
12     Addresses scanned: none
13     Datasheet: Not publicly available
14
15 Author:
16   Johannes Winkelmann <johannes.winkelmann@sensirion.com>
17
18 Description
19 -----------
20
21 This driver implements support for the Sensirion SHTC1 chip, a humidity and
22 temperature sensor. Temperature is measured in degrees celsius, relative
23 humidity is expressed as a percentage. Driver can be used as well for SHTW1
24 chip, which has the same electrical interface.
25
26 The device communicates with the I2C protocol. All sensors are set to I2C
27 address 0x70. See Documentation/i2c/instantiating-devices for methods to
28 instantiate the device.
29
30 There are two options configurable by means of shtc1_platform_data:
31 1. blocking (pull the I2C clock line down while performing the measurement) or
32    non-blocking mode. Blocking mode will guarantee the fastest result but
33    the I2C bus will be busy during that time. By default, non-blocking mode
34    is used. Make sure clock-stretching works properly on your device if you
35    want to use blocking mode.
36 2. high or low accuracy. High accuracy is used by default and using it is
37    strongly recommended.
38
39 sysfs-Interface
40 ---------------
41
42 temp1_input - temperature input
43 humidity1_input - humidity input