blob: 485abe037f6cbf6e90afb8943ea151289a2efc03 [file] [log] [blame]
Vivien Didelot99a03782011-04-12 15:34:36 -04001Kernel driver sht15
2===================
3
4Authors:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -03005
Vivien Didelot99a03782011-04-12 15:34:36 -04006 * Wouter Horre
7 * Jonathan Cameron
Vivien Didelotcc15c7e2011-04-12 15:34:38 -04008 * Vivien Didelot <vivien.didelot@savoirfairelinux.com>
Jerome Oufella82c74652011-04-12 15:34:39 -04009 * Jerome Oufella <jerome.oufella@savoirfairelinux.com>
Vivien Didelot99a03782011-04-12 15:34:36 -040010
11Supported chips:
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030012
Vivien Didelot99a03782011-04-12 15:34:36 -040013 * Sensirion SHT10
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030014
Vivien Didelot99a03782011-04-12 15:34:36 -040015 Prefix: 'sht10'
16
17 * Sensirion SHT11
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030018
Vivien Didelot99a03782011-04-12 15:34:36 -040019 Prefix: 'sht11'
20
21 * Sensirion SHT15
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030022
Vivien Didelot99a03782011-04-12 15:34:36 -040023 Prefix: 'sht15'
24
25 * Sensirion SHT71
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030026
Vivien Didelot99a03782011-04-12 15:34:36 -040027 Prefix: 'sht71'
28
29 * Sensirion SHT75
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030030
Vivien Didelot99a03782011-04-12 15:34:36 -040031 Prefix: 'sht75'
32
33Datasheet: Publicly available at the Sensirion website
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030034
35 http://www.sensirion.ch/en/pdf/product_information/Datasheet-humidity-sensor-SHT1x.pdf
Vivien Didelot99a03782011-04-12 15:34:36 -040036
37Description
38-----------
39
40The SHT10, SHT11, SHT15, SHT71, and SHT75 are humidity and temperature
41sensors.
42
Vivien Didelotcc15c7e2011-04-12 15:34:38 -040043The devices communicate using two GPIO lines.
44
45Supported resolutions for the measurements are 14 bits for temperature and 12
46bits for humidity, or 12 bits for temperature and 8 bits for humidity.
47
48The humidity calibration coefficients are programmed into an OTP memory on the
49chip. These coefficients are used to internally calibrate the signals from the
50sensors. Disabling the reload of those coefficients allows saving 10ms for each
Masanari Iida1754e4c2013-04-13 01:22:11 +090051measurement and decrease power consumption, while losing on precision.
Vivien Didelotcc15c7e2011-04-12 15:34:38 -040052
Linus Walleij18673112017-09-10 11:44:46 +020053Some options may be set via sysfs attributes.
Vivien Didelot99a03782011-04-12 15:34:36 -040054
Jerome Oufella82c74652011-04-12 15:34:39 -040055Notes:
56 * The regulator supply name is set to "vcc".
57 * If a CRC validation fails, a soft reset command is sent, which resets
58 status register to its hardware default value, but the driver will try to
59 restore the previous device configuration.
Vivien Didelot99a03782011-04-12 15:34:36 -040060
Vivien Didelotcc15c7e2011-04-12 15:34:38 -040061Platform data
62-------------
63
Jerome Oufella82c74652011-04-12 15:34:39 -040064* checksum:
65 set it to true to enable CRC validation of the readings (default to false).
Vivien Didelotcc15c7e2011-04-12 15:34:38 -040066* no_otp_reload:
67 flag to indicate not to reload from OTP (default to false).
68* low_resolution:
69 flag to indicate the temp/humidity resolution to use (default to false).
70
Vivien Didelot99a03782011-04-12 15:34:36 -040071Sysfs interface
72---------------
73
Mauro Carvalho Chehabb04f2f72019-04-17 06:46:28 -030074================== ==========================================================
75temp1_input temperature input
76humidity1_input humidity input
77heater_enable write 1 in this attribute to enable the on-chip heater,
78 0 to disable it. Be careful not to enable the heater
79 for too long.
80temp1_fault if 1, this means that the voltage is low (below 2.47V) and
81 measurement may be invalid.
82humidity1_fault same as temp1_fault.
83================== ==========================================================