IMPORTANT NOTICE

During the next period of time, the Thecus Wiki will migrate to a new site - the NAS Website. The migration is part of an improvement initiative, which includes giving the site a new look and making it more user friendly.

During the migration information may exist both at the old and new site, however slowly pages should start to be located mainly at the new site. Please see the NAS Website for details.

N5200 Module: APCUPSD

From Thecus Wiki

Jump to: navigation, search

Page migrated to NASWebsite.com

Contents

Facts

Module Name  : APCUPSD (APC UPS Monitoring)
Maintainer  : Falk John
Target  : N5200 series
Latest version  : 1.04.03
Website  : www.fajo.de
apcupsd  : 3.14.6 www.apcupsd.org

Description

This module monitors APC UPS devices and will shutdown the system on specific thresholds if configured and supported by the UPS. In contrast with the N5200 integrated UPS solution (based on Network UPS Tools (NUT)) this module supports APC devices connected through the USB port. Further, if the UPS is not directly connected to this system the module can be used in client mode. In client mode a apcupsd server will be queried for UPS status information. If the UPS is connected directly this system can act as server for other apcupsd clients.

Installation

Use the link in the Versions section to download the module. To prevent your browser from starting media players (because of the .mod extension) the module package is contained in a ZIP file.

Extract the module binary package (.mod) from the archive and install it.

Note: Up to version 1.03.00 the module configuration was not backed up when the module was uninstalled. If you upgrade from a version below 1.04.00 please write your current configuation down before uninstalling the old version of the module.

Configuration

After enabling the module the module configuration page can be accessed. All configuration parameters are explained at the bottom of the configuration page.

When using a serial cable make sure that:

  • you disabled the Thecus UPS feature
  • the SERGETTY module is not installed
  • no other application uses the serial port


Note: When enabled for the first time the UPS daemon will be started with the USB driver active and all shutdown thresholds disabled. After re-installing the module (either the same or a different version) the configuration will be reset to defaults.

apctest Command line utility

The module distribution contains a command line utility called apctest which can be used to display/change certain UPS EEPROM parameters such as battery date or UPS name. To use this utility the apcupsd daemon must not be running - it can be stopped by issuing:

   /raid/data/module/APCUPSD/system/etc/rc.d/apcupsd stop

on the command line (SSHD/SYSUSER modules required).

You can start the apctest command by issuing:

   /raid/data/module/APCUPSD/system/sbin/apctest

on the command line.

Restriction note: The apctest utility will not work on DUMP UPS models. Not all UPS models will allow changes of all supported parameters. This is a restriction of the UPS rather than one of the apctest utility.

Tip note: When your UPS does not respond when connected directly to the N5200, try the apctest offline test (really try on battery). It solves many USB detection problems.

Confirmed Configurations

This module should work for almost all APC UPS devices. The following APC UPS devices have been tested and confirmed to work with this module.

Type Model Firmware Driver/Type Cable Tested/Confirmed by
Back-UPS Pro 420 N/A APC Smart 940-0095B on /dev/ttyS0
Back-UPS 650 N/A DUMB 940-0020B Dave Griffiths
Back-UPS 700 ES 829.D2 .I USB FW:D2 USB USB Dave Christie
Back-UPS ES 725 802.n5.D USB FW:n5 USB USB Bruce Cheng
Back-UPS CS 500 808.q8.I USB FW:q8 USB USB Falk John
Back-UPS CS 650 817.v4.I USB FW:v4 USB USB Thomas Kuehne
Back-UPS RS 1000 7.g3 .D USB FW:g3 USB USB Dave Griffiths
Back-UPS RS 1000 7.g9a.I USB FW:g9a USB USB Dave Christie
Back-UPS RS 1500 8.g7 .I USB FW:g7 USB USB Vincent Barbarin
Smart-UPS 750 XL 630.3.D USB FW:1.5 USB USB Teng Lee
Smart-UPS 1000 60.11.1 APC Smart 940-0024C on /dev/ttyS0 Willem
Smart-UPS 1400 DUMB 940-0020B on /dev/ttyS0
(through AP9607 Interface Expander)
Martin

Feature Requests

Versions

Version 1.04.03

Released  : 2009-12-29
apcupsd  : 3.14.6
Firmware  : 2.00.00 or higher
Download  : N5200-APCUPSD-1.04.03.mod.zip
Checksums  : MD5 SHA1
Changes  :
  • fixed: issues with FW 3.x

Version 1.04.02

Released  : 2009-06-16
apcupsd  : 3.14.6
Firmware  : 2.00.00 or higher
Download  : N5200-APCUPSD-1.04.02.mod.zip
Checksums  : MD5 SHA1
Changes  :
  • updated apcupsd to 3.14.6 (patched)
  • fixed: system shutdown script location
  • fixed: issues with FW 2.01.09 (apcupsd patch and hiddev numbering)

Version 1.04.01

Released  : 2009-01-31
apcupsd  : 3.14.5
Firmware  : 2.00.00 or higher
Download  : N5200-APCUPSD-1.04.01.mod.zip
Checksums  : MD5 SHA1
Changes  :
  • fixed bug in LCD notification that caused agent2 to hang

Version 1.04.00

Released  : 2009-01-17
apcupsd  : 3.14.5
Firmware  : 2.00.00 or higher
Download  : N5200-APCUPSD-1.04.00.mod.zip
Checksums  : MD5 SHA1
Changes  :
  • apcupsd updated to v3.14.5
  • acoustic/email notification on events (using Thecus mail impl.)
  • LCD notification on events
  • start/stop daemon available from module main page
  • help made context sensitive for better usability
  • starting from this release the config will be backed up on uninstall and restored on a later install

Version 1.03.00

Released  : 2008-06-05
apcupsd  : 3.14.4
Firmware  : 2.00.00 or higher
Download  : N5200-APCUPSD-1.03.00.mod.zip
Checksums  : MD5 SHA1
Changes  :
  • apcupsd updated to v3.14.4
  • included pcnet (PowerChute) driver
  • fast access through Status menu (FW 2.00.08 or higher)

Version 1.02.00

Released  : 2008-01-20
apcupsd  : 3.14.3
Firmware  : 2.00.00 or higher
Download  : N5200-APCUPSD-1.02.00.mod.zip
Checksums  : MD5 SHA1
Changes  :
  • apcupsd updated to v3.14.3
  • included apctest utility

Version 1.01.00

Released  : 2008-01-13
apcupsd  : 3.14.2
Firmware  : 2.00.00 or higher
Download  : N5200-APCUPSD-1.01.00.mod.zip
Checksums  : MD5 SHA1
Changes  :
  • added event log display to WebUI
  • added raw status display to WebUI
  • removed pcnet driver from UPS type dropdown (not compiled into apcupsd)
  • minor internal fixes, improvements and code cleanup

Version 1.00.00

Released  : 2008-01-03
apcupsd  : 3.14.2
Firmware  : 2.00.00 or higher
Download  : N5200-APCUPSD-1.00.00.mod.zip
Checksums  : MD5 SHA1
Changes  : (initial release)
Personal tools
product resources