diff options
Diffstat (limited to 'static/freebsd/man4/gpioths.4 3.html')
| -rw-r--r-- | static/freebsd/man4/gpioths.4 3.html | 143 |
1 files changed, 0 insertions, 143 deletions
diff --git a/static/freebsd/man4/gpioths.4 3.html b/static/freebsd/man4/gpioths.4 3.html deleted file mode 100644 index 26442c77..00000000 --- a/static/freebsd/man4/gpioths.4 3.html +++ /dev/null @@ -1,143 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">GPIOTHS(4)</td> - <td class="head-vol">Device Drivers Manual</td> - <td class="head-rtitle">GPIOTHS(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">gpioths</code> — <span class="Nd">driver - for DHTxx and AM320x temperature and humidity sensors</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp">To compile this driver into the kernel, place the following line - in your kernel configuration file:</p> -<div class="Bd Pp Bd-indent"><code class="Cd">device gpioths</code></div> -<p class="Pp">Alternatively, to load the driver as a module at boot time, place - the following line in <a class="Xr">loader.conf(5)</a>:</p> -<div class="Bd Pp Bd-indent Li"> -<pre>gpioths_load="YES"</pre> -</div> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">The <code class="Nm">gpioths</code> driver supports the DHTxx and - AM320x family of temperature and humidity sensors. The driver automatically - reads the values from the sensor once every 5 seconds, and makes the results - available via <a class="Xr">sysctl(8)</a> variables.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1> -<p class="Pp">The <code class="Nm">gpioths</code> driver provides support for - the following devices:</p> -<p class="Pp"></p> -<table class="Bl-column Bd-indent Bl-compact"> - <tr> - <td>DHT11</td> - <td>DHT12</td> - </tr> - <tr> - <td>DHT21</td> - <td>DHT22</td> - </tr> - <tr> - <td>AM3201</td> - <td>AM3202</td> - </tr> -</table> -<p class="Pp">The supported devices are all similar to each other, varying - primarily in accuracy and resolution. The devices require a single wire for - data communications, using a custom protocol which is not compatible with - Maxim's 1-wire(tm). The AM320x devices also support connection to an i2c - bus, but this driver supports only the single-wire connection option.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL - VARIABLES</a></h1> -<p class="Pp">Sysctl variables are used to access the most recent temperature - and humidity measurements.</p> -<dl class="Bl-tag"> - <dt id="dev.gpioths._unit_.temperature"><var class="Va">dev.gpioths.<unit>.temperature</var></dt> - <dd>The current temperature in integer deciKelvins. Note that - <a class="Xr">sysctl(8)</a> will convert those units to display in decimal - degrees Celsius.</dd> - <dt id="dev.gpioths._unit_.humidity"><var class="Va">dev.gpioths.<unit>.humidity</var></dt> - <dd>The current relative humidity, as an integer percentage.</dd> - <dt id="dev.gpioths._unit_.fails"><var class="Va">dev.gpioths.<unit>.fails</var></dt> - <dd>The number of failed attempts to communicate with the sensor since the - last good access. Cleared whenever a set of measurements is successfully - retrieved.</dd> -</dl> -</section> -<section class="Sh"> -<h1 class="Sh" id="FDT_CONFIGURATION"><a class="permalink" href="#FDT_CONFIGURATION">FDT - CONFIGURATION</a></h1> -<p class="Pp">On an <a class="Xr">fdt(4)</a> based system, a - <code class="Nm">gpioths</code> device node is typically defined directly - under the root node, or under a simplebus node that represents a collection - of devices on a board.</p> -<p class="Pp">The following properties are required in the - <code class="Nm">gpioths</code> device subnode:</p> -<dl class="Bl-tag"> - <dt id="compatible"><var class="Va">compatible</var></dt> - <dd>Must be "dht11".</dd> - <dt id="gpios"><var class="Va">gpios</var></dt> - <dd>A reference to the gpio device and pin for data communications.</dd> -</dl> -<section class="Ss"> -<h2 class="Ss" id="Example_of_adding_a_sensor_with_an_overlay"><a class="permalink" href="#Example_of_adding_a_sensor_with_an_overlay">Example - of adding a sensor with an overlay</a></h2> -<div class="Bd Bd-indent"> -<pre>/dts-v1/; -/plugin/; -#include <dt-bindings/gpio/gpio.h> - -/ { - compatible = "wand,imx6q-wandboard"; -}; - -&{/} { - dht0 { - compatible = "dht11"; - gpios = <&gpio5 15 GPIO_ACTIVE_HIGH>; - }; -};</pre> -</div> -</section> -</section> -<section class="Sh"> -<h1 class="Sh" id="HINTS_CONFIGURATION"><a class="permalink" href="#HINTS_CONFIGURATION">HINTS - CONFIGURATION</a></h1> -<p class="Pp">On a <a class="Xr">device.hints(5)</a> based system, such as - <code class="Li">MIPS</code>, these values are configurable for - <code class="Nm">gpioths</code>:</p> -<dl class="Bl-tag"> - <dt id="hint.gpioths._unit_.at"><var class="Va">hint.gpioths.<unit>.at</var></dt> - <dd>The <a class="Xr">gpiobus(4)</a> instance the - <code class="Nm">gpioths</code> instance is attached to.</dd> - <dt id="hint.gpioths.pins"><var class="Va">hint.gpioths.pins</var></dt> - <dd>A bitmask with a single bit set to indicate which gpio pin on the - <a class="Xr">gpiobus(4)</a> to use for data communications.</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">fdt(4)</a>, <a class="Xr">gpiobus(4)</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">gpioths</code> driver first appeared in - <span class="Ux">FreeBSD 11.1</span>.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">December 8, 2019</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |