« back to all changes in this revision
Viewing changes to docs/new-names.txt
- browse files at revision 1.1.2
- compare with another revision
- download diff
- download tarball
- view history from revision 1.1.2
- Committer: Bazaar Package Importer
- Author(s): Reinhard Tartler
- Date: 2005-07-20 19:48:50 UTC
- mto: (16.1.1 squeeze)
- mto: This revision was merged to the branch mainline in revision 4.
- Revision ID: james.westby@ubuntu.com-20050720194850-oo61wjr33rrx2mre
Tags: upstream-2.0.2
Import upstream version 2.0.2
- files added:
- data/driver.list
- lib
- files removed:
- clients/libupsclient.a
- files modified:
- CHANGES
added
removed
docs/new-names.txt
1
Desc: New naming scheme
1
Desc: New command and variable naming scheme
2
2
File: new-names.txt
3
Date: 25 February 2004
3
Date: 29 September 2004
4
4
Auth: Russell Kroll <rkroll@exploits.org>
5
5
6
*** Note: for the current list, check the development tree
7
8
This is a dump of the planning page for the variable and instant
9
command renaming effort. Don't use a name with any of the dstate
10
functions unless it exists here.
6
This is a dump of the planning page for variables and command names.
7
Don't use a name with any of the dstate functions unless it exists here.
11
8
12
9
If you need a new variable or command name, contact me first.
13
10
11
Put another way: if you make up a name that's not in this list and it
12
gets into the tree, and then we come up with a better name later, clients
13
that use the undocumented variable will break when it is changed.
14
15
Note: "opaque" means programs should not attempt to parse the value for
16
that variable as it may vary greatly from one UPS to the next. These
17
strings are best handled directly by the user.
18
14
19
Variables
15
20
16
+------------------------------------------------------------------------+
17
| ups - General unit information |
18
|------------------------------------------------------------------------|
19
| Old name | New name | Description |Typical value| In |
20
| | | | |var_map?|
21
|----------+--------------------+-----------------+-------------+--------|
22
|STATUS |ups.status |UPS status |OL |yes |
23
|----------+--------------------+-----------------+-------------+--------|
24
|n/a |ups.alarm |UPS alarms |OVERHEAT |n/a |
25
|----------+--------------------+-----------------+-------------+--------|
26
|n/a |ups.time |Internal UPS |n/a | |
27
| | |clock time | | |
28
|----------+--------------------+-----------------+-------------| |
29
|n/a |ups.date |Internal UPS |n/a | |
30
| | |clock date | | |
31
|----------+--------------------+-----------------+-------------+--------|
32
|MODEL |ups.model |UPS model |SMART-UPS 700|yes |
33
|----------+--------------------+-----------------+-------------+--------|
34
|MFR |ups.mfr |UPS manufacturer |APC |yes |
35
|----------+--------------------+-----------------+-------------+--------|
36
| | |UPS manufacturing| | |
37
|MFRDATE |ups.mfr.date |date (opaque |10/17/96 |yes |
38
| | |string) | | |
39
|----------+--------------------+-----------------+-------------+--------|
40
|SERIAL |ups.serial |UPS serial number|WS9643050926 |yes |
41
| | |(opaque string) | | |
42
|----------+--------------------+-----------------+-------------+--------|
43
|FIRMREV |ups.firmware |UPS firmware |50.9.D |yes |
44
| | |(opaque string) | | |
45
|----------+--------------------+-----------------+-------------+--------|
46
|FIRMREV2 |ups.firmware.aux |Auxiliary device |4Kx |yes |
47
| | |firmware | | |
48
|----------+--------------------+-----------------+-------------+--------|
49
|UPSTEMP |ups.temperature |UPS temperature |042.7 |yes |
50
| | |(degrees C) | | |
51
|----------+--------------------+-----------------+-------------+--------|
52
|LOADPCT |ups.load |Load on UPS |023.4 |yes |
53
| | |(percent) | | |
54
|----------+--------------------+-----------------+-------------+--------|
55
| | |UPS system | | |
56
|UPSIDENT |ups.id |identifier |Sierra |yes |
57
| | |(opaque string) | | |
58
|----------+--------------------+-----------------+-------------+--------|
59
| | |Interval to wait | | |
60
|WAKEDELAY |ups.delay.start |before restarting|0 |yes |
61
| | |the load | | |
62
| | |(seconds) | | |
63
|----------+--------------------+-----------------+-------------+--------|
64
| | |Interval to wait | | |
65
|n/a |ups.delay.reboot |before rebooting |60 |n/a |
66
| | |the UPS (seconds)| | |
67
|----------+--------------------+-----------------+-------------+--------|
68
| | |Interval to wait | | |
69
|PDNGRACE |ups.delay.shutdown |after shutdown |20 |yes |
70
|GRACEDELAY| |with delay | | |
71
| | |command (seconds)| | |
72
|----------+--------------------+-----------------+-------------+--------|
73
| | |Interval between |1209600 (two | |
74
|SLFTSTINT |ups.test.interval |self tests |weeks) |yes |
75
| | |(seconds) | | |
76
|----------+--------------------+-----------------+-------------+--------|
77
| | |Results of last |Bad battery | |
78
|SLFTSTRES |ups.test.result |self test (opaque|pack |yes |
79
| | |string) | | |
80
|----------+--------------------+-----------------+-------------+--------|
81
| | |Language to use | | |
82
|LANGUAGE |ups.display.language|on front panel |E |yes |
83
| | |(*** opaque) | | |
84
|----------+--------------------+-----------------+-------------+--------|
85
| | |UPS external | | |
86
|CONTACTS |ups.contacts |contact sensors |F0 |yes |
87
| | |(*** opaque) | | |
88
+------------------------------------------------------------------------+
89
90
+------------------------------------------------------------------------+
91
| input - Incoming line/power information |
92
|------------------------------------------------------------------------|
93
| Old name | New name | Description |Typical | In |
94
| | | | value |var_map?|
95
|-----------+-------------------------+----------------+--------+--------|
96
|UTILITY |input.voltage |Input voltage |121.5 |yes |
97
|-----------+-------------------------+----------------+--------+--------|
98
|MAXUTIL |input.voltage.maximum |Maximum incoming|130 |yes |
99
| | |voltage seen | | |
100
|-----------+-------------------------+----------------+--------+--------|
101
|MINUTIL |input.voltage.minimum |Minimum incoming|100 |yes |
102
| | |voltage seen | | |
103
|-----------+-------------------------+----------------+--------+--------|
104
|n/a |input.voltage.nominal |Nominal input |120 |n/a |
105
| | |voltage | | |
106
|-----------+-------------------------+----------------+--------+--------|
107
| | |Reason for last | | |
108
|XFERWHY |input.transfer.reason |transfer to |T |yes |
109
| | |battery (*** | | |
110
| | |opaque) | | |
111
|-----------+-------------------------+----------------+--------+--------|
112
|LOWXFER |input.transfer.low |Low voltage |103 |yes |
113
| | |transfer point | | |
114
|-----------+-------------------------+----------------+--------+--------|
115
|HIGHXFER |input.transfer.high |High voltage |132 |yes |
116
| | |transfer point | | |
117
|-----------+-------------------------+----------------+--------+--------|
118
|LINESENS |input.sensitivity |Input power |H (high)|yes |
119
| | |sensitivity | | |
120
|-----------+-------------------------+----------------+--------+--------|
121
| | |Input power | | |
122
|LINEQUAL |input.quality |quality (*** |FF |yes |
123
| | |opaque) | | |
124
|-----------+-------------------------+----------------+--------+--------|
125
|ACFREQ |input.frequency |Input line |60.00 |yes |
126
| | |frequency (Hz) | | |
127
|-----------+-------------------------+----------------+--------+--------|
128
| | |Low voltage | | |
129
|LOBOOSTXFER|input.transfer.boost.low |boosting |190 |yes |
130
| | |transfer point | | |
131
|-----------+-------------------------+----------------+--------+--------|
132
| | |High voltage | | |
133
|HIBOOSTXFER|input.transfer.boost.high|boosting |210 |yes |
134
| | |transfer point | | |
135
|-----------+-------------------------+----------------+--------+--------|
136
| | |Low voltage | | |
137
|LOTRIMXFER |input.transfer.trim.low |trimming |230 |yes |
138
| | |transfer point | | |
139
|-----------+-------------------------+----------------+--------+--------|
140
| | |High voltage | | |
141
|HITRIMXFER |input.transfer.trim.high |trimming |240 |yes |
142
| | |transfer point | | |
143
+------------------------------------------------------------------------+
144
145
+------------------------------------------------------------------------+
146
| output - Outgoing power/inverter information |
147
|------------------------------------------------------------------------|
148
|Old name | New name | Description |Typical| In |
149
| | | | value |var_map?|
150
|---------+-----------------------------+---------------+-------+--------|
151
|OUTVOLT |output.voltage |Output voltage |120.9 |yes |
152
|---------+-----------------------------+---------------+-------+--------|
153
|n/a |output.frequency |Output |60 |n/a |
154
| | |frequency (Hz) | | |
155
|---------+-----------------------------+---------------+-------+--------|
156
| | |Target output | | |
157
|OUTVLTSEL|output.voltage.target.line |voltage when on|120 |yes |
158
| | |line | | |
159
|---------+-----------------------------+---------------+-------+--------|
160
| | |Target output | | |
161
|REQVOLT |output.voltage.target.battery|voltage when on|120 |yes |
162
| | |battery | | |
163
|---------+-----------------------------+---------------+-------+--------|
164
|CURRENT |output.current |Output current |4.25 |yes |
165
| | |(amps) | | |
166
+------------------------------------------------------------------------+
167
168
+------------------------------------------------------------------------+
169
| battery - Any battery details |
170
|------------------------------------------------------------------------|
171
|BATTPCT |battery.charge |Battery charge |100.0 |yes|
172
| | |(percent) | | |
173
|------------+-----------------------+-----------------+-------------+---|
174
| | |Remaining battery| | |
175
|LOBATTPCT |battery.charge.low |level when UPS |20 |yes|
176
| | |switches to LB | | |
177
| | |(percent) | | |
178
|------------+-----------------------+-----------------+-------------+---|
179
| | |Minimum battery | | |
180
|WAKETHRSH |battery.charge.restart |level for UPS |20 |yes|
181
|RTHRESH | |restart after | | |
182
| | |power-off | | |
183
|------------+-----------------------+-----------------+-------------+---|
184
|BATTVOLT |battery.voltage |Battery charge |24.84 |yes|
185
| | |(volts) | | |
186
|------------+-----------------------+-----------------+-------------+---|
187
|BATT_CURRENT|battery.current |Battery current |1.19 |yes|
188
| | |(amps) | | |
189
|------------+-----------------------+-----------------+-------------+---|
190
| | |Battery | | |
191
|BATT_TEMP |battery.temperature |temperature |050.7 |yes|
192
| | |(degrees C) | | |
193
|------------+-----------------------+-----------------+-------------+---|
194
|NOMBATVLT |battery.voltage.nominal|Nominal battery |024 |yes|
195
| | |voltage | | |
196
|------------+-----------------------+-----------------+-------------+---|
197
|BATT_RUNTIME|battery.runtime |Battery runtime |1080 |yes|
198
|RUNTIME | |(seconds) | | |
199
|------------+-----------------------+-----------------+-------------+---|
200
| | |Remaining battery| | |
201
|LOBATTIME |battery.runtime.low |runtime when UPS |180 |yes|
202
| | |switches to LB | | |
203
| | |(seconds) | | |
204
|------------+-----------------------+-----------------+-------------+---|
205
|ALRMDELAY |battery.alarm.threshold|Battery alarm |0 (immediate)|yes|
206
|ALRMDEL | |threshold | | |
207
|------------+-----------------------+-----------------+-------------+---|
208
| | |Battery change | | |
209
|BATTDATE |battery.date |date (opaque |11/14/00 |yes|
210
| | |string) | | |
211
|------------+-----------------------+-----------------+-------------+---|
212
|BATTPACKS |battery.packs |Number of battery|001 |yes|
213
| | |packs | | |
214
|------------+-----------------------+-----------------+-------------+---|
215
|BADPACKS |battery.packs.bad |Number of bad |000 |yes|
216
| | |battery packs | | |
217
+------------------------------------------------------------------------+
218
219
+------------------------------------------------------------------------+
220
| ambient - Conditions from external probe equipment |
221
|------------------------------------------------------------------------|
222
|Old name| New name |Description |Typical| In |
223
| | | | value |var_map?|
224
|--------+---------------------------------+------------+-------+--------|
225
| | |Ambient | | |
226
|AMBTEMP |ambient.temperature |temperature |25.40 |yes |
227
| | |(degrees C) | | |
228
|--------+---------------------------------+------------+-------+--------|
229
| | |Set if | | |
230
| | |ambient | | |
231
|n/a |ambient.temperature.alarm |temperature |0 |n/a |
232
| | |alarm is | | |
233
| | |active | | |
234
|--------+---------------------------------+------------+-------+--------|
235
| | |Maximum | | |
236
|TEMPMAX |ambient.temperature.alarm.maximum|allowed |NO,NO |yes |
237
| | |temperature | | |
238
| | |(*** opaque)| | |
239
|--------+---------------------------------+------------+-------+--------|
240
| | |Minimum | | |
241
|TEMPMIN |ambient.temperature.alarm.minimum|allowed |NO,NO |yes |
242
| | |temperature | | |
243
| | |(*** opaque)| | |
244
|--------+---------------------------------+------------+-------+--------|
245
| | |Enable alarm| | |
246
|n/a |ambient.temperature.alarm.enable |for ambient |1 |n/a |
247
| | |temperature | | |
248
|--------+---------------------------------+------------+-------+--------|
249
| | |Ambient | | |
250
|AMBHUMID|ambient.humidity |relative |038.8 |yes |
251
| | |humidity | | |
252
| | |(percent) | | |
253
|--------+---------------------------------+------------+-------+--------|
254
| | |Set if | | |
255
| | |ambient | | |
256
|n/a |ambient.humidity.alarm |humidity |0 |n/a |
257
| | |alarm is | | |
258
| | |active | | |
259
|--------+---------------------------------+------------+-------+--------|
260
| | |Maximum | | |
261
|HUMDMAX |ambient.humidity.alarm.maximum |allowed |NO,NO |yes |
262
| | |humidity | | |
263
| | |(*** opaque)| | |
264
|--------+---------------------------------+------------+-------+--------|
265
| | |Minimum | | |
266
|HUMDMIN |ambient.humidity.alarm.minimum |allowed |NO,NO |yes |
267
| | |humidity | | |
268
| | |(*** opaque)| | |
269
|--------+---------------------------------+------------+-------+--------|
270
| | |Enable alarm| | |
271
|n/a |ambient.humidity.alarm.enable |for ambient |1 |n/a |
272
| | |humidity | | |
273
+------------------------------------------------------------------------+
274
275
+------------------------------------------------------------------------+
276
| outlet - Smart outlet management (smart on/off switch, ...) |
277
|------------------------------------------------------------------------|
278
|Old | New name | Description |Typical| In |
279
|name| | | value |var_map?|
280
|----+------------------------------+-------------------+-------+--------|
281
| | |Outlet system | | |
282
|n/a |outlet.n.id |identifier (opaque |1 |no |
283
| | |string) | | |
284
|----+------------------------------+-------------------+-------+--------|
285
|n/a |outlet.n.desc |Outlet description |Main |no |
286
| | |(opaque string) |outlet | |
287
|----+------------------------------+-------------------+-------+--------|
288
|n/a |outlet.n.switch |Outlet switch |on |no |
289
| | |control (on/off) | | |
290
|----+------------------------------+-------------------+-------+--------|
291
|n/a |outlet.n.status |Outlet switch |on |no |
292
| | |status (on/off) | | |
293
|----+------------------------------+-------------------+-------+--------|
294
|n/a |outlet.n.switchable |Outlet switch |yes |no |
295
| | |ability (yes/no) | | |
296
|----+------------------------------+-------------------+-------+--------|
297
| | |Remaining battery | | |
298
|n/a |outlet.n.autoswitch.charge.low|level to power off |90 |no |
299
| | |this outlet | | |
300
| | |(percent) | | |
301
|----+------------------------------+-------------------+-------+--------|
302
| | |Interval to wait | | |
303
|n/a |outlet.n.delay.shutdown |before shutting |180 |no |
304
| | |down this outlet | | |
305
| | |(seconds) | | |
306
|----+------------------------------+-------------------+-------+--------|
307
| | |Interval to wait | | |
308
|n/a |outlet.n.delay.start |before restarting |120 |no |
309
| | |this outlet | | |
310
| | |(seconds) | | |
311
+------------------------------------------------------------------------+
312
313
+------------------------------------------------------------------------+
314
| driver - Internal driver information |
315
|------------------------------------------------------------------------|
316
| Old | New name | Description | Typical | In |
317
| name | | | value | var_map? |
318
|------+-------------------------+-----------------+----------+----------|
319
| n/a | driver.name | Driver name | apcsmart | n/a |
320
|------+-------------------------+-----------------+----------+----------|
321
| n/a | driver.version | Driver version | X.Y.Z | n/a |
322
| | | (NUT release) | | |
323
|------+-------------------------+-----------------+----------+----------|
324
| | | Internal driver | | |
325
| n/a | driver.version.internal | version (if | 1.23.45 | n/a |
326
| | | tracked | | |
327
| | | separately) | | |
328
|------+-------------------------+-----------------+----------+----------|
329
| | | Parameter xxx | | |
330
| n/a | driver.parameter.xxx | (ups.conf or | (varies) | n/a |
331
| | | cmdline -x) | | |
332
| | | setting | | |
333
|------+-------------------------+-----------------+----------+----------|
334
| | | Flag xxx | enabled | |
335
| n/a | driver.flag.xxx | (ups.conf or | (or not | n/a |
336
| | | cmdline -x) | present) | |
337
| | | status | | |
338
+------------------------------------------------------------------------+
339
340
+------------------------------------------------------------------------+
341
| server - Internal server information |
342
|------------------------------------------------------------------------|
343
|Old | New name |Description| Typical value | In |
344
|name| | | |var_map?|
345
|----+--------------+-----------+-------------------------------+--------|
346
|n/a |server.info |Server |Network UPS Tools upsd vX.Y.Z -|n/a |
347
| | |information|http://www.exploits.org/nut/ | |
348
|----+--------------+-----------+-------------------------------+--------|
349
|n/a |server.version|Server |X.Y.Z |n/a |
350
| | |version | | |
21
ups: General unit information
22
23
+------------------------------------------------------------------------+
24
| Name | Description | Typical value |
25
|----------------------+------------------------------+------------------|
26
| ups.status | UPS status | OL |
27
|----------------------+------------------------------+------------------|
28
| ups.alarm | UPS alarms | OVERHEAT |
29
|----------------------+------------------------------+------------------|
30
| ups.time | Internal UPS clock time | 12:34 |
31
| | (opaque string) | |
32
|----------------------+------------------------------+------------------|
33
| ups.date | Internal UPS clock date | 01-02-03 |
34
| | (opaque string) | |
35
|----------------------+------------------------------+------------------|
36
| ups.model | UPS model | SMART-UPS 700 |
37
|----------------------+------------------------------+------------------|
38
| ups.mfr | UPS manufacturer | APC |
39
|----------------------+------------------------------+------------------|
40
| ups.mfr.date | UPS manufacturing date | 10/17/96 |
41
| | (opaque string) | |
42
|----------------------+------------------------------+------------------|
43
| ups.serial | UPS serial number (opaque | WS9643050926 |
44
| | string) | |
45
|----------------------+------------------------------+------------------|
46
| ups.firmware | UPS firmware (opaque string) | 50.9.D |
47
|----------------------+------------------------------+------------------|
48
| ups.firmware.aux | Auxiliary device firmware | 4Kx |
49
|----------------------+------------------------------+------------------|
50
| ups.temperature | UPS temperature (degrees C) | 042.7 |
51
|----------------------+------------------------------+------------------|
52
| ups.load | Load on UPS (percent) | 023.4 |
53
|----------------------+------------------------------+------------------|
54
| ups.id | UPS system identifier | Sierra |
55
| | (opaque string) | |
56
|----------------------+------------------------------+------------------|
57
| | Interval to wait before | |
58
| ups.delay.start | restarting the load | 0 |
59
| | (seconds) | |
60
|----------------------+------------------------------+------------------|
61
| ups.delay.reboot | Interval to wait before | 60 |
62
| | rebooting the UPS (seconds) | |
63
|----------------------+------------------------------+------------------|
64
| | Interval to wait after | |
65
| ups.delay.shutdown | shutdown with delay command | 20 |
66
| | (seconds) | |
67
|----------------------+------------------------------+------------------|
68
| ups.test.interval | Interval between self tests | 1209600 (two |
69
| | (seconds) | weeks) |
70
|----------------------+------------------------------+------------------|
71
| ups.test.result | Results of last self test | Bad battery pack |
72
| | (opaque string) | |
73
|----------------------+------------------------------+------------------|
74
| ups.display.language | Language to use on front | E |
75
| | panel (*** opaque) | |
76
|----------------------+------------------------------+------------------|
77
| ups.contacts | UPS external contact sensors | F0 |
78
| | (*** opaque) | |
79
|----------------------+------------------------------+------------------|
80
| ups.power | Current value of apparent | 500 |
81
| | power (Volt-Amps) | |
82
|----------------------+------------------------------+------------------|
83
| ups.power.nominal | Nominal value of apparent | 500 |
84
| | power (Volt-Amps) | |
85
+------------------------------------------------------------------------+
86
87
input: Incoming line/power information
88
89
+------------------------------------------------------------------------+
90
| Name | Description | Typical value |
91
|---------------------------+----------------------------+---------------|
92
| input.voltage | Input voltage | 121.5 |
93
|---------------------------+----------------------------+---------------|
94
| input.voltage.maximum | Maximum incoming voltage | 130 |
95
| | seen | |
96
|---------------------------+----------------------------+---------------|
97
| input.voltage.minimum | Minimum incoming voltage | 100 |
98
| | seen | |
99
|---------------------------+----------------------------+---------------|
100
| input.voltage.nominal | Nominal input voltage | 120 |
101
|---------------------------+----------------------------+---------------|
102
| input.transfer.reason | Reason for last transfer | T |
103
| | to battery (*** opaque) | |
104
|---------------------------+----------------------------+---------------|
105
| input.transfer.low | Low voltage transfer point | 103 |
106
|---------------------------+----------------------------+---------------|
107
| input.transfer.high | High voltage transfer | 132 |
108
| | point | |
109
|---------------------------+----------------------------+---------------|
110
| input.sensitivity | Input power sensitivity | H (high) |
111
|---------------------------+----------------------------+---------------|
112
| input.quality | Input power quality (*** | FF |
113
| | opaque) | |
114
|---------------------------+----------------------------+---------------|
115
| input.frequency | Input line frequency (Hz) | 60.00 |
116
|---------------------------+----------------------------+---------------|
117
| input.transfer.boost.low | Low voltage boosting | 190 |
118
| | transfer point | |
119
|---------------------------+----------------------------+---------------|
120
| input.transfer.boost.high | High voltage boosting | 210 |
121
| | transfer point | |
122
|---------------------------+----------------------------+---------------|
123
| input.transfer.trim.low | Low voltage trimming | 230 |
124
| | transfer point | |
125
|---------------------------+----------------------------+---------------|
126
| input.transfer.trim.high | High voltage trimming | 240 |
127
| | transfer point | |
128
+------------------------------------------------------------------------+
129
130
output: Outgoing power/inverter information
131
132
+------------------------------------------------------------------------+
133
| output.voltage | Output voltage | 120.9 |
134
|-------------------------------+--------------------------------+-------|
135
| output.frequency | Output frequency (Hz) | 60 |
136
|-------------------------------+--------------------------------+-------|
137
| output.voltage.target.line | Target output voltage when on | 120 |
138
| | line | |
139
|-------------------------------+--------------------------------+-------|
140
| output.voltage.target.battery | Target output voltage when on | 120 |
141
| | battery | |
142
|-------------------------------+--------------------------------+-------|
143
| output.current | Output current (amps) | 4.25 |
144
+------------------------------------------------------------------------+
145
146
battery: Any battery details
147
148
+------------------------------------------------------------------------+
149
| battery.charge | Battery charge (percent) | 100.0 |
150
|-------------------------+------------------------------+---------------|
151
| battery.charge.low | Remaining battery level when | 20 |
152
| | UPS switches to LB (percent) | |
153
|-------------------------+------------------------------+---------------|
154
| battery.charge.restart | Minimum battery level for | 20 |
155
| | UPS restart after power-off | |
156
|-------------------------+------------------------------+---------------|
157
| battery.voltage | Battery charge (volts) | 24.84 |
158
|-------------------------+------------------------------+---------------|
159
| battery.current | Battery current (amps) | 1.19 |
160
|-------------------------+------------------------------+---------------|
161
| battery.temperature | Battery temperature (degrees | 050.7 |
162
| | C) | |
163
|-------------------------+------------------------------+---------------|
164
| battery.voltage.nominal | Nominal battery voltage | 024 |
165
|-------------------------+------------------------------+---------------|
166
| battery.runtime | Battery runtime (seconds) | 1080 |
167
|-------------------------+------------------------------+---------------|
168
| | Remaining battery runtime | |
169
| battery.runtime.low | when UPS switches to LB | 180 |
170
| | (seconds) | |
171
|-------------------------+------------------------------+---------------|
172
| battery.alarm.threshold | Battery alarm threshold | 0 (immediate) |
173
|-------------------------+------------------------------+---------------|
174
| battery.date | Battery change date (opaque | 11/14/00 |
175
| | string) | |
176
|-------------------------+------------------------------+---------------|
177
| battery.packs | Number of battery packs | 001 |
178
|-------------------------+------------------------------+---------------|
179
| battery.packs.bad | Number of bad battery packs | 000 |
180
+------------------------------------------------------------------------+
181
182
ambient: Conditions from external probe equipment
183
184
+------------------------------------------------------------------------+
185
| ambient.temperature | Ambient temperature | 25.40 |
186
| | (degrees C) | |
187
|-----------------------------------+----------------------------+-------|
188
| ambient.temperature.alarm | Set if ambient temperature | 0 |
189
| | alarm is active | |
190
|-----------------------------------+----------------------------+-------|
191
| ambient.temperature.alarm.maximum | Maximum allowed | NO,NO |
192
| | temperature (*** opaque) | |
193
|-----------------------------------+----------------------------+-------|
194
| ambient.temperature.alarm.minimum | Minimum allowed | NO,NO |
195
| | temperature (*** opaque) | |
196
|-----------------------------------+----------------------------+-------|
197
| ambient.temperature.alarm.enable | Enable alarm for ambient | 1 |
198
| | temperature | |
199
|-----------------------------------+----------------------------+-------|
200
| ambient.humidity | Ambient relative humidity | 038.8 |
201
| | (percent) | |
202
|-----------------------------------+----------------------------+-------|
203
| ambient.humidity.alarm | Set if ambient humidity | 0 |
204
| | alarm is active | |
205
|-----------------------------------+----------------------------+-------|
206
| ambient.humidity.alarm.maximum | Maximum allowed humidity | NO,NO |
207
| | (*** opaque) | |
208
|-----------------------------------+----------------------------+-------|
209
| ambient.humidity.alarm.minimum | Minimum allowed humidity | NO,NO |
210
| | (*** opaque) | |
211
|-----------------------------------+----------------------------+-------|
212
| ambient.humidity.alarm.enable | Enable alarm for ambient | 1 |
213
| | humidity | |
214
+------------------------------------------------------------------------+
215
216
output: Smart outlet management (smart on/off switch, ...)
217
218
+------------------------------------------------------------------------+
219
| | Outlet system | |
220
| outlet.n.id | identifier (opaque | 1 |
221
| | string) | |
222
|--------------------------------+-------------------------+-------------|
223
| outlet.n.desc | Outlet description | Main outlet |
224
| | (opaque string) | |
225
|--------------------------------+-------------------------+-------------|
226
| outlet.n.switch | Outlet switch control | on |
227
| | (on/off) | |
228
|--------------------------------+-------------------------+-------------|
229
| outlet.n.status | Outlet switch status | on |
230
| | (on/off) | |
231
|--------------------------------+-------------------------+-------------|
232
| outlet.n.switchable | Outlet switch ability | yes |
233
| | (yes/no) | |
234
|--------------------------------+-------------------------+-------------|
235
| | Remaining battery level | |
236
| outlet.n.autoswitch.charge.low | to power off this | 90 |
237
| | outlet (percent) | |
238
|--------------------------------+-------------------------+-------------|
239
| | Interval to wait before | |
240
| outlet.n.delay.shutdown | shutting down this | 180 |
241
| | outlet (seconds) | |
242
|--------------------------------+-------------------------+-------------|
243
| | Interval to wait before | |
244
| outlet.n.delay.start | restarting this outlet | 120 |
245
| | (seconds) | |
246
+------------------------------------------------------------------------+
247
248
driver: Internal driver information
249
250
+------------------------------------------------------------------------+
251
| driver.name | Driver name | apcsmart |
252
|-------------------------+----------------------------+-----------------|
253
| driver.version | Driver version (NUT | X.Y.Z |
254
| | release) | |
255
|-------------------------+----------------------------+-----------------|
256
| driver.version.internal | Internal driver version | 1.23.45 |
257
| | (if tracked separately) | |
258
|-------------------------+----------------------------+-----------------|
259
| driver.parameter.xxx | Parameter xxx (ups.conf or | (varies) |
260
| | cmdline -x) setting | |
261
|-------------------------+----------------------------+-----------------|
262
| driver.flag.xxx | Flag xxx (ups.conf or | enabled (or not |
263
| | cmdline -x) status | present) |
264
+------------------------------------------------------------------------+
265
266
server: Internal server information
267
268
+------------------------------------------------------------------------+
269
| server.info | Server | Network UPS Tools upsd vX.Y.Z - |
270
| | information | http://www.networkupstools.org/ |
271
|----------------+----------------+--------------------------------------|
272
| server.version | Server version | X.Y.Z |
351
273
+------------------------------------------------------------------------+
352
274
353
275
Instant commands
354
276
355
277
+------------------------------------------------------------------------+
356
| Old name | New name | Description | In |
357
| | | | cmd_map? |
358
|-----------+--------------------------+----------------------+----------|
359
| OFF | load.off | Turn off the load | yes |
360
| | | immediately | |
361
|-----------+--------------------------+----------------------+----------|
362
| ON | load.on | Turn on the load | yes |
363
| | | immediately | |
364
|-----------+--------------------------+----------------------+----------|
365
| | | Turn off the load | |
366
| SOFTDOWN | shutdown.return | possibly after a | yes |
367
| | | delay and return | |
368
| | | when power is back | |
369
|-----------+--------------------------+----------------------+----------|
370
| | | Turn off the load | |
371
| | | possibly after a | |
372
| SHUTDOWN | shutdown.stayoff | delay and remain off | yes |
373
| | | even if power | |
374
| | | returns | |
375
|-----------+--------------------------+----------------------+----------|
376
| STOPSHUTD | shutdown.stop | Stop a shutdown in | yes |
377
| | | progress | |
378
|-----------+--------------------------+----------------------+----------|
379
| | | Shut down the load | |
380
| n/a | shutdown.reboot | briefly while | yes |
381
| | | rebooting the UPS | |
382
|-----------+--------------------------+----------------------+----------|
383
| | | After a delay, shut | |
384
| n/a | shutdown.reboot.graceful | down the load | yes |
385
| | | briefly while | |
386
| | | rebooting the UPS | |
387
|-----------+--------------------------+----------------------+----------|
388
| FPTEST | test.panel.start | Start testing the | yes |
389
| | | UPS panel | |
390
|-----------+--------------------------+----------------------+----------|
391
| n/a | test.panel.stop | Stop a UPS panel | n/a |
392
| | | test | |
393
|-----------+--------------------------+----------------------+----------|
394
| SIMPWF | test.failure.start | Start a simulated | yes |
395
| | | power failure | |
396
|-----------+--------------------------+----------------------+----------|
397
| n/a | test.failure.stop | Stop simulating a | n/a |
398
| | | power failure | |
399
|-----------+--------------------------+----------------------+----------|
400
| BTEST1 | test.battery.start | Start a battery test | yes |
401
|-----------+--------------------------+----------------------+----------|
402
| BTEST0 | test.battery.stop | Stop the battery | yes |
403
| | | test | |
404
|-----------+--------------------------+----------------------+----------|
405
| CAL1 | calibrate.start | Start runtime | yes |
406
| | | calibration | |
407
|-----------+--------------------------+----------------------+----------|
408
| CAL0 | calibrate.stop | Stop runtime | yes |
409
| | | calibration | |
410
|-----------+--------------------------+----------------------+----------|
411
| BYPASS | bypass.start | Put the UPS in | yes |
412
| | | bypass mode | |
413
|-----------+--------------------------+----------------------+----------|
414
| n/a | bypass.stop | Take the UPS out of | n/a |
415
| | | bypass mode | |
416
|-----------+--------------------------+----------------------+----------|
417
| | | Reset minimum and | |
418
| n/a | reset.input.minmax | maximum input | n/a |
419
| | | voltage status | |
420
|-----------+--------------------------+----------------------+----------|
421
| | | Reset watchdog timer | |
422
| WATCHDOG | reset.watchdog | (forced reboot of | yes |
423
| | | load) | |
424
|-----------+--------------------------+----------------------+----------|
425
| n/a | beeper.on | Enable UPS | n/a |
426
| | | beeper/buzzer | |
427
|-----------+--------------------------+----------------------+----------|
428
| n/a | beeper.off | Disable UPS | n/a |
429
| | | beeper/buzzer | |
278
| Name | Description |
279
|--------------------------+---------------------------------------------|
280
| load.off | Turn off the load immediately |
281
|--------------------------+---------------------------------------------|
282
| load.on | Turn on the load immediately |
283
|--------------------------+---------------------------------------------|
284
| shutdown.return | Turn off the load possibly after a delay |
285
| | and return when power is back |
286
|--------------------------+---------------------------------------------|
287
| shutdown.stayoff | Turn off the load possibly after a delay |
288
| | and remain off even if power returns |
289
|--------------------------+---------------------------------------------|
290
| shutdown.stop | Stop a shutdown in progress |
291
|--------------------------+---------------------------------------------|
292
| shutdown.reboot | Shut down the load briefly while rebooting |
293
| | the UPS |
294
|--------------------------+---------------------------------------------|
295
| shutdown.reboot.graceful | After a delay, shut down the load briefly |
296
| | while rebooting the UPS |
297
|--------------------------+---------------------------------------------|
298
| test.panel.start | Start testing the UPS panel |
299
|--------------------------+---------------------------------------------|
300
| test.panel.stop | Stop a UPS panel test |
301
|--------------------------+---------------------------------------------|
302
| test.failure.start | Start a simulated power failure |
303
|--------------------------+---------------------------------------------|
304
| test.failure.stop | Stop simulating a power failure |
305
|--------------------------+---------------------------------------------|
306
| test.battery.start | Start a battery test |
307
|--------------------------+---------------------------------------------|
308
| test.battery.stop | Stop the battery test |
309
|--------------------------+---------------------------------------------|
310
| calibrate.start | Start runtime calibration |
311
|--------------------------+---------------------------------------------|
312
| calibrate.stop | Stop runtime calibration |
313
|--------------------------+---------------------------------------------|
314
| bypass.start | Put the UPS in bypass mode |
315
|--------------------------+---------------------------------------------|
316
| bypass.stop | Take the UPS out of bypass mode |
317
|--------------------------+---------------------------------------------|
318
| reset.input.minmax | Reset minimum and maximum input voltage |
319
| | status |
320
|--------------------------+---------------------------------------------|
321
| reset.watchdog | Reset watchdog timer (forced reboot of |
322
| | load) |
323
|--------------------------+---------------------------------------------|
324
| beeper.on | Enable UPS beeper/buzzer |
325
|--------------------------+---------------------------------------------|
326
| beeper.off | Disable UPS beeper/buzzer |
430
327
+------------------------------------------------------------------------+
Loggerhead is a web-based interface for Breezy
Version: 2.0.1