New sentence, new line. Use more markup.

This commit is contained in:
wiz 2017-12-29 14:47:09 +00:00
parent 53f6c5b7d4
commit 5c92006c27
2 changed files with 29 additions and 20 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: am2315temp.4,v 1.1 2017/12/28 23:28:00 christos Exp $
.\" $NetBSD: am2315temp.4,v 1.2 2017/12/29 14:47:09 wiz Exp $
.\"
.\" Copyright (c) 2017 Brad Spencer <brad@anduin.eldar.org>
.\"
@ -34,7 +34,8 @@ The
.Ar addr
argument selects the address at the
.Xr iic 4
bus. The AM2315 has limits on how often the measurements can be read.
bus.
The AM2315 has limits on how often the measurements can be read.
Adjustments to the number of times to take reading before considering
it valid, and the number of ticks to wait between readings can be
changed through
@ -45,27 +46,33 @@ There are other oddities about the AM2315 that should be mentioned.
The datasheet says that the device should read no more often then
every 2 seconds, further, it also implies that a measurement is not
performed until the device is 1) awake 2) has been asked for a
measurement. From observation, it has been noted that it is possible
measurement.
From observation, it has been noted that it is possible
to ask for measurements more often than every 2 seconds, and actually
get something that looks to be valid. It may, in fact, be valid, but
get something that looks to be valid.
It may, in fact, be valid, but
it has also been noted that the measurements do not appear to change.
This implies that a measurement was done, and then returned time and
time again. It has also been noticed that if measurements are taken
time again.
It has also been noticed that if measurements are taken
very close to every 2 seconds, that sometimes the device will return a
I2C error on a read. If this happens a lot, increase
hw.am2315temp0.readticks a bit.
I2C error on a read.
If this happens a lot, increase hw.am2315temp0.readticks a bit.
.Sh SYSCTL VARIABLES
The following
.Xr sysctl 3
variables are provided:
.Bl -tag -width indent
.It hw.am2315temp0.readcount
The number of times to take a reading before considering it valid. This defaults to 2.
The number of times to take a reading before considering it valid.
This defaults to 2.
.It hw.am2315temp0.readticks
The number of ticks to wait in between readings. The default is 100.
The number of ticks to wait in between readings.
The default is 100.
.It hw.am2315temp0.debug
If the driver is compiled with AM2315_DEBUG, this node will appear and
can be used to set the debugging level.
If the driver is compiled with
.Dv AM2315_DEBUG ,
this node will appear and can be used to set the debugging level.
.El
.Sh SEE ALSO
.Xr envsys 4 ,
@ -86,5 +93,5 @@ driver was written by
.Sh BUGS
The device does not appear to work with the
.Xr gpioiic 4
bitbang controller. When tried, reads would not error, but no data
was returned.
bitbang controller.
When tried, reads would not error, but no data was returned.

View File

@ -1,4 +1,4 @@
.\" $NetBSD: si70xxtemp.4,v 1.1 2017/12/28 23:28:00 christos Exp $
.\" $NetBSD: si70xxtemp.4,v 1.2 2017/12/29 14:47:09 wiz Exp $
.\"
.\" Copyright (c) 2017 Brad Spencer <brad@anduin.eldar.org>
.\"
@ -55,19 +55,21 @@ If 1, the chip is getting enough power.
.It hw.si70xxtemp0.heateron
Turn the heater on and off.
.It hw.si70xxtemp0.heaterstrength
From 1 to 6, the amount of energy put into the heater. The higher the
number, the more power used.
From 1 to 6, the amount of energy put into the heater.
The higher the number, the more power used.
.It hw.si70xxtemp0.debug
If the driver is compiled with SI70XX_DEBUG, this node will appear and
can be used to set the debugging level.
If the driver is compiled with
.Dv SI70XX_DEBUG ,
this node will appear and can be used to set the debugging level.
.It 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 15 which should be more than enough for most
purposes. There is an intial wait of 10,500 microseconds followed by
times.
The default is 15 which should be more than enough for most purposes.
There is an intial wait of 10,500 microseconds followed by
a additional 1,000 microseconds per read attempt.
.El
.Sh SEE ALSO