tripplite_usb(8)

1TRIPPLITE_USB(8)                  NUT Manual                  TRIPPLITE_USB(8)
2
3
4

NAME

6       tripplite_usb - Driver for older Tripp Lite USB UPSes (not PDC HID)
7

SYNOPSIS

9       tripplite_usb -h
10
11       tripplite_usb -a UPS_NAME [OPTIONS]
12

SUPPORTED HARDWARE

14       This driver should work with older Tripp Lite UPSes which are detected
15       as USB HID-class devices, but are not true HID Power-Device Class
16       devices. So far, the devices supported by tripplite_usb have product ID
17       0001, and the newer units (such as those with "LCD" in the model name)
18       with product ID 2001 require the usbhid-ups(8) driver instead.
19
20       Please report success or failure to the nut-upsuser mailing list. A key
21       piece of information is the protocol number, returned in
22       ups.firmware.aux. Also, be sure to turn on debugging (-DDD) for more
23       informative log messages.
24
25       If your Tripp Lite UPS uses a serial port, you may wish to investigate
26       the tripplite(8) or tripplitesu(8) drivers.
27
28       This driver has been tested with the following models:
29
30       •   INTERNETOFFICE700
31
32       •   OMNIVS1000
33
34       •   OMNIVS1500XL (some warnings)
35
36       •   SMART700USB
37
38       •   SMART1500RM2U
39
40       •   SMART2200RMXL2U
41
42       •   SMART3000RM2U
43
44       If you have used Tripp Lite’s PowerAlert software to connect to your
45       UPS, there is a good chance that tripplite_usb will work if it uses one
46       of the following protocols:
47
48       •   Protocol 0004
49
50       •   Protocol 1001
51
52       •   Protocol 2001
53
54       •   Protocol 3003
55
56       •   Protocol 3005
57
58       On the other hand, if the web page for your UPS on the Tripp-Lite
59       website says "HID-compliant USB port also enables direct integration
60       with built-in power management and auto-shutdown features of Windows
61       and MAC OS X", then you should use the usbhid-ups(8) driver instead.
62

EXTRA ARGUMENTS

64       This driver supports the following optional settings in the ups.conf(5)
65       file (or with -x on the command line):
66
67       offdelay
68           This setting controls the delay between receiving the "kill"
69           command (-k) and actually cutting power to the computer.
70
71       battery_min, battery_max
72           These floating-point values correspond to the "empty" (10%) and
73           "full" (100%) voltages of the battery. They are used for an
74           approximation of the battery state-of-charge. The calculated
75           battery.charge value will be clamped to the range of 10% through
76           100%, so the resting voltage of the charged battery can be used for
77           battery_max, and the higher float charge voltage should not cause
78           problems.
79
80       bus
81           This regular expression is used to match the USB bus (as seen in
82           /proc/bus/usb/devices or lsusb(8); including leading zeroes).
83
84       device
85           This regular expression is used to match the USB device (as seen in
86           /proc/bus/usb/devices or lsusb(8); including leading zeroes). Note
87           that device numbers are not guaranteed by the OS to be stable
88           across re-boots or device re-plugging.
89
90       product
91           A regular expression to match the product string for the UPS. This
92           would be useful if you have two different Tripp Lite UPS models
93           connected to the system, and you want to be sure that you shut them
94           down in the correct order.
95
96           Note
97           This regex is matched against the full USB product string as seen
98           in lsusb(8). The ups.model in the upsc(1) output only lists the
99           name after TRIPP LITE, so to match a SMART2200RMXL2U, you could use
100           the regex .*SMART2200.*.
101
102       productid
103           The productid is a regular expression which matches the UPS PID as
104           four hexadecimal digits. So far, the only devices that work with
105           this driver have PID 0001.
106
107       serial
108           It does not appear that these particular Tripp Lite UPSes use the
109           iSerial descriptor field to return a serial number. However, in
110           case your unit does, you may specify it here.
111
112       For more information on regular expressions, see regex(7)
113

RUNTIME VARIABLES

115       ups.delay.shutdown
116           This variable is the same as the offdelay setting, but it can be
117           changed at runtime by upsrw(8).
118
119       ups.id
120           Some SMARTPRO models feature an ID that can be set and retrieved.
121           If your UPS supports this feature, this variable will be listed in
122           the output of upsrw(8).
123
124       outlet.1.switch
125           Some Tripp Lite units have a switchable outlet (usually outlet #1)
126           which can be turned on and off by writing 1 or 0, respectively, to
127           outlet.1.switch with upsrw(8). If your unit has multiple switchable
128           outlets, substitute the outlet number for 1 in the variable name.
129           Be sure to test this first - there is no other way to be certain
130           that the number used by the driver matches the label on the unit.
131

KNOWN ISSUES AND BUGS

133       The driver was not developed with any official documentation from Tripp
134       Lite, so certain events may confuse the driver. If you observe any
135       strange behavior, please re-run the driver with -DDD to increase the
136       verbosity.
137
138       So far, the Tripp Lite UPSes do not seem to have a serial number or
139       other globally unique identifier accessible through USB. Thus, when
140       monitoring several Tripp Lite USB UPSes, you should use either the bus,
141       device or product configuration options to uniquely specify which UPS a
142       given driver instance should control.
143
144       For instance, you can easily monitor an OMNIVS1000 and a SMART1500RM2U
145       at the same time, since they have different USB Product ID strings. If
146       you have two SMART1500RM2U units, you would have to find which USB bus
147       and device number each unit is on (via lsusb(8)).
148
149       Some of the SMART*2U models have an ID number, but because this ID is
150       not exposed as a USB string descriptor, there is no easy way to use
151       this ID to distinguish between multiple UPS units on a single machine.
152       The UPS would need to be claimed by the driver in order to read this
153       ID.
154

AUTHORS

156       Written by Charles Lepple, based on the tripplite(8) driver by Rickard
157       E. (Rik) Faith and Nicholas Kain.
158
159       Please do not email the authors directly - use the nut-upsdev mailing
160       list.
161
162       A Tripp Lite OMNIVS1000 was graciously donated to the NUT project by
163       Bradley Feldman (http://www.bradleyloritheo.com)
164