sht3x.rst 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. Kernel driver sht3x
  2. ===================
  3. Supported chips:
  4. * Sensirion SHT3x-DIS
  5. Prefix: 'sht3x'
  6. Addresses scanned: none
  7. Datasheets:
  8. - https://sensirion.com/media/documents/213E6A3B/63A5A569/Datasheet_SHT3x_DIS.pdf
  9. - https://sensirion.com/media/documents/051DF50B/639C8101/Sensirion_Humidity_and_Temperature_Sensors_Datasheet_SHT33.pdf
  10. * Sensirion STS3x-DIS
  11. Prefix: 'sts3x'
  12. Addresses scanned: none
  13. Datasheets:
  14. - https://sensirion.com/media/documents/1DA31AFD/61641F76/Sensirion_Temperature_Sensors_STS3x_Datasheet.pdf
  15. - https://sensirion.com/media/documents/292A335C/65537BAF/Sensirion_Datasheet_STS32_STS33.pdf
  16. * Sensirion SHT85
  17. Prefix: 'sht85'
  18. Addresses scanned: none
  19. Datasheet: https://sensirion.com/media/documents/4B40CEF3/640B2346/Sensirion_Humidity_Sensors_SHT85_Datasheet.pdf
  20. Author:
  21. - David Frey <david.frey@sensirion.com>
  22. - Pascal Sachs <pascal.sachs@sensirion.com>
  23. Description
  24. -----------
  25. This driver implements support for the Sensirion SHT3x-DIS, STS3x-DIS and SHT85
  26. series of humidity and temperature sensors. Temperature is measured in degrees
  27. celsius, relative humidity is expressed as a percentage. In the sysfs interface,
  28. all values are scaled by 1000, i.e. the value for 31.5 degrees celsius is 31500.
  29. The device communicates with the I2C protocol. SHT3x sensors can have the I2C
  30. addresses 0x44 or 0x45 (0x4a or 0x4b for sts3x), depending on the wiring. SHT85
  31. address is 0x44 and is fixed. See Documentation/i2c/instantiating-devices.rst for
  32. methods to instantiate the device.
  33. Even if sht3x sensor supports clock-stretch (blocking mode) and non-stretch
  34. (non-blocking mode) in single-shot mode, this driver only supports the latter.
  35. The sht3x sensor supports a single shot mode as well as 5 periodic measure
  36. modes, which can be controlled with the update_interval sysfs interface.
  37. The allowed update_interval in milliseconds are as follows:
  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. In the periodic measure mode, the sensor automatically triggers a measurement
  47. with the configured update interval on the chip. When a temperature or humidity
  48. reading exceeds the configured limits, the alert attribute is set to 1 and
  49. the alert pin on the sensor is set to high.
  50. When the temperature and humidity readings move back between the hysteresis
  51. values, the alert bit is set to 0 and the alert pin on the sensor is set to
  52. low.
  53. The serial number exposed to debugfs allows for unique identification of the
  54. sensors. For sts32, sts33 and sht33, the manufacturer provides calibration
  55. certificates through an API.
  56. sysfs-Interface
  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. - 0: turned off
  76. - 1: turned on
  77. update_interval: update interval, 0 for single shot, interval in msec
  78. for periodic measurement. If the interval is not supported
  79. by the sensor, the next faster interval is chosen
  80. repeatability: write or read repeatability, higher repeatability means
  81. longer measurement duration, lower noise level and
  82. larger energy consumption:
  83. - 0: low repeatability
  84. - 1: medium repeatability
  85. - 2: high repeatability
  86. =================== ============================================================
  87. debugfs-Interface
  88. -----------------
  89. =================== ============================================================
  90. serial_number: unique serial number of the sensor in decimal
  91. =================== ============================================================