272 lines
9.9 KiB
Groff
272 lines
9.9 KiB
Groff
.\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sh \" Subsection heading
|
|
.br
|
|
.if t .Sp
|
|
.ne 5
|
|
.PP
|
|
\fB\\$1\fR
|
|
.PP
|
|
..
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.if \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "TRIPPLITE_USB 8"
|
|
.TH TRIPPLITE_USB 8 "2009-05-04" "$Rev: 1836$" "Network UPS Tools (NUT)"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
tripplite_usb \- Driver for older Tripp Lite USB UPSes (not PDC HID)
|
|
.SH "NOTE"
|
|
.IX Header "NOTE"
|
|
This man page only documents the hardware-specific features of the
|
|
tripplite_usb driver. For information about the core driver, see
|
|
\&\fInutupsdrv\fR\|(8).
|
|
.SH "SUPPORTED HARDWARE"
|
|
.IX Header "SUPPORTED HARDWARE"
|
|
This driver should work with older Tripp Lite UPSes which are detected as \s-1USB\s0
|
|
HID-class devices, but are not true \s-1HID\s0 Power-Device Class devices. So far,
|
|
the devices supported by tripplite_usb have product \s-1ID\s0 0001, and the newer
|
|
units (such as those with \*(L"\s-1LCD\s0\*(R" in the model name) with product \s-1ID\s0 2001 require
|
|
the usbhid-ups driver instead. Please report success or failure to
|
|
the nut-upsuser mailing list. A key piece of information is the protocol
|
|
number, returned in ups.debug.0. Also, be sure to turn on debugging (\f(CW\*(C`\-DDD\*(C'\fR)
|
|
for more informative log messages. If your Tripp Lite \s-1UPS\s0 uses a serial port,
|
|
you may wish to investigate the \fItripplite\fR\|(8) or \fItripplite_su\fR\|(8) driver.
|
|
.PP
|
|
This driver has been tested with the following models:
|
|
.IP "\(bu" 4
|
|
\&\s-1INTERNETOFFICE700\s0
|
|
.IP "\(bu" 4
|
|
\&\s-1OMNISV1000\s0
|
|
.IP "\(bu" 4
|
|
\&\s-1OMNISV1500XL\s0 (some warnings)
|
|
.IP "\(bu" 4
|
|
\&\s-1SMART700USB\s0
|
|
.IP "\(bu" 4
|
|
\&\s-1SMART1500RM2U\s0
|
|
.IP "\(bu" 4
|
|
\&\s-1SMART2200RMXL2U\s0
|
|
.IP "\(bu" 4
|
|
\&\s-1SMART3000RM2U\s0
|
|
.PP
|
|
If you have used Tripp Lite's PowerAlert software to connect to your \s-1UPS\s0, there
|
|
is a good chance that \fItripplite_usb\fR\|(8) will work if it uses one of the
|
|
following protocols:
|
|
.IP "\(bu" 4
|
|
Protocol 0004
|
|
.IP "\(bu" 4
|
|
Protocol 1001
|
|
.IP "\(bu" 4
|
|
Protocol 2001
|
|
.IP "\(bu" 4
|
|
Protocol 3003
|
|
.SH "EXTRA ARGUMENTS"
|
|
.IX Header "EXTRA ARGUMENTS"
|
|
This driver supports the following optional setting in the \fIups.conf\fR\|(5) file
|
|
(or with \f(CW\*(C`\-x\*(C'\fR on the command line):
|
|
.IP "offdelay" 4
|
|
.IX Item "offdelay"
|
|
This setting controls the delay between receiving the \*(L"kill\*(R" command (\f(CW\*(C`\-k\*(C'\fR)
|
|
and actually cutting power to the computer.
|
|
.IP "bus" 4
|
|
.IX Item "bus"
|
|
This regular expression is used to match the \s-1USB\s0 bus (as seen in
|
|
\&\f(CW\*(C`/proc/bus/usb/devices\*(C'\fR or \fIlsusb\fR\|(8); including leading zeroes).
|
|
.IP "product" 4
|
|
.IX Item "product"
|
|
A regular expression to match the product string for the \s-1UPS\s0. This would be
|
|
useful if you have two different Tripp Lite \s-1UPS\s0 models connected to the
|
|
system, and you want to be sure that you shut them down in the correct order.
|
|
.Sp
|
|
Note that this regex is matched against the full \s-1USB\s0 product string as seen in
|
|
\&\fIlsusb\fR\|(8). The \f(CW\*(C`ups.model\*(C'\fR in the \f(CW\*(C`upsc\*(C'\fR output only lists the name after
|
|
\&\*(L"\s-1TRIPP\s0 \s-1LITE\s0\*(R", so to match a \s-1SMART2200RMXL2U\s0, you could use the regex
|
|
\&\*(L".*SMART2200.*\*(R".
|
|
.IP "productid" 4
|
|
.IX Item "productid"
|
|
The productid is a regular expression which matches the \s-1UPS\s0 \s-1PID\s0 as four
|
|
hexadecimal digits. So far, the only devices that work with this driver have
|
|
\&\s-1PID\s0 \f(CW0001\fR.
|
|
.IP "serial" 4
|
|
.IX Item "serial"
|
|
It does not appear that these particular Tripp Lite UPSes use the iSerial
|
|
descriptor field to return a serial number. However, in case your unit does,
|
|
you may specify it here.
|
|
.PP
|
|
For more information on regular expressions, see \fIregex\fR\|(7)
|
|
.SH "RUNTIME VARIABLES"
|
|
.IX Header "RUNTIME VARIABLES"
|
|
.IP "ups.delay.shutdown" 4
|
|
.IX Item "ups.delay.shutdown"
|
|
This variable is the same as the \f(CW\*(C`offdelay\*(C'\fR setting, but it can be changed at
|
|
runtime by \fIupsrw\fR\|(8).
|
|
.IP "ups.id" 4
|
|
.IX Item "ups.id"
|
|
Some \s-1SMARTPRO\s0 models feature an \s-1ID\s0 that can be set and retrieved. If your \s-1UPS\s0
|
|
supports this feature, this variable will be listed in the output of \fIupsrw\fR\|(8).
|
|
.IP "outlet.1.switch" 4
|
|
.IX Item "outlet.1.switch"
|
|
Some Tripp Lite units have a switchable outlet (usually outlet #1) which can be
|
|
turned on and off by writing \f(CW1\fR or \f(CW0\fR, respectively, to \f(CW\*(C`outlet.1.switch\*(C'\fR.
|
|
If your unit has multiple switchable outlets, substitute the outlet number for
|
|
\&\*(L"1\*(R" in the variable name. Be sure to test this first \- there is no other way to
|
|
be certain that the number used by the driver matches the label on the unit.
|
|
.SH "KNOWN ISSUES AND BUGS"
|
|
.IX Header "KNOWN ISSUES AND BUGS"
|
|
The driver was not developed with any official documentation from Tripp Lite,
|
|
so certain events may confuse the driver. If you observe any strange behavior,
|
|
please re-run the driver with \f(CW\*(C`\-DDD\*(C'\fR to increase the verbosity.
|
|
.PP
|
|
So far, the Tripp Lite UPSes do not seem to have any serial number or other
|
|
unique identifier accessible through \s-1USB\s0. Thus, when monitoring several Tripp
|
|
Lite \s-1USB\s0 UPSes, you should use either the \f(CW\*(C`bus\*(C'\fR or \f(CW\*(C`product\*(C'\fR configuration
|
|
options to uniquely specify which \s-1UPS\s0 a given driver instance should control.
|
|
.PP
|
|
For instance, you can easily monitor an \s-1OMNIVS1000\s0 and a \s-1SMART1500RM2U\s0 at the
|
|
same time, since they have different \s-1USB\s0 Product \s-1ID\s0 strings. If you have two
|
|
\&\s-1SMART1500RM2U\s0 units, you would have to find which \s-1USB\s0 bus number each unit is
|
|
on (via \f(CW\*(C`lsusb\*(C'\fR), which may result in ambiguities if the available \s-1USB\s0 ports
|
|
are on the same bus.
|
|
.PP
|
|
Some of the SMART*2U models have an \s-1ID\s0 number, but because this \s-1ID\s0 is not
|
|
exposed as a \s-1USB\s0 string descriptor, there is no easy way to use this \s-1ID\s0 to
|
|
distinguish between multiple \s-1UPS\s0 units on a single machine.
|
|
.SH "AUTHORS"
|
|
.IX Header "AUTHORS"
|
|
Charles Lepple <clepple+nut@gmail.com<gt>, based on the tripplite driver by
|
|
Rickard E. (Rik) Faith <faith@alephnull.com> and Nicholas Kain
|
|
<nicholas@kain.us>. Please do not email the authors directly \- use the
|
|
nut-upsdev mailing list.
|
|
.PP
|
|
A Tripp Lite \s-1OMNIVS1000\s0 was graciously donated to the \s-1NUT\s0 project by:
|
|
.Sp
|
|
.RS 4
|
|
Relevant Evidence, \s-1LLC\s0.
|
|
.Sp
|
|
http://www.relevantevidence.com
|
|
.Sp
|
|
Email: info@relevantevidence.com
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
.Sh "The core driver:"
|
|
.IX Subsection "The core driver:"
|
|
\&\fInutupsdrv\fR\|(8), \fIregex\fR\|(7), \fIusbhid\-ups\fR\|(8)
|
|
.Sh "Internet resources:"
|
|
.IX Subsection "Internet resources:"
|
|
The \s-1NUT\s0 (Network \s-1UPS\s0 Tools) home page: http://www.networkupstools.org/
|