nut/docs/man/oneac.txt

126 lines
3 KiB
Text
Raw Permalink Normal View History

2011-01-26 09:35:08 +00:00
ONEAC(8)
========
NAME
----
oneac - Driver for Oneac UPS equipment
NOTE
----
This man page only documents the hardware-specific features of the
2010-03-25 23:20:59 +00:00
oneac driver. For information about the core driver, see
2011-01-26 09:35:08 +00:00
linkman:nutupsdrv[8].
2010-03-25 23:20:59 +00:00
2011-01-26 09:35:08 +00:00
SUPPORTED HARDWARE
------------------
2012-06-01 13:55:19 +00:00
This driver supports various Oneac UPS families:
- EG (late 80s, early 90s, plug-in serial interface card)
- ON (early and mid-90s, plug-in serial interface card)
- OZ (mid-90s on, DB-25 std., interface slot)
- OB (early 2000's on, big cabinet, DB-25 std., interface slot)
If your UPS is equipped with the Basic Interface card, use the
linkman:genericups[8] driver.
2010-03-25 23:20:59 +00:00
2011-01-26 09:35:08 +00:00
EXTRA ARGUMENTS
---------------
2010-03-25 23:20:59 +00:00
This driver supports the following optional settings in the
2011-01-26 09:35:08 +00:00
linkman:ups.conf[5] file:
2010-03-25 23:20:59 +00:00
2011-01-26 09:35:08 +00:00
*testtime*='num'::
2010-03-25 23:20:59 +00:00
Change battery test time from the 2 minute default.
2012-06-01 13:55:19 +00:00
*offdelay*='num'::
Change shutdown delay time from 0 second default.
2011-01-26 09:35:08 +00:00
INSTANT COMMANDS
----------------
2010-03-25 23:20:59 +00:00
This driver supports the following Instant Commands.
2012-06-01 13:55:19 +00:00
(See linkman:upscmd[8])
2010-03-25 23:20:59 +00:00
2012-06-01 13:55:19 +00:00
All UPS units
~~~~~~~~~~~~~
2010-03-25 23:20:59 +00:00
2012-06-01 13:55:19 +00:00
*shutdown.return*::
Turn off the load possibly after a delay and return when power is back.
2010-03-25 23:20:59 +00:00
2012-06-01 13:55:19 +00:00
*shutdown.stop*::
Stop a shutdown in progress.
*shutdown.reboot*::
Shut down the load briefly while rebooting the UPS.
2010-03-25 23:20:59 +00:00
2011-01-26 09:35:08 +00:00
*test.failure.start*::
2010-03-25 23:20:59 +00:00
Starts a 15 second long simulation of an input power
failure.
2012-06-01 13:55:19 +00:00
*test.battery.start.quick*::
Start a "quick" battery test. The default time is 2 minutes. This
time can be set in the *ups.conf* file. See *testime* above.
*test.battery.stop*::
Stops a battery test that is in progress.
All ON UPS units
~~~~~~~~~~~~~~~~
*reset.input.minmax*::
Reset the minimum and maximum input line voltage values
seen since the last reset or power on.
Newer ON UPS units
~~~~~~~~~~~~~~~~~~
*test.panel.start*::
Start testing the UPS panel.
*test.battery.start.deep*::
Start a "deep" battery test. This test runs the UPS until the low
battery point and then returns to the AC line.
*reset.input.minmax*::
Reset the minimum and maximum input line voltage values
seen since the last reset or power on.
*beeper.enable*::
Enable UPS beeper/buzzer.
*beeper.disable*::
Disable UPS beeper/buzzer.
*beeper.mute*::
Mutes the UPS beeper/buzzer for the current alarm condition(s).
Writable Variables
------------------
See linkman:upsrw[8] to see what variables are writable for the UPS.
NOTE: If your UPS supports writing battery.runtime.low, the new set value
is to be entered in minutes (up to 99) but the reported value is reported
in seconds (set value * 60).
NOTE: If your UPS supports input.transfer.low and input.transfer.high,
those values are used to create an allowable output range. The UPS
will do what it can to keep the output voltage value within the
defined range (for example: tap change or switch to inverter).
2011-01-26 09:35:08 +00:00
AUTHOR
------
2012-06-01 13:55:19 +00:00
Bill Elliot <bill@wreassoc.com>,
2010-03-25 23:20:59 +00:00
Eric Lawson <elawson@inficad.com>
2011-01-26 09:35:08 +00:00
SEE ALSO
--------
2010-03-25 23:20:59 +00:00
2011-01-26 09:35:08 +00:00
The core driver:
~~~~~~~~~~~~~~~~
linkman:nutupsdrv[8]
2010-03-25 23:20:59 +00:00
2011-01-26 09:35:08 +00:00
Internet resources:
~~~~~~~~~~~~~~~~~~~
2010-03-25 23:20:59 +00:00
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/