man/mge-shut.8

   1 .TH mge\-shut 8 "Thu Jul 27 2006" "" "Network UPS Tools (NUT)"
   2 .SH NAME
   3 mge\(hyshut \- Driver for MGE UPS serial SHUT Protocol UPS equipment
   4 .SH NOTE
   5 This man page only documents the hardware\(hyspecific features of the
   6 mge\(hyshut driver.  For information about the core driver, see
   7 \fBnutupsdrv\fR(8).
   8
   9 .SH SUPPORTED HARDWARE
  10 mge\(hyshut support all recent MGE UPS models which use the SHUT (Serial HID
  11 UPS Transfer) protocol at 2400 bps. Supported models are:
  12
  13     Pulsar Ellipse S,
  14     Pulsar Ellipse USBS
  15     Pulsar Ellipse Premium S,
  16     Pulsar Ellipse Premium USBS
  17     Pulsar EXtreme C,
  18     Pulsar Esprit,
  19     Pulsar Evolution,
  20     NOVA AVR (Serial),
  21     Galaxy 3000 / PW (with RS232 HID COM ports card, ref 66066),
  22     Any recent MGE serial model...
  23
  24 Older models, such as Pulsar ESV+, Pulsar EX and Pulsar ES+, use the U\(hyTalk
  25 protocol and should use the mge\(hyutalk driver.
  26
  27 .SH EXTRA ARGUMENTS
  28 This driver supports the following optional settings in the
  29 \fBups.conf\fR(5):
  30
  31 .IP "lowbatt=\fInum\fR"
  32 Set the low battery warning threshold at which shutdown is initiated by
  33 \fBupsmon\fR(8).
  34 The factory default value is 30 (in percentage), and only be settable
  35 depending on the exact model.
  36
  37 .IP "offdelay=\fInum\fR"
  38 Set the timer before the UPS is turned off after the kill power command is
  39 sent (via the \fI\-k\fR switch).
  40 The default value is 20 (in seconds), and MUST BE LOWER than ondelay.
  41
  42 .IP "ondelay=\fInum\fR"
  43 Set the timer for the UPS to switch on in case the power returns after the
  44 kill power command had been sent but before the actual switch off. This
  45 ensures the machines connected to the UPS are, in all cases, rebooted after
  46 a power failure.
  47 The default value is 3 (in 10 seconds unit, which means 30 seconds),
  48 and MUST BE GREATER than offdelay.
  49
  50 IMPORTANT NOTE: some newer models express this value in seconds unit.
  51 If you experience trouble with the UPS not restarting, please refer to the below "KNOWN ISSUES".
  52
  53 .IP "notification=\fInum\fR"
  54 Set notification type to 1 (no), 2 (light) or 3 (yes).
  55 The default value is 3 (yes) because of some early Ellipse models which
  56 need it.
  57
  58 .SH KNOWN ISSUES
  59 .SS "Pulsar Ellipse S: Repetitive stale status \(hy Loss of communication"
  60
  61 Several users have reported "data stale" errors with Pulsar Ellipse
  62 equipment.  This lasts around 10 seconds and happens once every few hours.
  63 This is due to the fact that the SHUT protocol is verbose, and the driver
  64 sometimes does not handle all of it during the usual polling interval in
  65 upsd.  To solve this problem, change the value of MAXAGE to 25 in
  66 upsd.conf.  Also add "notification=3" in ups.conf (thanks to Julien
  67 Lesaint and Fabien).
  68
  69 .SS "The UPS doesn't restart after a power restoration"
  70
  71 The present mge-shut version lacks an exponent management.
  72 This can lead to the UPS not restarting after the power restoration.
  73 In such a case, try to express the ondelay in seconds (refer to the above ondelay description). A complete rewrite of this driver is underway for NUT 2.2, and will solve this issue.
  74
  75 .SH AUTHOR
  76 Arnaud Quette <aquette.dev@gmail.com>
  77
  78 Philippe Marzouk <philm@users.sourceforge.net>
  79
  80 .SH SEE ALSO
  81
  82 .SS The core driver:
  83 \fBnutupsdrv\fR(8)
  84
  85 .SS Internet resources:
  86 The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
  87
  88 MGE UPS SYSTEMS SHUT protocol information:
  89 http://random.networkupstools.org/protocols/mge/