forked from networkupstools/nut
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdummy-ups.h
243 lines (222 loc) · 9.32 KB
/
dummy-ups.h
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/* dummy-ups.h - NUT testing driver and repeater
Copyright (C)
2005 - 2012 Arnaud Quette <http://arnaud.quette.free.fr/contact.html>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef NUT_DUMMY_UPS_H_SEEN
#define NUT_DUMMY_UPS_H_SEEN 1
/* This file lists all valid data with their type and info.
*
* These are then enabled through a definition file, specified
* as the "port" parameter (only the file name, not the path).
*
* The format of this file is the same as an upsc dump:
*
* <varname>: <value>
*
* FIXME: use cmdvartab for conformance checking
* ...
* Once the driver is loaded:
* - change the value by using upsrw
* - ?you can add new variables and change variable values by
* editing the definition file?
*/
/* from usbhid-ups.h */
/* --------------------------------------------------------------- */
/* Struct & data for ups.status processing */
/* --------------------------------------------------------------- */
#if 0 /* XXX status lookup table not currently used???? */
/*
* Status lookup table type definition
*/
typedef struct {
const char *status_str; /* ups.status string */
int status_value; /* ups.status flag bit */
} status_lkp_t;
#define STATUS_CAL (1 << 0) /* calibration */
#define STATUS_TRIM (1 << 1) /* SmartTrim */
#define STATUS_BOOST (1 << 2) /* SmartBoost */
#define STATUS_OL (1 << 3) /* on line */
#define STATUS_OB (1 << 4) /* on battery */
#define STATUS_OVER (1 << 5) /* overload */
#define STATUS_LB (1 << 6) /* low battery */
#define STATUS_RB (1 << 7) /* replace battery */
#define STATUS_BYPASS (1 << 8) /* on bypass */
#define STATUS_OFF (1 << 9) /* ups is off */
#define STATUS_CHRG (1 << 10) /* charging */
#define STATUS_DISCHRG (1 << 11) /* discharging */
/*
* Status lookup table
*/
status_lkp_t status_info[] = {
{ "CAL", STATUS_CAL },
{ "TRIM", STATUS_TRIM },
{ "BOOST", STATUS_BOOST },
{ "OL", STATUS_OL },
{ "OB", STATUS_OB },
{ "OVER", STATUS_OVER },
{ "LB", STATUS_LB },
{ "RB", STATUS_RB },
{ "BYPASS", STATUS_BYPASS },
{ "OFF", STATUS_OFF },
{ "CHRG", STATUS_CHRG },
{ "DISCHRG", STATUS_DISCHRG },
{ "NULL", 0 },
};
#endif /* 0 -- not currently used??? */
typedef struct {
char hid_value; /* HID value */
char *nut_value; /* NUT value */
} info_enum_t;
/* --------------------------------------------------------------- */
/* Structure containing information about how to get/set data */
/* from/to the UPS and convert these to/from NUT standard */
/* --------------------------------------------------------------- */
typedef struct {
const char *info_type; /* NUT variable name */
int info_flags; /* NUT flags (to set in addinfo) */
float info_len; /* if ST_FLAG_STRING: length of the string */
/* if HU_TYPE_CMD: command value ; multiplier (or max len) otherwise */
const char *default_value; /* if HU_FLAG_ABSENT: default value ; format otherwise */
int drv_flags; /* */
char **var_values; /* all possible values for this variable (allows to check data...) */
/* FIXME: "void *" so we can have bound or enum */
/* interpreter interpret; */ /* FFE: interpreter fct, NULL if not needed */
} dummy_info_t;
/* data flags */
#define DU_FLAG_NONE 0
#define DU_FLAG_INIT 1 /* intialy show element to upsd */
/* --------------------------------------------------------------- */
/* Data table (all possible info from NUT, then enable upon cong */
/* --------------------------------------------------------------- */
/* FIXME: need to enforce value check with enum or bounds */
/* This array is only used from dummy-ups.c (there's a namesake
* for apcupsd-ups.c defined elsewhere) */
static dummy_info_t nut_data[] =
{
/* Essential variables, loaded before parsing the definition file */
{ "ups.mfr", ST_FLAG_STRING | ST_FLAG_RW, 32, "Dummy Manufacturer", DU_FLAG_INIT, NULL },
{ "ups.model", ST_FLAG_STRING | ST_FLAG_RW, 32, "Dummy UPS", DU_FLAG_INIT, NULL },
{ "ups.status", ST_FLAG_STRING | ST_FLAG_RW, 32, "OL", DU_FLAG_INIT, NULL },
/* Other known variables */
{ "ups.serial", ST_FLAG_STRING | ST_FLAG_RW, 32, NULL, DU_FLAG_NONE, NULL },
{ "ups.load", ST_FLAG_RW, 32, NULL, DU_FLAG_NONE, NULL },
{ "ups.alarm", ST_FLAG_STRING | ST_FLAG_RW, 32, NULL, DU_FLAG_NONE, NULL },
{ "ups.time", ST_FLAG_STRING | ST_FLAG_RW, 16, NULL, DU_FLAG_NONE, NULL },
{ "ups.date", ST_FLAG_STRING | ST_FLAG_RW, 16, NULL, DU_FLAG_NONE, NULL },
{ "ups.mfr.date", ST_FLAG_STRING | ST_FLAG_RW, 16, NULL, DU_FLAG_NONE, NULL },
{ "ups.serial", ST_FLAG_STRING | ST_FLAG_RW, 16, NULL, DU_FLAG_NONE, NULL },
{ "ups.firmware", ST_FLAG_STRING | ST_FLAG_RW, 16, NULL, DU_FLAG_NONE, NULL },
{ "ups.firmware.aux", ST_FLAG_STRING | ST_FLAG_RW, 16, NULL, DU_FLAG_NONE, NULL },
{ "ups.temperature", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ups.id", ST_FLAG_STRING | ST_FLAG_RW, 16, NULL, DU_FLAG_NONE, NULL },
{ "ups.delay.start", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ups.delay.reboot", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ups.delay.shutdown", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ups.test.interval", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ups.test.result", ST_FLAG_STRING | ST_FLAG_RW, 16, NULL, DU_FLAG_NONE, NULL },
/*
ups.display.language
ups.contacts
ups.power
ups.power.nominal
*/
{ "input.voltage", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.voltage.maximum", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.voltage.minimum", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.voltage.nominal", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.transfer.reason", ST_FLAG_STRING | ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.transfer.low", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.transfer.high", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.sensitivity", ST_FLAG_STRING | ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.quality", ST_FLAG_STRING | ST_FLAG_RW, 6, NULL, DU_FLAG_NONE, NULL },
{ "input.frequency", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.transfer.boost.low", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.transfer.boost.high", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.transfer.trim.low", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "input.transfer.trim.high", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "output.voltage", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "output.frequency", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "output.current", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
/*
output.voltage.nominal
*/
{ "battery.charge", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "battery.charge.low", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "battery.voltage", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "battery.current", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "battery.runtime", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "battery.runtime.low", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "battery.charge.restart", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "battery.temperature", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "battery.voltage.nominal", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
/*
battery.alarm.threshold
battery.date
battery.packs
battery.packs.bad
*/
{ "ambient.temperature", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ambient.temperature.alarm", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ambient.temperature.high", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ambient.temperature.low", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ambient.humidity", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ambient.humidity.alarm", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ambient.humidity.high", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
{ "ambient.humidity.low", ST_FLAG_RW, 1, NULL, DU_FLAG_NONE, NULL },
/*
FIXME: how to manage these? (i.e. index <n>)
outlet.n.id
outlet.n.desc
outlet.n.switch
outlet.n.status
outlet.n.switchable
outlet.n.autoswitch.charge.low
outlet.n.delay.shutdown
outlet.n.delay.start
...
driver.name
driver.version
driver.version.internal | Internal driver version | 1.23.45 |
driver.parameter.xxx
driver.flag.xxx
No need for these!
server.info
server.version
Cmds
load.off
load.on
shutdown.return
shutdown.stayoff
shutdown.stop
shutdown.reboot
shutdown.reboot.graceful
test.panel.start
test.panel.stop
test.failure.start
test.failure.stop
test.battery.start
test.battery.stop
calibrate.start
calibrate.stop
bypass.start
bypass.stop
reset.input.minmax
reset.watchdog
beeper.enable
beeper.disable
*/
/* end of structure. */
{ NULL, 0, 0, NULL, DU_FLAG_NONE, NULL }
};
#endif /* NUT_DUMMY_UPS_H_SEEN */