Documentation/hwmon/sht3x.rst

   1 Kernel driver sht3x
   2 ===================
   3
   4 Supported chips:
   5
   6   * Sensirion SHT3x-DIS
   7
   8     Prefix: 'sht3x'
   9
  10     Addresses scanned: none
  11
  12     Datasheet: https://www.sensirion.com/file/datasheet_sht3x_digital
  13
  14 Author:
  15
  16   - David Frey <david.frey@sensirion.com>
  17   - Pascal Sachs <pascal.sachs@sensirion.com>
  18
  19 Description
  20 -----------
  21
  22 This driver implements support for the Sensirion SHT3x-DIS chip, a humidity
  23 and temperature sensor. Temperature is measured in degrees celsius, relative
  24 humidity is expressed as a percentage. In the sysfs interface, all values are
  25 scaled by 1000, i.e. the value for 31.5 degrees celsius is 31500.
  26
  27 The device communicates with the I2C protocol. Sensors can have the I2C
  28 addresses 0x44 or 0x45, depending on the wiring. See
  29 Documentation/i2c/instantiating-devices.rst for methods to instantiate the device.
  30
  31 Even if sht3x sensor supports clock-strech(blocking mode) and non-strench
  32 (non-blocking mode) in single-shot mode, this driver only supports the latter.
  33
  34 The sht3x sensor supports a single shot mode as well as 5 periodic measure
  35 modes, which can be controlled with the update_interval sysfs interface.
  36 The allowed update_interval in milliseconds are as follows:
  37
  38     ===== ======= ====================
  39        0          single shot mode
  40     2000   0.5 Hz periodic measurement
  41     1000   1   Hz periodic measurement
  42      500   2   Hz periodic measurement
  43      250   4   Hz periodic measurement
  44      100  10   Hz periodic measurement
  45     ===== ======= ====================
  46
  47 In the periodic measure mode, the sensor automatically triggers a measurement
  48 with the configured update interval on the chip. When a temperature or humidity
  49 reading exceeds the configured limits, the alert attribute is set to 1 and
  50 the alert pin on the sensor is set to high.
  51 When the temperature and humidity readings move back between the hysteresis
  52 values, the alert bit is set to 0 and the alert pin on the sensor is set to
  53 low.
  54
  55 sysfs-Interface
  56 ---------------
  57
  58 =================== ============================================================
  59 temp1_input:        temperature input
  60 humidity1_input:    humidity input
  61 temp1_max:          temperature max value
  62 temp1_max_hyst:     temperature hysteresis value for max limit
  63 humidity1_max:      humidity max value
  64 humidity1_max_hyst: humidity hysteresis value for max limit
  65 temp1_min:          temperature min value
  66 temp1_min_hyst:     temperature hysteresis value for min limit
  67 humidity1_min:      humidity min value
  68 humidity1_min_hyst: humidity hysteresis value for min limit
  69 temp1_alarm:        alarm flag is set to 1 if the temperature is outside the
  70                     configured limits. Alarm only works in periodic measure mode
  71 humidity1_alarm:    alarm flag is set to 1 if the humidity is outside the
  72                     configured limits. Alarm only works in periodic measure mode
  73 heater_enable:      heater enable, heating element removes excess humidity from
  74                     sensor:
  75
  76                         - 0: turned off
  77                         - 1: turned on
  78 update_interval:    update interval, 0 for single shot, interval in msec
  79                     for periodic measurement. If the interval is not supported
  80                     by the sensor, the next faster interval is chosen
  81 repeatability:      write or read repeatability, higher repeatability means
  82                     longer measurement duration, lower noise level and
  83                     larger energy consumption:
  84
  85                         - 0: low repeatability
  86                         - 1: medium repeatability
  87                         - 2: high repeatability
  88 =================== ============================================================