share/man/man4/htu21.4

   1 .\"
   2 .\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3 .\"
   4 .\" Copyright (c) 2021 Andriy Gapon <avg@FreeBSD.org>
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD$
  28 .\"
  29 .Dd January 19, 2021
  30 .Dt HTU21 4
  31 .Os
  32 .Sh NAME
  33 .Nm htu21
  34 .Nd driver for HTU21D and compatible temperature and humidity sensors
  35 .Sh SYNOPSIS
  36 To compile this driver into the kernel,
  37 place the following lines in your
  38 kernel configuration file:
  39 .Bd -ragged -offset indent
  40 .Cd "device htu21"
  41 .Cd "device iicbus"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 htu21_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides temperature and relative humidity readings over I2C bus
  54 for the supported sensors:
  55 .Bl -bullet -compact
  56 .It
  57 HTU21D
  58 .It
  59 SHT21
  60 .It
  61 Si7021
  62 .El
  63 .Pp
  64 The
  65 .Nm
  66 driver reports data via
  67 .Xr sysctl 8
  68 entries in the device's node in the
  69 .Xr sysctl 8
  70 tree:
  71 .Bl -tag -width temperature
  72 .It temperature
  73 The temperature, in hundredths of Kelvin.
  74 .It humidity
  75 The relative humidity, in hundredths of a percent.
  76 .It crc_errors
  77 The number of CRC errors in reading the measurements from the device.
  78 .It power
  79 The good power indication.
  80 This can be useful with battery powered sensors.
  81 .It heater
  82 The built-in heater control.
  83 The heater can be used for testing and for recovery from saturation
  84 after high humidity.
  85 .It hold_bus
  86 Whether the sensor should hold SCL low while performing the measurement.
  87 Normally, the sensor releases the bus and NACKs all accessed until the
  88 measurement is completed.
  89 The hold mode may be useful in mult-master environments.
  90 .El
  91 .Pp
  92 On an
  93 .Xr FDT 4
  94 based system the following properties must be set:
  95 .Bl -tag -width "compatible"
  96 .It Va compatible
  97 Must be set to "meas,htu21".
  98 .It Va reg
  99 The I2C address of
 100 .Nm .
 101 Although, it is hard-wired to 0x40 (7-bit) on all supported sensors.
 102 .El
 103 .Pp
 104 The DTS part for a
 105 .Nm
 106 device usually looks like:
 107 .Bd -literal
 108 / {
 109
 110         ...
 111         htu21d {
 112                 compatible = "meas,htu21";
 113                 reg = <0x40>;
 114         };
 115 };
 116 .Ed
 117 .Sh SEE ALSO
 118 .Xr fdt 4 ,
 119 .Xr iicbus 4 ,
 120 .Xr sysctl 8
 121 .Sh HISTORY
 122 The
 123 .Nm
 124 driver and this manual page was written by
 125 .An Andriy Gapon Aq Mt avg@FreeBSD.org .
 126 .Sh BUGS
 127 There is no way to control the measurment resolution.
 128 .Pp
 129 Some sensor variants do not provide a serial number or use an incompatible
 130 format.
 131 The
 132 .Nm
 133 driver does not distinguish those variants and may complain about incorrect
 134 serial number checksum.