-
Notifications
You must be signed in to change notification settings - Fork 0
/
solarview.coffee
370 lines (321 loc) · 11.3 KB
/
solarview.coffee
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# #SolarView plugin
module.exports = (env) ->
# Require the bluebird promise library
Promise = env.require 'bluebird'
# Require the Node.js net API
net = require 'net'
# Require pimatic-plugin-commons for common helper functions
commons = require('pimatic-plugin-commons')(env)
# ###SolarViewPlugin class
class SolarViewPlugin extends env.plugins.Plugin
# ####init()
# The `init` function is called by the framework to ask your plugin to initialise.
#
# #####params:
# * `app` is the [express] instance the framework is using.
# * `framework` the framework itself
# * `config` the properties the user specified as config for your plugin in the `plugins`
# section of the config.json file
#
#
init: (app, @framework, @config) =>
# register devices
deviceConfigDef = require("./device-config-schema")
@framework.deviceManager.registerDeviceClass("SolarViewInverterSimple", {
configDef: deviceConfigDef.SolarViewInverterSimple,
createCallback: (config, lastState) =>
return new SolarViewInverterSimpleDevice(config, this, lastState)
})
@framework.deviceManager.registerDeviceClass("SolarViewInverter", {
configDef: deviceConfigDef.SolarViewInverter,
createCallback: (config, lastState) =>
return new SolarViewInverterDevice(config, this, lastState)
})
@framework.deviceManager.registerDeviceClass("SolarViewInverterWithMPPTracker", {
configDef: deviceConfigDef.SolarViewInverterWithMPPTracker,
createCallback: (config, lastState) =>
return new SolarViewInverterWithMPPTrackerDevice(config, this, lastState)
})
class SolarViewInverterBaseDevice extends env.devices.Device
# Initialize device by reading entity definition from middleware
constructor: (@config, plugin, lastState) ->
@debug = plugin.config.debug || false
@_base = commons.base @, @config.class
@_base.debug("SolarViewInverterBaseDevice Initialization")
@host = plugin.config.host
@port = plugin.config.port
@id = @config.id
@name = @config.name
@interval = @_base.normalize 10000, 1000 * (@config.interval or plugin.config.interval or 10)
@timeout = Math.min @interval, 20000
@inverterId = @config.inverterId
@fetchPromise = Promise.resolve()
process.nextTick () =>
@requestUpdate()
super()
destroy: () ->
@_base.cancelUpdate()
@fetchPromise.cancel()
super()
fetchData: (host, port, inverterId) ->
return @fetchPromise = new Promise (resolve, reject) =>
@_base.debug "Trying to connect to #{@host}:#{@port}"
socket = net.createConnection port, host
socket.setNoDelay true
socket.setTimeout @timeout
socket.once 'connect', (() =>
@_base.debug("Connected to #{host}:#{port}.")
socket.write "0" + inverterId + "*\r\n"
)
socket.once 'close', (() =>
@_base.debug("Socket closed")
if @fetchPromise.isPending()
@_base.rejectWithErrorString reject, "No data received from server"
)
socket.on 'data', ((data) =>
@_base.debug("Received raw data:", data)
rawData = data.toString 'utf8'
values = rawData.split ","
if values.length >= 20
@_base.resetLastError()
@emit "solarViewData", values
socket.destroy()
resolve()
)
socket.on 'error', ((error) =>
if error.code == 'ETIMEDOUT'
newError = "Timeout fetching SolarView data"
else
newError = "Error fetching SolarView data: " + error.toString()
socket.destroy()
@_base.rejectWithErrorString reject, newError
)
socket.once 'timeout', () =>
socket.destroy()
@_base.rejectWithErrorString reject, "Timeout fetching SolarView data"
# poll device according to interval
requestUpdate: ->
@fetchData(@host, @port, @inverterId)
.catch (error) =>
@_base.error error
.finally () =>
@_base.scheduleUpdate @requestUpdate, @interval
class SolarViewInverterSimpleDevice extends SolarViewInverterBaseDevice
# attributes
attributes:
energyToday:
description: "Energy Yield Today"
type: "number"
unit: 'kWh'
acronym: 'KDY'
energyMonth:
description: "Energy Yield of Current Month"
type: "number"
unit: 'kWh'
acronym: 'KMT'
energyYear:
description: "Energy Yield of Current Year"
type: "number"
unit: 'kWh'
acronym: 'KYR'
energyTotal:
description: "Energy Yield Total"
type: "number"
unit: 'kWh'
acronym: 'KT0'
currentPower:
description: "AC Power"
type: "number"
unit: 'W'
acronym: 'PAC'
_energyToday: 0.0
_energyMonth: 0.0
_energyYear: 0.0
_energyTotal: 0.0
_currentPower: 0.0
# Initialize device by reading entity definition from middleware
constructor: (@config, plugin, lastState) ->
super(@config, plugin, lastState)
@_base.debug("SolarViewInverterSimpleDevice Initialization")
@_energyMonth = lastState.energyMonth.value if lastState?.energyMonth?
@_energyYear = lastState.energyYear.value if lastState?.energyYear?
@_energyTotal = lastState.energyTotal.value if lastState?.energyTotal?
@on 'solarViewData', ((values) ->
@_base.setAttribute('energyToday', Number values[6])
@_base.setAttribute('energyMonth', Number values[7])
@_base.setAttribute('energyYear', Number values[8])
@_base.setAttribute('energyTotal', Number values[9])
@_base.setAttribute('currentPower', Number values[10])
)
destroy: () ->
super()
getEnergyToday: -> Promise.resolve @_energyToday
getEnergyMonth: -> Promise.resolve @_energyMonth
getEnergyYear: -> Promise.resolve @_energyYear
getEnergyTotal: -> Promise.resolve @_energyTotal
getCurrentPower: -> Promise.resolve @_currentPower
class SolarViewInverterDevice extends SolarViewInverterSimpleDevice
# attributes
attributes:
energyToday:
description: "Energy Yield Today"
type: "number"
unit: 'kWh'
acronym: 'KDY'
energyMonth:
description: "Energy Yield of Current Month"
type: "number"
unit: 'kWh'
acronym: 'KMT'
energyYear:
description: "Energy Yield if Current Year"
type: "number"
unit: 'kWh'
acronym: 'KYR'
energyTotal:
description: "Energy Yield Total"
type: "number"
unit: 'kWh'
acronym: 'KT0'
currentPower:
description: "AC Power"
type: "number"
unit: 'W'
acronym: 'PAC'
gridVoltage:
description: "Grid Voltage"
type: "number"
unit: 'V'
acronym: 'UL1'
gridAmperage:
description: "Grid Amperage"
type: "number"
unit: 'A'
acronym: 'IL2'
inverterTemperature:
description: "Inverter Temperature"
type: "number"
unit: '°C'
acronym: 'TKK'
_gridVoltage: 0.0
_gridAmperage: 0.0
_inverterTemperature: 0.0
# Initialize device by reading entity definition from middleware
constructor: (@config, plugin, lastState) ->
super(@config, plugin, lastState)
@_base.debug("SolarViewInverterDevice Initialization")
@on 'solarViewData', ((values) ->
@_base.setAttribute('gridVoltage', Number values[17])
@_base.setAttribute('gridAmperage', Number values[18])
@_base.setAttribute('inverterTemperature', Number values[19].replace /}+$/g, "")
)
destroy: () ->
super()
getGridVoltage: -> Promise.resolve @_gridVoltage
getGridAmperage: -> Promise.resolve @_gridAmperage
getInverterTemperature: -> Promise.resolve @_inverterTemperature
class SolarViewInverterWithMPPTrackerDevice extends SolarViewInverterDevice
# base class attributes
attributes:
energyToday:
description: "Energy Yield Today"
type: "number"
unit: 'kWh'
acronym: 'KDY'
energyMonth:
description: "Energy Yield of Current Month"
type: "number"
unit: 'kWh'
acronym: 'KMT'
energyYear:
description: "Energy Yield if Current Year"
type: "number"
unit: 'kWh'
acronym: 'KYR'
energyTotal:
description: "Energy Yield Total"
type: "number"
unit: 'kWh'
acronym: 'KT0'
currentPower:
description: "AC Power"
type: "number"
unit: 'W'
acronym: 'PAC'
gridVoltage:
description: "Grid Voltage"
type: "number"
unit: 'V'
acronym: 'UL1'
gridAmperage:
description: "Grid Amperage"
type: "number"
unit: 'A'
acronym: 'IL2'
# derived class attributes
inverterTemperature:
description: "Inverter Temperature"
type: "number"
unit: '°C'
acronym: 'TKK'
dcVoltageStringA:
description: "DC Voltage of String A"
type: "number"
unit: 'V'
acronym: 'UDC'
dcVoltageStringB:
description: "DC Voltage of String B"
type: "number"
unit: 'V'
acronym: 'UDCB'
dcVoltageStringC:
description: "DC Voltage of String C"
type: "number"
unit: 'V'
acronym: 'UDCC'
dcAmperageStringA:
description: "DC Power of String A"
type: "number"
unit: 'A'
acronym: 'IDC'
dcAmperageStringB:
description: "DC Power of String B"
type: "number"
unit: 'A'
acronym: 'IDCB'
dcAmperageStringC:
description: "DC Power of String C"
type: "number"
unit: 'A',
acronym: 'IDCC'
_dcVoltageStringA: 0.0
_dcVoltageStringB: 0.0
_dcVoltageStringC: 0.0
_dcAmperageStringA: 0.0
_dcAmperageStringB: 0.0
_dcAmperageStringC: 0.0
# Initialize device by reading entity definition from middleware
constructor: (@config, plugin, lastState) ->
super(@config, plugin, lastState)
@_base.debug("SolarViewInverterWithMPPTrackerDevice Initialization")
@on 'solarViewData', ((values) ->
@_base.setAttribute('dcVoltageStringA', Number values[11])
@_base.setAttribute('dcAmperageStringA', Number values[12])
@_base.setAttribute('dcVoltageStringB', Number values[13])
@_base.setAttribute('dcAmperageStringB', Number values[14])
@_base.setAttribute('dcVoltageStringC', Number values[15])
@_base.setAttribute('dcAmperageStringC', Number values[16])
)
destroy: () ->
super()
getDcVoltageStringA: -> Promise.resolve @_dcVoltageStringA
getDcVoltageStringB: -> Promise.resolve @_dcVoltageStringB
getDcVoltageStringC: -> Promise.resolve @_dcVoltageStringC
getDcAmperageStringA: -> Promise.resolve @_dcAmperageStringA
getDcAmperageStringB: -> Promise.resolve @_dcAmperageStringB
getDcAmperageStringC: -> Promise.resolve @_dcAmperageStringC
# ###Finally
# Create a instance of my plugin
myPlugin = new SolarViewPlugin
# and return it to the framework.
return myPlugin