~ubuntu-branches/ubuntu/saucy/nut/saucy

« back to all changes in this revision

Viewing changes to man/bestups.8

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler
  • Date: 2005-07-20 19:48:50 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20050720194850-oo61wjr33rrx2mre
Tags: upstream-2.0.2
ImportĀ upstreamĀ versionĀ 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH BESTUPS 8 "Tue Jul 30 2002" "" "Network UPS Tools (NUT)" 
 
1
.TH BESTUPS 8 "Wed Jul 28 2004" "" "Network UPS Tools (NUT)" 
2
2
.SH NAME  
3
3
bestups \- Driver for Best Power / SOLA (Phoenixtec protocol) UPS equipment
4
4
.SH NOTE
5
 
This man page only documents the hardware-specific features of the
 
5
This man page only documents the hardware\(hyspecific features of the
6
6
bestups driver.  For information about the core driver, see  
7
7
\fBnutupsdrv\fR(8).
8
8
 
9
9
.SH SUPPORTED HARDWARE
10
10
bestups was designed to monitor Best Power UPS hardware like the Fortress,
11
 
Fortress Telecom, and Patriot Pro.  It also recognizes and supports SOLA
12
 
units such as the 520 and 620.  
 
11
Fortress Telecom, Axxium Rackmount and Patriot Pro.  It also recognizes
 
12
and supports SOLA units such as the 325, 520 and 620.  In addition, the 
 
13
Best 610 is supported using the `ID' option.
13
14
 
14
15
Other UPS hardware using the Phoenixtec protocol should also work, but
15
16
they will generate a warning since their battery information is not known.
16
17
 
17
 
This driver does not support some older Best/SOLA units.  Try the bestfort
18
 
driver if this one does not detect your UPS.
 
18
This driver does not support some older Best/SOLA units.
19
19
 
20
20
.SH EXTRA ARGUMENTS
21
21
 
22
 
This driver does not support any extra settings in the    
23
 
\fBups.conf\fR(5).
 
22
This driver supports the following optional settings in the
 
23
\fBups.conf\fR(5):
 
24
 
 
25
.IP "nombattvolt=\fInum\fR"
 
26
 
 
27
Override the nominal battery voltage which is normally determined by
 
28
asking the hardware.  This is useful if your UPS constantly reports
 
29
battery.charge values just below 100% even when it's completely charged.
 
30
 
 
31
If you have this problem, set this to whatever battery.voltage reports
 
32
when the UPS is known to be completely charged with a good battery.
 
33
 
 
34
The author's Best Fortress 750 uses nombattvolt=27.4.
 
35
 
 
36
.IP "ID=\fIstring\fR"
 
37
 
 
38
Set the Identification response string.  This should only be used
 
39
with hardware that supports the Phoenixtec protocol status inquiry 
 
40
commands, but not the "ID" command, such as the Best/SOLA 610.  Format 
 
41
of the ID string is: AAA,BBBB,CCC,DDD,EE.E,FF.F
 
42
 
 
43
AAA is the three-character identification for the UPS model.
 
44
 
 
45
BBBB is the output power in VA (volt amperes). B is an integer number 
 
46
ranging from 0 to 9.
 
47
 
 
48
CCC is the Nominal Input Voltage. C is an integer number ranging from 0 
 
49
to 9. The unit is Volts AC.
 
50
 
 
51
DDD is the Nominal Output Voltage. D is an integer number ranging from 0 
 
52
to 9. The unit is Volts AC.
 
53
 
 
54
EE.E is the Battery Voltage that will cause the UPS to shut itself off. 
 
55
E is an integer number ranging from 0 to 9. Then unit is Volts DC and a 
 
56
decimal point is present.
 
57
 
 
58
FF.F or FFF.F is the Battery Voltage at full charge. F is an integer 
 
59
number ranging from 0 to 9. Then unit is Volts DC. Typically, for 700VA, 
 
60
1KVA and 1.5KVA units, the format is FF.F. For 2KVA and 3KVA units, the 
 
61
format is FFF.F.
 
62
 
 
63
Example: a Best 610 1.5KVA unit would use the string 
 
64
"610,1500,120,120,10.0,48.0".
24
65
 
25
66
.SH BUGS
26
67
 
27
 
The battery percentage is derived from the voltage data that the UPS
28
 
returns, since the UPS doesn't return that value directly.  On some
29
 
hardware, the charge will remain at 100% for a long time and then drops
30
 
quickly shortly before the battery runs out.  You can confirm from the
31
 
BATTVOLT readings that this is a problem with the UPS and not this driver.
 
68
The battery charge percentage value (in battery.charge) is derived from
 
69
the voltage data that the UPS returns, since the UPS doesn't return that
 
70
value directly.  On some hardware, the charge will remain at 100% for a
 
71
long time and then drops quickly shortly before the battery runs out.
 
72
You can confirm from the battery.voltage readings that this is a problem
 
73
with the UPS and not this driver. 
32
74
 
33
75
Similarly, the float from the charger in some models forces the battery
34
76
charge percentage back up to 100% immedately after the UPS goes back
35
 
on-line, so you can't tell when it is really recharged.
 
77
on\(hyline, so you can't tell when it is really recharged.
36
78
 
37
79
Finally, some models give one value for the battery's nominal voltage and
38
80
yet actually have a nominal voltage slightly below that.  This leads to
39
81
things such as the perpetual 98.7% charge on the author's Fortress 750,
40
 
even when it's been charging for weeks.
 
82
even when it's been charging for weeks.  You can use nombattvolt= in 
 
83
\fBups.conf\fR(8) to fix this.
41
84
 
42
85
.SH AUTHOR
43
 
Russell Kroll
 
86
Russell Kroll, Jason White
44
87
 
45
88
.SH SEE ALSO
46
89