summaryrefslogtreecommitdiff
path: root/static/netbsd/man4/am2315temp.4 4.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/netbsd/man4/am2315temp.4 4.html')
-rw-r--r--static/netbsd/man4/am2315temp.4 4.html87
1 files changed, 87 insertions, 0 deletions
diff --git a/static/netbsd/man4/am2315temp.4 4.html b/static/netbsd/man4/am2315temp.4 4.html
new file mode 100644
index 00000000..21e2e0d6
--- /dev/null
+++ b/static/netbsd/man4/am2315temp.4 4.html
@@ -0,0 +1,87 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">AM2315TEMP(4)</td>
+ <td class="head-vol">Device Drivers Manual</td>
+ <td class="head-rtitle">AM2315TEMP(4)</td>
+ </tr>
+</table>
+<div class="manual-text">
+<section class="Sh">
+<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
+<p class="Pp"><code class="Nm">am2315temp</code> &#x2014;
+ <span class="Nd">Driver for Aosong AM2315 sensor chip via I2C bus</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
+<p class="Pp"><code class="Cd">am2315temp* at iic? addr 0x5c</code></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
+<p class="Pp">The <code class="Nm">am2315temp</code> driver provides
+ measurements from the AM2315 humidity/temperature sensors via the
+ <a class="Xr">envsys(4)</a> framework. The
+ <code class="Nm">am2315temp</code> <var class="Ar">addr</var> argument
+ selects the address at the <a class="Xr">iic(4)</a> 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
+ <a class="Xr">sysctl(8)</a> nodes.</p>
+<p class="Pp">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 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 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 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.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL
+ VARIABLES</a></h1>
+<p class="Pp">The following <a class="Xr">sysctl(3)</a> variables are
+ provided:</p>
+<dl class="Bl-tag">
+ <dt>hw.am2315temp0.readcount</dt>
+ <dd>The number of times to take a reading before considering it valid. This
+ defaults to 2.</dd>
+ <dt>hw.am2315temp0.readticks</dt>
+ <dd>The number of ticks to wait in between readings. The default is 100.</dd>
+ <dt>hw.am2315temp0.debug</dt>
+ <dd>If the driver is compiled with <code class="Dv">AM2315_DEBUG</code>, this
+ node will appear and can be used to set the debugging level.</dd>
+</dl>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
+ ALSO</a></h1>
+<p class="Pp"><a class="Xr">envsys(4)</a>, <a class="Xr">iic(4)</a>,
+ <a class="Xr">envstat(8)</a>, <a class="Xr">sysctl(8)</a></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
+<p class="Pp">The <code class="Nm">am2315temp</code> driver first appeared in
+ <span class="Ux">NetBSD 8.0</span>.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
+<p class="Pp">The <code class="Nm">am2315temp</code> driver was written by
+ <span class="An">Brad Spencer</span>
+ &lt;<a class="Mt" href="mailto:brad@anduin.eldar.org">brad@anduin.eldar.org</a>&gt;.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
+<p class="Pp">The device does not appear to work with the
+ <a class="Xr">gpioiic(4)</a> bitbang controller. When tried, reads would not
+ error, but no data was returned.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">December 28, 2017</td>
+ <td class="foot-os">NetBSD 10.1</td>
+ </tr>
+</table>