apcupsd-ups man page

apcupsd-ups — Driver for apcupsd client access

Note

This man page only documents the specific features of the apcupsd-ups driver. For information about the core driver, see nutupsdrv(8).

Description

This driver is a client to apcupsd.

apcupsd-ups acts as an apcupsd client, simply forwarding data. This can be useful in cases where both protocols are required in a network, or in case apcupsd has a required UPS access mode missing from NUT.

Extra Arguments

This driver supports the following optional settings in nut.conf(5):

port=<hostname>[:<port>]

This is the name of a remote host running apcupsd (plus an optional port).

For instance:

[apcupsd]
            driver = apcupsd-ups
            port = localhost
            desc = "apcupsd client"

Background

This driver was originally written in one evening to allow interworking with apcupsd.

Supported Variables

The following variables are translated from apcupsd to NUT. All times should be converted to seconds (please file a bug if you notice a mismatch in units).

apcupsd variableNUT variable(s)
BCHARGEbattery.charge
MBATTCHGbattery.charge.low
RETPCTbattery.charge.restart
BATTDATEbattery.date
TIMELEFTbattery.runtime
MINTIMELbattery.runtime.low
BATTVbattery.voltage
NOMBATTVbattery.voltage.nominal
LINEFREQinput.frequency
SENSEinput.sensitivity
HITRANSinput.transfer.high
LOTRANSinput.transfer.low
LASTXFERinput.transfer.reason
LINEVinput.voltage
MAXLINEVinput.voltage.maximum
MINLINEVinput.voltage.minimum
NOMINVinput.voltage.nominal
LINEFREQoutput.frequency
OUTPUTVoutput.voltage
NOMOUTVoutput.voltage.nominal
DATEups.date, ups.time
DSHUTDups.delay.shutdown
DWAKEups.delay.start
FIRMWAREups.firmware, ups.firmware.aux
UPSNAMEups.id
LOADPCTups.load
MANDATEups.mfr.date
NOMPOWERups.realpower.nominal
SERIALNOups.serial
STATUSups.status
ITEMPups.temperature
STESTIups.test.interval
SELFTESTups.test.result

Limitations

Access to apcupsd is strictly read only: no commands can be issued. This stems from the design of apcupsd, where the settings are changed in apctest. In order to run apctest, apcupsd must be stopped (and apcupsd exposes the UPS to the network).

Author

Andreas Steinmetz

See Also

ups.conf(5), nutupsdrv(8)

Internet Resources

The NUT (Network UPS Tools) home page: http://www.networkupstools.org/

The apcupsd home page: http://www.apcupsd.org/

Info

12/29/2015 Network UPS Tools 2.7.3. NUT Manual