diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:55:15 -0400 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:55:15 -0400 |
| commit | 253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch) | |
| tree | adf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man4/swsensor.4 4.html | |
| parent | a9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff) | |
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man4/swsensor.4 4.html')
| -rw-r--r-- | static/netbsd/man4/swsensor.4 4.html | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/static/netbsd/man4/swsensor.4 4.html b/static/netbsd/man4/swsensor.4 4.html new file mode 100644 index 00000000..1236c223 --- /dev/null +++ b/static/netbsd/man4/swsensor.4 4.html @@ -0,0 +1,137 @@ +<table class="head"> + <tr> + <td class="head-ltitle">SWSENSOR(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">SWSENSOR(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">swsensor</code> — + <span class="Nd">software environmental sensor</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">pseudo-device swsensor</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">swsensor</code> driver provides a software + environmental sensor that works with <a class="Xr">sysctl(8)</a> and + <a class="Xr">envstat(8)</a>. The driver is intended to be loaded as a + kernel module. One can, however, include the + <code class="Nm">swsensor</code> driver directly in a kernel using the + configuration from the synopsis. By default, the sensor is of type + <code class="Dv">ENVSYS_UNITS_INTEGER</code>.</p> +<p class="Pp">The following values can be specified in the + <a class="Xr">modload(8)</a> command when loading the + <code class="Nm">swsensor</code> module to alter the driver's behavior.</p> +<dl class="Bl-tag"> + <dt id="Variable"><a class="permalink" href="#Variable"><b class="Sy">Variable</b></a> + <a class="permalink" href="#Usage"><b class="Sy" id="Usage">Usage</b></a></dt> + <dd style="width: auto;"> </dd> + <dt id="mode"><a class="permalink" href="#mode"><code class="Li">mode</code></a></dt> + <dd>Controls whether or not <code class="Nm">swsensor</code> provides + internally-maintained limits and limit checking + <dl class="Bl-tag"> + <dt id="Value"><a class="permalink" href="#Value"><b class="Sy">Value</b></a> + <a class="permalink" href="#Meaning"><b class="Sy" id="Meaning">Meaning</b></a></dt> + <dd style="width: auto;"> </dd> + <dt id="0"><a class="permalink" href="#0"><code class="Li">0</code></a></dt> + <dd>sensor has no internally-maintained limits</dd> + <dt id="1"><a class="permalink" href="#1"><code class="Li">1</code></a></dt> + <dd>sensor provides its own internal limit value</dd> + <dt id="2"><a class="permalink" href="#2"><code class="Li">2</code></a></dt> + <dd>sensor maintains an internal adjustable limit and performs its own + comparison between the sensor's limit and its current value</dd> + </dl> + </dd> + <dt id="limit"><a class="permalink" href="#limit"><code class="Li">limit</code></a></dt> + <dd>The initial alarm limit value, if limit emulation is selected (i.e., if + <code class="Dv">mode</code> is set to 1 or 2)</dd> + <dt id="value_max"><a class="permalink" href="#value_max"><code class="Li">value_max</code></a></dt> + <dd style="width: auto;"> </dd> + <dt id="value_min"><a class="permalink" href="#value_min"><code class="Li">value_min</code></a></dt> + <dd>The maximum and minimum values. The corresponding + <code class="Dv">ENVSYS_FVALID_MAX</code> and + <code class="Dv">ENVSYS_FVALID_MIN</code> flags are implicitly set.</dd> + <dt id="percentage"><a class="permalink" href="#percentage"><code class="Li">percentage</code></a></dt> + <dd>This boolean value controls the setting of the + <code class="Dv">ENVSYS_FPERCENT</code> flag.</dd> + <dt id="type"><a class="permalink" href="#type"><code class="Li">type</code></a></dt> + <dd>Define the sensor's unit/type. By default, a Temperature sensor is + created. Any of the string values from the following table can be + specified: + <table class="Bl-column"> + <tr> + <td>Temperature</td> + <td>Fan</td> + <td>Voltage AC</td> + </tr> + <tr> + <td>Voltage DC</td> + <td>Ohms</td> + <td>Watts</td> + </tr> + <tr> + <td>Ampere</td> + <td>Watt hour</td> + <td>Ampere hour</td> + </tr> + <tr> + <td>Indicator</td> + <td>Integer</td> + <td>Drive</td> + </tr> + <tr> + <td>Battery capacity</td> + <td>Battery charge</td> + <td></td> + </tr> + </table> + (Values are case-sensitive, and spaces must be included.)</dd> + <dt id="value"><a class="permalink" href="#value"><code class="Li">value</code></a></dt> + <dd>Provide an initial value for the sensor. If this is omitted, the sensor's + initial value is set to zero.</dd> +</dl> +<p class="Pp">For example,</p> +<div class="Bd Bd-indent"><code class="Li"><code class="Ic">modload -s + type=Voltage\ DC swsensor</code></code></div> +will create a sensor of type <code class="Dv">ENVSYS_UNITS_SVOLTS_DC</code>, + while +<div class="Bd Bd-indent"><code class="Li"><code class="Ic">modload -i mode=1 -i + limit=50 swsensor</code></code></div> +will create a sensor which has an initial, device-provided limit of 50. +<p class="Pp">The sensor's raw value and state can be manually updated by + modifying the <a class="Xr">sysctl(8)</a> variables + “hw.swsensor.cur_value” and “hw.swsensor.state” + variables respectively.</p> +</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">modctl(2)</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">swsensor</code> driver was written by + <span class="An">Paul Goyette</span> and first appeared in + <span class="Ux">NetBSD 6.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1> +<p class="Pp">The <code class="Nm">swsensor</code> driver emulates a device with + only a single sensor.</p> +<p class="Pp">The <code class="Nm">swsensor</code> driver can only emulate one + hardware-managed limit; this is assumed to be the + <code class="Dv">critical-min</code> limit.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">June 1, 2016</td> + <td class="foot-os">NetBSD 10.1</td> + </tr> +</table> |
