apcupsd-ups(8)

1APCUPSD-UPS(8)                    NUT Manual                    APCUPSD-UPS(8)
2
3
4

NAME

6       apcupsd-ups - Driver for apcupsd client access
7

NOTE

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

DESCRIPTION

13       This driver is a client to apcupsd (another UPS monitoring project).
14
15       apcupsd-ups acts as an apcupsd client, simply forwarding data. This can
16       be useful in cases where both protocols are required in a network, or
17       in case apcupsd has a required UPS access mode missing from NUT.
18

EXTRA ARGUMENTS

20       This driver supports the following optional settings in nut.conf(5):
21
22       port=<hostname>[:<port>]
23           This is the name of a remote host running apcupsd (plus an optional
24           port).
25
26       For instance:
27
28           [apcupsd]
29                       driver = apcupsd-ups
30                       port = localhost
31                       desc = "apcupsd client"
32

BACKGROUND

34       This driver was originally written in one evening to allow
35       interoperating with apcupsd.
36

SUPPORTED VARIABLES

38       The following variables are translated from apcupsd to NUT. All times
39       should be converted to seconds (please file a bug if you notice a
40       mismatch in units).
41
42       ┌─────────────────┬─────────────────────────┐
43       │apcupsd variable │ NUT variable(s)         │
44       ├─────────────────┼─────────────────────────┤
45       │                 │                         │
46       │BCHARGE          │ battery.charge          │
47       ├─────────────────┼─────────────────────────┤
48       │                 │                         │
49       │MBATTCHG         │ battery.charge.low      │
50       ├─────────────────┼─────────────────────────┤
51       │                 │                         │
52       │RETPCT           │ battery.charge.restart  │
53       ├─────────────────┼─────────────────────────┤
54       │                 │                         │
55       │BATTDATE         │ battery.date            │
56       ├─────────────────┼─────────────────────────┤
57       │                 │                         │
58       │TIMELEFT         │ battery.runtime         │
59       ├─────────────────┼─────────────────────────┤
60       │                 │                         │
61       │MINTIMEL         │ battery.runtime.low     │
62       ├─────────────────┼─────────────────────────┤
63       │                 │                         │
64       │BATTV            │ battery.voltage         │
65       ├─────────────────┼─────────────────────────┤
66       │                 │                         │
67       │NOMBATTV         │ battery.voltage.nominal │
68       ├─────────────────┼─────────────────────────┤
69       │                 │                         │
70       │LINEFREQ         │ input.frequency         │
71       ├─────────────────┼─────────────────────────┤
72       │                 │                         │
73       │SENSE            │ input.sensitivity       │
74       ├─────────────────┼─────────────────────────┤
75       │                 │                         │
76       │HITRANS          │ input.transfer.high     │
77       ├─────────────────┼─────────────────────────┤
78       │                 │                         │
79       │LOTRANS          │ input.transfer.low      │
80       ├─────────────────┼─────────────────────────┤
81       │                 │                         │
82       │LASTXFER         │ input.transfer.reason   │
83       ├─────────────────┼─────────────────────────┤
84       │                 │                         │
85       │LINEV            │ input.voltage           │
86       ├─────────────────┼─────────────────────────┤
87       │                 │                         │
88       │MAXLINEV         │ input.voltage.maximum   │
89       ├─────────────────┼─────────────────────────┤
90       │                 │                         │
91       │MINLINEV         │ input.voltage.minimum   │
92       ├─────────────────┼─────────────────────────┤
93       │                 │                         │
94       │NOMINV           │ input.voltage.nominal   │
95       ├─────────────────┼─────────────────────────┤
96       │                 │                         │
97       │LINEFREQ         │ output.frequency        │
98       ├─────────────────┼─────────────────────────┤
99       │                 │                         │
100       │OUTPUTV          │ output.voltage          │
101       ├─────────────────┼─────────────────────────┤
102       │                 │                         │
103       │NOMOUTV          │ output.voltage.nominal  │
104       ├─────────────────┼─────────────────────────┤
105       │                 │                         │
106       │DATE             │ ups.date, ups.time      │
107       ├─────────────────┼─────────────────────────┤
108       │                 │                         │
109       │DSHUTD           │ ups.delay.shutdown      │
110       ├─────────────────┼─────────────────────────┤
111       │                 │                         │
112       │DWAKE            │ ups.delay.start         │
113       ├─────────────────┼─────────────────────────┤
114       │                 │                         │
115       │FIRMWARE         │ ups.firmware,           │
116       │                 │ ups.firmware.aux        │
117       ├─────────────────┼─────────────────────────┤
118       │                 │                         │
119       │UPSNAME          │ ups.id                  │
120       ├─────────────────┼─────────────────────────┤
121       │                 │                         │
122       │LOADPCT          │ ups.load                │
123       ├─────────────────┼─────────────────────────┤
124       │                 │                         │
125       │MANDATE          │ ups.mfr.date            │
126       ├─────────────────┼─────────────────────────┤
127       │                 │                         │
128       │NOMPOWER         │ ups.realpower.nominal   │
129       ├─────────────────┼─────────────────────────┤
130       │                 │                         │
131       │SERIALNO         │ ups.serial              │
132       ├─────────────────┼─────────────────────────┤
133       │                 │                         │
134       │STATUS           │ ups.status              │
135       ├─────────────────┼─────────────────────────┤
136       │                 │                         │
137       │ITEMP            │ ups.temperature         │
138       ├─────────────────┼─────────────────────────┤
139       │                 │                         │
140       │STESTI           │ ups.test.interval       │
141       ├─────────────────┼─────────────────────────┤
142       │                 │                         │
143       │SELFTEST         │ ups.test.result         │
144       └─────────────────┴─────────────────────────┘
145

LIMITATIONS

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

AUTHOR

153       Andreas Steinmetz
154