nut/docs/man/nutdrv_atcl_usb.txt

89 lines
2.5 KiB
Text
Raw Normal View History

2014-04-22 18:39:47 +00:00
NUTDRV_ATCL_USB(8)
==================
NAME
----
2022-06-29 10:37:36 +00:00
2014-04-22 18:39:47 +00:00
nutdrv_atcl_usb - Driver for 'ATCL FOR UPS' equipment
NOTE
----
2022-06-29 10:37:36 +00:00
This man page only documents the specific features of the nutdrv_atcl_usb
2014-04-22 18:39:47 +00:00
driver. For information about the core driver, see linkman:nutupsdrv[8].
SUPPORTED HARDWARE
------------------
2022-06-29 10:37:36 +00:00
2014-04-22 18:39:47 +00:00
This driver is for UPS hardware which identifies itself as USB idVendor 0001
and idProduct 0000, and iManufacturer +ATCL FOR UPS+. Known manufacturers
2022-06-29 10:37:36 +00:00
include Kanji and Plexus.
The UPS interface seems to be a generic USB-to-serial chip, and for
hardware manufactured by Kanji and Plexus, the microcontroller
2016-07-18 00:11:41 +00:00
appears to emulate a traditional contact-closure interface. This translates
into only three states in ups.status: *OL*, *OB* and *OB LB* (similar to
2022-06-29 10:37:36 +00:00
linkman:genericups[8]), with no other dynamic status values reported.
Note that these USB identifiers (including the iManufacturer string)
have also been seen on devices that are supported by the `fuji`
subdriver of linkman:nutdrv_qx[8].
2014-04-22 18:39:47 +00:00
EXTRA ARGUMENTS
---------------
This driver supports the following optional setting:
*vendor*='name'::
In case your iManufacturer (Vendor) string does not exactly match
+ATCL FOR UPS+, you may provide an alternate string here. Note that a more
likely case is that your device is handled by another driver for +0001:0000+
devices, such as linkman:nutdrv_qx[8].
BUGS
----
2022-06-29 10:37:36 +00:00
2014-04-22 18:39:47 +00:00
The UPS returns the same code for "load power is off" as for "on line power".
2022-06-29 10:37:36 +00:00
This condition will not be observed if the NUT `upsmon` in primary mode runs
on the box powered by the UPS, but may be an issue if the UPS is monitored
by a remote (secondary) system.
2014-04-22 18:39:47 +00:00
The time between the shutdown command and removal of power seems to be fixed at
30 seconds. Ensure that the NUT shutdown script is invoked as late as possible
in the shutdown procedure (in case some services take longer than others to
clean up).
2022-06-29 10:37:36 +00:00
Most contact-closure UPSes will not power down the load if the line power is
present. This can create a race when using secondary linkman:upsmon[8]
systems. See the linkman:upsmon[8] man page for more information.
The solution to this problem is to upgrade to a smart protocol UPS of some
kind that allows detection and proper load cycling on command.
AUTHOR
------
2014-04-22 18:39:47 +00:00
Charles Lepple
SEE ALSO
--------
The core driver:
~~~~~~~~~~~~~~~~
2022-06-29 10:37:36 +00:00
2014-04-22 18:39:47 +00:00
linkman:nutupsdrv[8]
The generic serial driver:
~~~~~~~~~~~~~~~~~~~~~~~~~~
2022-06-29 10:37:36 +00:00
2014-04-22 18:39:47 +00:00
linkman:genericups[8]
The Qx driver:
~~~~~~~~~~~~~~
2022-06-29 10:37:36 +00:00
2016-07-18 00:11:41 +00:00
linkman:nutdrv_qx[8] (`fuji` subdriver)
2014-04-22 18:39:47 +00:00
Internet resources:
~~~~~~~~~~~~~~~~~~~
2022-06-29 10:37:36 +00:00
2014-04-22 18:39:47 +00:00
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/