nut/docs/man/nutdrv_atcl_usb.8

73 lines
3.7 KiB
Groff
Raw Permalink Normal View History

2014-04-22 18:39:47 +00:00
'\" t
.\" Title: nutdrv_atcl_usb
.\" Author: [see the "AUTHORS" section]
2015-04-30 13:53:36 +00:00
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
2016-07-18 00:11:41 +00:00
.\" Date: 03/09/2016
2014-04-22 18:39:47 +00:00
.\" Manual: NUT Manual
2016-07-18 00:11:41 +00:00
.\" Source: Network UPS Tools 2.7.3.1
2014-04-22 18:39:47 +00:00
.\" Language: English
.\"
2016-07-18 00:11:41 +00:00
.TH "NUTDRV_ATCL_USB" "8" "03/09/2016" "Network UPS Tools 2\&.7\&.3\&." "NUT Manual"
2014-04-22 18:39:47 +00:00
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nutdrv_atcl_usb \- Driver for \*(AqATCL FOR UPS\*(Aq equipment
.SH "NOTE"
.sp
This man page only documents the specific features of the nutdrv_atcl_usb driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
2016-07-18 00:11:41 +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 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 appears to emulate a traditional contact\-closure interface\&. This translates into only three states in ups\&.status: \fBOL\fR, \fBOB\fR and \fBOB LB\fR (similar to \fBgenericups\fR(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 \fBnutdrv_qx\fR(8)\&.
2014-04-22 18:39:47 +00:00
.SH "EXTRA ARGUMENTS"
.sp
This driver supports the following optional setting:
.PP
\fBvendor\fR=\fIname\fR
.RS 4
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
\fBnutdrv_qx\fR(8)\&.
.RE
.SH "BUGS"
.sp
The UPS returns the same code for "load power is off" as for "on line power"\&. This condition will not be observed if the NUT master is powered by the UPS, but may be an issue if the UPS is monitored by a remote system\&.
.sp
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)\&.
.sp
Most contact\-closure UPSes will not power down the load if the line power is present\&. This can create a race when using slave \fBupsmon\fR(8) systems\&. See the \fBupsmon\fR(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\&.
.SH "AUTHORS"
.sp
Charles Lepple
.SH "SEE ALSO"
.SS "The core driver:"
.sp
\fBnutupsdrv\fR(8)
.SS "The generic serial driver:"
.sp
\fBgenericups\fR(8)
.SS "The Qx driver:"
.sp
2016-07-18 00:11:41 +00:00
\fBnutdrv_qx\fR(8) (fuji subdriver)
2014-04-22 18:39:47 +00:00
.SS "Internet resources:"
.sp
The NUT (Network UPS Tools) home page: http://www\&.networkupstools\&.org/