d1939b25eb16da24292a8db907f01e584a1012dc
[firefly-linux-kernel-4.4.55.git] / Documentation / hwmon / sht15
1 Kernel driver sht15
2 ===================
3
4 Authors:
5   * Wouter Horre
6   * Jonathan Cameron
7   * Vivien Didelot <vivien.didelot@savoirfairelinux.com>
8
9 Supported chips:
10   * Sensirion SHT10
11     Prefix: 'sht10'
12
13   * Sensirion SHT11
14     Prefix: 'sht11'
15
16   * Sensirion SHT15
17     Prefix: 'sht15'
18
19   * Sensirion SHT71
20     Prefix: 'sht71'
21
22   * Sensirion SHT75
23     Prefix: 'sht75'
24
25 Datasheet: Publicly available at the Sensirion website
26 http://www.sensirion.ch/en/pdf/product_information/Datasheet-humidity-sensor-SHT1x.pdf
27
28 Description
29 -----------
30
31 The SHT10, SHT11, SHT15, SHT71, and SHT75 are humidity and temperature
32 sensors.
33
34 The devices communicate using two GPIO lines.
35
36 Supported resolutions for the measurements are 14 bits for temperature and 12
37 bits for humidity, or 12 bits for temperature and 8 bits for humidity.
38
39 The humidity calibration coefficients are programmed into an OTP memory on the
40 chip. These coefficients are used to internally calibrate the signals from the
41 sensors. Disabling the reload of those coefficients allows saving 10ms for each
42 measurement and decrease power consumption, while loosing on precision.
43
44 Some options may be set directly in the sht15_platform_data structure
45 or via sysfs attributes.
46
47 Note: The regulator supply name is set to "vcc".
48
49 Platform data
50 -------------
51
52 * no_otp_reload:
53   flag to indicate not to reload from OTP (default to false).
54 * low_resolution:
55   flag to indicate the temp/humidity resolution to use (default to false).
56
57 Sysfs interface
58 ---------------
59
60 * temp1_input:     temperature input
61 * humidity1_input: humidity input
62 * heater_enable:   write 1 in this attribute to enable the on-chip heater,
63                    0 to disable it. Be careful not to enable the heater
64                    for too long.
65 * temp1_fault:     if 1, this means that the voltage is low (below 2.47V) and
66                    measurement may be invalid.
67 * humidity1_fault: same as temp1_fault.