summaryrefslogtreecommitdiff
path: root/static/netbsd/man4/si70xxtemp.4
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 15:32:58 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 15:32:58 -0400
commit5cb84ec742fd33f78c8022863fadaa8d0d93e176 (patch)
tree1a81ca3665e6153923e40db7b0d988f8573ab59c /static/netbsd/man4/si70xxtemp.4
parenta59214f344567c037d5776879bcfc5fcc1d4d5f6 (diff)
feat: Added NetBSD man pages
Diffstat (limited to 'static/netbsd/man4/si70xxtemp.4')
-rw-r--r--static/netbsd/man4/si70xxtemp.4102
1 files changed, 102 insertions, 0 deletions
diff --git a/static/netbsd/man4/si70xxtemp.4 b/static/netbsd/man4/si70xxtemp.4
new file mode 100644
index 00000000..b676c4f0
--- /dev/null
+++ b/static/netbsd/man4/si70xxtemp.4
@@ -0,0 +1,102 @@
+.\" $NetBSD: si70xxtemp.4,v 1.9 2025/01/24 16:12:50 uwe Exp $
+.\"
+.\" Copyright (c) 2017 Brad Spencer <brad@anduin.eldar.org>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd December 28, 2017
+.Dt SI70XXTEMP 4
+.Os
+.Sh NAME
+.Nm si70xxtemp
+.Nd Driver for Silicon Labs SI7013/SI7020/SI7021, HTU21D and SHT21 sensor chip via I2C bus
+.Sh SYNOPSIS
+.Cd "si70xxtemp* at iic? addr 0x40"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides measurements from the SI7013/SI7020/SI7021 humidity/temperature
+sensors via the
+.Xr envsys 4
+framework.
+The
+.Nm
+.Ar addr
+locator selects the address at the
+.Xr iic 4
+bus.
+The resolution, heater control and crc validity can be changed through
+.Xr sysctl 8
+nodes.
+.Sh SYSCTL VARIABLES
+The following
+.Xr sysctl 8
+variables are provided:
+.Bl -tag -width Li
+.It Li hw.si70xxtemp0.resolutions
+Lists the resolutions supported by the driver and chip.
+.It Li hw.si70xxtemp0.resolution
+Set the resolution, or number of bits, used for %RH and temperature.
+Use one of the strings listed in
+.Li hw.si70xxtemp.resolutions .
+.It Li hw.si70xxtemp0.ignorecrc
+If set, the crc calculation for %RH and temperature will be ignored.
+.It Li hw.si70xxtemp0.vddok
+If 1, the chip is getting enough power.
+.It Li hw.si70xxtemp0.heateron
+Turn the heater on and off.
+.It Li hw.si70xxtemp0.heaterstrength
+From 1 to 6, the amount of energy put into the heater.
+The higher the number, the more power used.
+.Pp
+Some HTU21D chips do not support a heater register.
+These chips are detected and the heater features of the driver will
+be disabled.
+.It Li hw.si70xxtemp0.debug
+If the driver is compiled with
+.Dv SI70XX_DEBUG ,
+this node will appear and can be used to set the debugging level.
+.It Li hw.si70xxtemp0.readattempts
+To read %RH or temperature the driver uses a No Hold Master command.
+This command needs to be sent to the device, a wait must then occur
+and then another read command is sent to read back the values.
+Depending on the resolution, and other factors, the wait time varies.
+The driver will attempt to read back the values readattempts number of
+times.
+The default is 40 which should be enough for most purposes.
+There is an initial wait of 10,500 microseconds followed by
+a additional 1,000 microseconds per read attempt.
+.It Li hw.si70xxtemp0.clockstretch
+The chip supports a set of commands that lets it use I2C clock
+stretching to perform the temperature or humidity measurement. If
+this is set to 1 then use the clock stretching commands with the
+device. Note that the I2C controller must support clock stretching
+in order for this to work reliability. When this option is enabled,
+the readattempts sysctl noted above will not be used.
+.El
+.Sh SEE ALSO
+.Xr envsys 4 ,
+.Xr iic 4 ,
+.Xr envstat 8 ,
+.Xr sysctl 8
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Nx 8.0 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Brad Spencer Aq Mt brad@anduin.eldar.org .