docs/man/bestups.txt

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