1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
APCUPSD-UPS(8)
==============
NAME
----
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
linkman:nutupsdrv[8].
DESCRIPTION
-----------
This driver is a client to *apcupsd* (another UPS monitoring project).
*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 linkman: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 interoperating
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).
[width="50%",cols="m,m",options="header"]
|===============================
| apcupsd variable | NUT variable(s)
| BCHARGE | battery.charge
| MBATTCHG | battery.charge.low
| RETPCT | battery.charge.restart
| BATTDATE | battery.date
| TIMELEFT | battery.runtime
| MINTIMEL | battery.runtime.low
| BATTV | battery.voltage
| NOMBATTV | battery.voltage.nominal
| LINEFREQ | input.frequency
| SENSE | input.sensitivity
| HITRANS | input.transfer.high
| LOTRANS | input.transfer.low
| LASTXFER | input.transfer.reason
| LINEV | input.voltage
| MAXLINEV | input.voltage.maximum
| MINLINEV | input.voltage.minimum
| NOMINV | input.voltage.nominal
| LINEFREQ | output.frequency
| OUTPUTV | output.voltage
| NOMOUTV | output.voltage.nominal
| DATE | ups.date, ups.time
| DSHUTD | ups.delay.shutdown
| DWAKE | ups.delay.start
| FIRMWARE | ups.firmware, ups.firmware.aux
| UPSNAME | ups.id
| LOADPCT | ups.load
| MANDATE | ups.mfr.date
| NOMPOWER | ups.realpower.nominal
| SERIALNO | ups.serial
| STATUS | ups.status
| ITEMP | ups.temperature
| STESTI | ups.test.interval
| SELFTEST | ups.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 it is *apcupsd* exposes the UPS to the network and to this NUT
driver as its client).
AUTHOR
------
Andreas Steinmetz
SEE ALSO
--------
linkman:ups.conf[5],
linkman:nutupsdrv[8]
Internet Resources:
~~~~~~~~~~~~~~~~~~~
* The NUT (Network UPS Tools) home page: https://www.networkupstools.org/
* The apcupsd home page: http://www.apcupsd.org/
|
