-
Notifications
You must be signed in to change notification settings - Fork 10
/
index.js
289 lines (262 loc) · 11 KB
/
index.js
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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
'use strict';
// Nut (Network UPS Tool) Platform for HomeBridge
//
// Remember to add platform to config.json. Example:
// "platforms": [
// {
// "platform": "Nut", // required
// "name": "Nut", // required - Used for platform logging tags.
// "host": "localhost", // Optional - defaults to localhost
// "port": "3493", // Optional - defaults to 3493
// "search_time_delay": "1", // Optional - defaults to 1 second. Initial search time delay in seconds.
// "acc_delay": "100", // Optional - defaults to 100. Time in milliseconds. Delay to prevent communication collisions for multiple UPS accessories.
// "low_batt_threshold": "40", // Optional - defaults to 40%. Low Battery Threshold.
// "polling": "120" // Optional - defaults to OFF or 0. Time in seconds.
// }
// ],
//
//
var Nut = require("node-nut");
var _ = require("underscore");
var sleep = require("system-sleep")
var titleCase = require('title-case');
var pNut, connected, started;
function NutPlatform(log, config){
this.config = config;
this.host = config["host"] || 'localhost';
this.port = config["port"] || '3493';
this.name = config["name"];
this.nutListTimeout = parseInt(config["search_time_delay"] || '1');
this.nutListTimeout *= 1000;
this.accDelay = parseInt(config["acc_delay"] || '100');
this.nutPolling = parseInt(config["polling"] || '0');
this.lowBattThreshold = config["low_batt_threshold"] || '40';
this.log = log;
this.log("Starting Nut Platform on %s:%s. Polling (seconds): %s", this.host, this.port, (this.nutPolling == '0') ? 'OFF' : this.nutPolling);
this.nutPolling *=1000;
this.initialized = false;
var nutAccessories, upsInfo;
connected = false;
started = true;
pNut = new Nut(this.port, this.host);
pNut.on('ready', this.eventReady.bind(this));
pNut.on('close', this.eventClose.bind(this));
pNut.on('error', this.eventError.bind(this));
pNut.start();
}
NutPlatform.prototype = {
accessories: function(callback) {
var that = this;
var foundAccessories = [];
var acc, accName, accFriendlyName;
sleep(this.nutListTimeout); // Wait for initial nut startup.
accName = _.keys(that.nutAccessories);
accFriendlyName = _.values(that.nutAccessories);
for (acc in accName) {
var titleName;
that.log("Received Nut accessory #%s %s (%s) from the %s platform.", acc, accName[acc], ((!accFriendlyName[acc]) ? 'NullDesc' : accFriendlyName[acc]), that.name);
that.getInfo(accName[acc], function(err, upsInfo) {
if (!err) {
titleName = titleCase((accFriendlyName[acc] || accName[acc])); //Added in case ups.conf description is empty.
var accessory = new NutAccessory(that, accName[acc], titleName, upsInfo, acc);
that.initialized = true;
foundAccessories.push(accessory);
} else {
that.log.error("Nut Error: %s", err);
}
});
sleep(this.accDelay); // Delay on each new accessory call to avoid collisions.
}
callback(foundAccessories);
},
eventReady: function() {
var that = this;
if (!that.initialized) {
connected = true;
this.log.debug("Nut eventReady received. Initializing and getting list of Nut accessories.");
pNut.GetUPSList(function(upslist, err) {
if (err) {
that.log.error;('Nut ERROR initializing: ' + err);
}
else {
that.nutAccessories = upslist;
}
});
} else {
connected = true;
this.log.debug("Nut eventReady received. Successful reconnect after disconnection.");
}
},
eventClose: function() {
var that = this;
connected = false;
started = false;
this.log.debug("Nut eventDisconnect occured.");
},
eventError: function(error) {
this.log.error("Nut eventError received - %s.", error);
},
getInfo: function(upsName, callback) {
var that = this;
if (connected) {
pNut.GetUPSVars(upsName, function(upsvars, err) {
if (err) {
callback("ERROR getting UPSVars: " + err, null);
} else {
callback(null, upsvars);
}
});
} else {
callback("ERROR not connected to Nut", null);
}
}
}
function NutAccessory(platform, accessory, accessoryFriendly, accessoryVars, accCount) {
this.nutName = accessory;
this.name = accessoryFriendly;
this.accVars = accessoryVars;
this.platform = platform;
this.log = this.platform.log;
this.lowBattThreshold = this.platform.lowBattThreshold;
this.delay = (parseInt(accCount)+1)*this.platform.accDelay;
this.log.debug("Nut Platform polling delay is: %s, Accessory %s delay is: %s", this.platform.nutPolling/1000, this.name, this.delay/1000);
if (this.platform.nutPolling > 0) {
var that = this;
setTimeout(function() {
that.log.debug('Nut Service Polling begin for %s...', that.name);
that.servicePolling();
}, this.platform.nutPolling);
};
}
NutAccessory.prototype = {
identify: function(callback){
this.log.debug("Nut Identify requested for %s!", this.name);
callback();
},
getCheck: function(callback){
var that = this;
this.log.debug('Nut checking connection to Nut Server for %s.', this.name);
if (connected) {
this.log.debug('Nut connection to Nut Server Successful.');
this.log.debug('Nut refreshing delay %s for %s', this.delay/1000, this.name);
sleep(parseInt(this.delay));
that.getVars(function(callback) {}.bind(this));
} else {
if (!started) {
started = true;
this.log.debug('Nut not connected, attempting reconnection.');
pNut.start();
sleep(this.platform.nutListTimeout);
} else {
this.log.debug('Nut not connected, waiting on prior reconnection attempt...');
}
this.log.debug('Nut refreshing delay %s for %s',this.delay/1000, this.name);
sleep(parseInt(this.delay));
if (connected) {
that.getVars(function (callback) {}.bind(that));
} else {
that.log.error('Nut unable to reconnect!');
that.service.setCharacteristic(Characteristic.StatusFault,1);
}
}
callback();
},
getVars: function(callback){
var that = this;
this.log.debug('Nut now getting vars for %s.', this.name);
if (connected) {
this.platform.getInfo(this.nutName, function(err, upsInfo) {
if (!err) {
this.log.debug('Nut now updating vars for %s.', this.name);
that.serviceInfo.setCharacteristic(Characteristic.Manufacturer, upsInfo["device.mfr"] || upsInfo["ups.vendorid"] || 'No Manufacturer');
that.serviceInfo.setCharacteristic(Characteristic.SerialNumber, upsInfo["ups.serial"] || 'No Serial#')
that.serviceInfo.setCharacteristic(Characteristic.Model, upsInfo["device.model"] || upsInfo["ups.productid"] || 'No Model#');
that.service.setCharacteristic(Characteristic.StatusFault,0);
that.serviceBatt.setCharacteristic(Characteristic.BatteryLevel,parseFloat(upsInfo["battery.charge"]));
that.service.setCharacteristic(EnterpriseTypes.InputVoltageAC, parseFloat(upsInfo["input.voltage"]));
that.service.setCharacteristic(EnterpriseTypes.OutputVoltageAC, parseFloat(upsInfo["output.voltage"]));
that.service.setCharacteristic(EnterpriseTypes.BatteryVoltageDC, parseFloat(upsInfo["battery.voltage"]));
that.service.setCharacteristic(EnterpriseTypes.UPSLoadPercent, parseInt(upsInfo["ups.load"]));
that.service.setCharacteristic(Characteristic.CurrentTemperature, parseFloat(upsInfo["ups.temperature"]));
if (parseInt(upsInfo["battery.charge"]) < parseInt(that.lowBattThreshold)) {
that.serviceBatt.setCharacteristic(Characteristic.StatusLowBattery,1);
} else {
that.serviceBatt.setCharacteristic(Characteristic.StatusLowBattery,0);
}
if (upsInfo["ups.status"] == "OL CHRG") {
that.serviceBatt.setCharacteristic(Characteristic.ChargingState,1);
} else if (upsInfo["ups.status"] == "OB DISCHRG") {
that.serviceBatt.setCharacteristic(Characteristic.ChargingState,2);
} else {
that.serviceBatt.setCharacteristic(Characteristic.ChargingState,0);
}
if (parseInt(upsInfo["ups.load"]) > 0) {
that.service.setCharacteristic(Characteristic.StatusActive,1);
} else {
that.service.setCharacteristic(Characteristic.StatusActive,0);
}
if (upsInfo["ups.status"].startsWith("OB")) {
that.service.setCharacteristic(Characteristic.ContactSensorState,1);
} else {
that.service.setCharacteristic(Characteristic.ContactSensorState,0);
}
} else {
that.log.error("Nut Error: %s", err);
that.service.setCharacteristic(Characteristic.StatusFault,1);
}
}.bind(this));
} else {
this.log.error('Nut request failed. Not connected.');
that.service.setCharacteristic(Characteristic.StatusFault,1);
}
callback();
},
servicePolling: function(){
var that = this;
this.log.debug('Nut is Polling for %s with polling delay of %s seconds.', this.name, that.platform.nutPolling/1000);
this.getCheck(function (callback) {
setTimeout(function() {
that.servicePolling();
}, that.platform.nutPolling);
});
},
getServices: function() {
var that = this;
var services = []
this.service = new Service.ContactSensor(this.name);
this.service.getCharacteristic(Characteristic.ContactSensorState) // Based on ups.status
.on('get', this.getCheck.bind(this));;
this.service.addCharacteristic(Characteristic.StatusActive); // Has load (being used)
this.service.addCharacteristic(Characteristic.StatusFault); // Used if unable to connect to Nut Server
this.service.addCharacteristic(Characteristic.CurrentTemperature);
this.service.addCharacteristic(EnterpriseTypes.InputVoltageAC);
this.service.addCharacteristic(EnterpriseTypes.OutputVoltageAC);
this.service.addCharacteristic(EnterpriseTypes.BatteryVoltageDC);
this.service.addCharacteristic(EnterpriseTypes.UPSLoadPercent);
services.push(this.service);
this.serviceInfo = new Service.AccessoryInformation();
this.serviceInfo.setCharacteristic(Characteristic.Manufacturer, this.accVars["device.mfr"] || this.accVars["ups.vendorid"] || 'No Manufacturer')
.setCharacteristic(Characteristic.Name, this.name)
.setCharacteristic(Characteristic.SerialNumber, this.accVars["ups.serial"] || 'No Serial#')
.setCharacteristic(Characteristic.FirmwareRevision, this.accVars["ups.firmware"] || 'No Data')
.setCharacteristic(Characteristic.Model, this.accVars["device.model"].trim() || this.accVars["ups.productid"] || 'No Model#');
services.push(this.serviceInfo);
this.serviceBatt = new Service.BatteryService();
this.serviceBatt.setCharacteristic(Characteristic.BatteryLevel, this.accVars["battery.charge"])
.setCharacteristic(Characteristic.Name, this.name)
.setCharacteristic(Characteristic.ChargingState, 0)
.setCharacteristic(Characteristic.StatusLowBattery, 0);
services.push(this.serviceBatt);
return services;
}
}
module.exports.accessory = NutAccessory;
module.exports.platform = NutPlatform;
var Service, Characteristic, EnterpriseTypes;
module.exports = function(homebridge) {
Service = homebridge.hap.Service;
Characteristic = homebridge.hap.Characteristic;
EnterpriseTypes = require('./types.js')(homebridge);
homebridge.registerAccessory("homebridge-nut-accessory", "NutAccessory", NutAccessory);
homebridge.registerPlatform("homebridge-nut", "Nut", NutPlatform);
};