node-red-contrib-waveshare-shield-adda-11010
Loading...
Searching...
No Matches
waveshare-shield-adda-11010.js
Go to the documentation of this file.
1// waveshare-shield-adda-11010.js
2//
3// Copyright (c) 2020-2022 Spring City Solutions LLC and other contributors
4// Licensed under the Apache License, Version 2.0
5// WAVESHARE (tm) is a trademark of Shenzhen Weixue Electronic Co., Ltd.
6//
7// Hardware Links:
8//
9// Board Manufacturer Store:
10// https://www.waveshare.com/High-Precision-AD-DA-Board.htm
11//
12// Board Manufacturer Wiki:
13// https://www.waveshare.com/wiki/High-Precision_AD/DA_Board
14//
15// Links for ADS1256 chip:
16// https://www.ti.com/product/ADS1256
17// https://www.ti.com/lit/gpn/ads1256
18// Book "Fundamentals of Precision ADC Noise Analysis" https://www.ti.com/lit/pdf/slyy192
19// Journal Series "How delta-sigma ADCs work" https://www.ti.com/lit/pdf/slyt423 https://www.ti.com/lit/pdf/slyt438
20// App Note "Digital Filter Types in Delta-Sigma ADCs" https://www.ti.com/lit/pdf/sbaa230
21//
22// Link for LM285 chip, connected to the ADS1256:
23// https://www.ti.com/product/LM285-2.5-N
24// https://www.ti.com/lit/gpn/lm285-2.5-n
25//
26// Link for DAC8532 chip:
27// https://www.ti.com/product/DAC8532
28// https://www.ti.com/lit/gpn/dac8532
29//
30// Spring City Solutions Links:
31//
32// Spring City Solutions Node-RED project page:
33// https://www.springcitysolutions.com/nodered
34//
35// Spring City Solutions page for this node:
36// https://www.springcitysolutions.com/nodered-waveshare-adda-shield
37//
38// Spring City Solutions Node-RED project email:
39// nodered@springcitysolutions.com
40//
41// Spring City Solutions Gitlab for this node:
42// https://gitlab.com/SpringCitySolutionsLLC/waveshare-shield-adda-11010
43//
44// Patreon Page:
45// https://www.patreon.com/springcitysolutions_nodered
46//
47// Software Links:
48//
49// Spring City Solutions Gitlab for this node:
50// https://gitlab.com/SpringCitySolutionsLLC/waveshare-shield-adda-11010
51//
52// Doxygen docs for this node autogenerated by Gitlab CI/CD:
53// https://springcitysolutionsllc.gitlab.io/waveshare-shield-adda-11010/index.html
54//
55// npmjs for this node:
56// https://npmjs.org/package/node-red-contrib-waveshare-shield-adda-11010
57//
58// Node-RED flows for this node:
59// https://flows.nodered.org/node/node-red-contrib-waveshare-shield-adda-11010
60//
61// Documentation Links:
62//
63// Gitlab wiki for this node (the master copy of list of links is here):
64// https://gitlab.com/SpringCitySolutionsLLC/waveshare-shield-adda-11010/-/wikis/home
65//
66// Waveshare's libraries for this hardware:
67// https://github.com/waveshare/High-Precision-AD-DA-Board
68//
69// Youtube video "How to set up":
70// TODO
71//
72// Youtube video "How to use":
73// TODO
74//
75// Youtube video "Testing Results":
76// TODO
77//
78module.exports = function (RED) {
79 'use strict'
80
81 const path = require('path')
82
83 // Static security scans trigger on child_process.
84 // I am careful to sanitize user input so we are OK.
85 const execSync = require('child_process').execSync
86
87 const testCommand = path.join(__dirname, 'library-test.py')
88 const adcCommand = path.join(__dirname, 'ads1256.py')
89 const dacCommand = path.join(__dirname, 'dac8532.py')
90 const gpioCommand = path.join(__dirname, 'gpio.py')
91
92 let allOK = true
93
94 try {
95 execSync(testCommand)
96 } catch (err) {
97 allOK = false
98 RED.log.warn('waveshare-shield-adda-11010 : ' + RED._('waveshare-shield-adda-11010.errors.libnotfound'))
99 }
100
101 // the magic to make python print stuff immediately
102 process.env.PYTHONUNBUFFERED = 1
103
104 function analoginput (n) {
105 RED.nodes.createNode(this, n)
106 this.out = n.out || 'out'
107 const node = this
108 let out = ''
109 this.scale = n.scale
110 this.gain = n.gain
111 this.port_p = n.port_p
112 this.port_n = n.port_n
113 this.rate = n.rate
114 this.buffer = n.buffer
115 this.sdcs = n.sdcs
116
117 function inputlistener (msg, send, done) {
118 try {
119 switch (node.port_p) {
120 case 'fsc':
121 out = execSync(adcCommand + ' --mode calibrationFSC').toString()
122 break
123 case 'ofc':
124 out = execSync(adcCommand + ' --mode calibrationOFC').toString()
125 break
126 default:
127 out = execSync(adcCommand + ' --mode analog --port_p ' + node.port_p + ' --port_n ' + node.port_n + ' --gain ' + node.gain + ' --rate ' + node.rate + ' --buffer ' + node.buffer + ' --sdcs ' + node.sdcs).toString()
128 }
129 } catch (err) {
130 allOK = false
131 node.status({ fill: 'red', shape: 'ring', text: 'waveshare-shield-adda-11010.status.not-running' })
132 RED.log.warn('waveshare-shield-adda-11010 : ' + RED._('waveshare-shield-adda-11010.errors.ads1256failure'))
133 }
134 const scaledOut = Number(out) / 1677721.5
135 // if (scaledOut < 0) {
136 // allOK = false
137 // node.status({ fill: 'red', shape: 'ring', text: 'waveshare-shield-adda-11010.status.not-running' })
138 // RED.log.warn('waveshare-shield-adda-11010 : ' + RED._('waveshare-shield-adda-11010.errors.ads1256failure'))
139 // } else {
140 if (1) {
141 if (node.scale === 'voltage') {
142 msg.payload = Number(out) / 1677721.5 / node.gain
143 }
144 if (node.scale === 'millivolt') {
145 msg.payload = scaledOut * 1000.0 / node.gain
146 }
147 if (node.scale === 'fraction') {
148 msg.payload = Number(out) / 8388607.0
149 }
150 if (node.scale === 'percentage') {
151 msg.payload = Number(out) / 83886.07
152 }
153 if (node.scale === 'counts') {
154 msg.payload = Number(out)
155 }
156 if (node.port_p === 'fsc') {
157 msg.payload = Number(out)
158 }
159 if (node.port_p === 'ofc') {
160 msg.payload = Number(out)
161 }
162 node.send(msg)
163 if (RED.settings.verbose) { node.log('analog out: ' + msg.payload) }
164 node.status({ fill: 'green', shape: 'dot', text: msg.payload.toString() })
165 }
166 if (done) { done() }
167 }
168 if (allOK === true) {
169 node.running = true
170 node.on('input', inputlistener)
171 } else {
172 node.status({ fill: 'grey', shape: 'dot', text: 'waveshare-shield-adda-11010.status.not-available' })
173 node.on('input', function (msg) {
174 node.status({ fill: 'grey', shape: 'dot', text: RED._('waveshare-shield-adda-11010.status.na', { value: msg.payload.toString() }) })
175 })
176 }
177
178 node.on('close', function (done) {
179 node.status({ fill: 'grey', shape: 'ring', text: 'waveshare-shield-adda-11010.status.closed' })
180 done()
181 })
182 }
183 RED.nodes.registerType('analoginput', analoginput)
184
185 function analogoutput (n) {
186 RED.nodes.createNode(this, n)
187 this.scale = n.scale
188 this.port = n.port
189 this.vref = n.vref
190 this.out = n.out || 'out'
191 const node = this
192
193 function inputlistener (msg, send, done) {
194 let out = Number(msg.payload)
195 if (node.scale === 'voltage') {
196 if (node.vref === 'vref-33') { out = 19859.4 * out };
197 if (node.vref === 'vref-50') { out = 13107.2 * out };
198 }
199 if (node.scale === 'millivolt') {
200 if (node.vref === 'vref-33') { out = 19859400 * out };
201 if (node.vref === 'vref-50') { out = 13107200 * out };
202 }
203 if (node.scale === 'fraction') {
204 out = out * 65535
205 }
206 if (node.scale === 'percentage') {
207 out = out * 655.35
208 }
209 if (out < 0) { out = 0 };
210 if (out > 65535) { out = 65535 };
211 out = parseInt(out).toString()
212 if (RED.settings.verbose) { node.log('analogoutput out: ' + out) }
213 node.status({ fill: 'green', shape: 'dot', text: msg.payload.toString() })
214 try {
215 execSync(dacCommand + ' --port ' + node.port + ' --output ' + out)
216 } catch (err) {
217 allOK = false
218 node.status({ fill: 'red', shape: 'ring', text: 'waveshare-shield-adda-11010.status.not-running' })
219 RED.log.warn('waveshare-shield-adda-11010 : ' + RED._('waveshare-shield-adda-11010.errors.dac8532failure'))
220 }
221 if (done) { done() }
222 }
223
224 if (allOK === true) {
225 node.running = true
226 node.on('input', inputlistener)
227 } else {
228 node.status({ fill: 'grey', shape: 'dot', text: 'waveshare-shield-adda-11010.status.not-available' })
229 node.on('input', function (msg) {
230 node.status({ fill: 'grey', shape: 'dot', text: RED._('waveshare-shield-adda-11010.status.na', { value: msg.payload.toString() }) })
231 })
232 }
233
234 node.on('close', function (done) {
235 node.status({ fill: 'grey', shape: 'ring', text: 'waveshare-shield-adda-11010.status.closed' })
236 execSync(dacCommand + ' --port A' + ' --output 0')
237 execSync(dacCommand + ' --port B' + ' --output 0')
238 done()
239 })
240 }
241
242 RED.nodes.registerType('analogoutput', analogoutput)
243
244 function gpioinput (n) {
245 RED.nodes.createNode(this, n)
246 this.out = n.out || 'out'
247 const node = this
248 let out = ''
249 this.port = n.port
250
251 function inputlistener (msg, send, done) {
252 try {
253 switch (node.port) {
254 case 'D0':
255 case 'D1':
256 case 'D2':
257 case 'D3':
258 out = execSync(adcCommand + ' --mode digitalIn --pin ' + node.port).toString()
259 break
260 case 'P22':
261 case 'P23':
262 case 'P24':
263 case 'P25':
264 out = execSync(gpioCommand + ' --pin ' + node.port).toString()
265 break
266 }
267 } catch (err) {
268 allOK = false
269 node.status({ fill: 'red', shape: 'ring', text: 'waveshare-shield-adda-11010.status.not-running' })
270 RED.log.warn('waveshare-shield-adda-11010 : ' + RED._('waveshare-shield-adda-11010.errors.gpiofailure'))
271 }
272 msg.payload = Number(out)
273 node.send(msg)
274 if (RED.settings.verbose) { node.log('gpio input: ' + msg.payload) }
275 node.status({ fill: 'green', shape: 'dot', text: msg.payload.toString() })
276 if (done) { done() }
277 }
278 if (allOK === true) {
279 node.running = true
280 node.on('input', inputlistener)
281 } else {
282 node.status({ fill: 'grey', shape: 'dot', text: 'waveshare-shield-adda-11010.status.not-available' })
283 node.on('input', function (msg) {
284 node.status({ fill: 'grey', shape: 'dot', text: RED._('waveshare-shield-adda-11010.status.na', { value: msg.payload.toString() }) })
285 })
286 }
287 node.on('close', function (done) {
288 node.status({ fill: 'grey', shape: 'ring', text: 'waveshare-shield-adda-11010.status.closed' })
289 done()
290 })
291 }
292 RED.nodes.registerType('gpioinput', gpioinput)
293
294 function gpiooutput (n) {
295 RED.nodes.createNode(this, n)
296 this.scale = n.scale
297 this.out = n.out || 'out'
298 const node = this
299 this.port = n.port
300
301 function inputlistener (msg, send, done) {
302 let out = Number(msg.payload)
303 if (out < 0) { out = 0 };
304 if (out > 1) { out = 1 };
305 out = parseInt(out).toString()
306 if (RED.settings.verbose) { node.log('gpio output: ' + out) }
307 node.status({ fill: 'green', shape: 'dot', text: msg.payload.toString() })
308 try {
309 switch (node.port) {
310 case 'D0':
311 case 'D1':
312 case 'D2':
313 case 'D3':
314 execSync(adcCommand + ' --mode digitalOut --pin ' + node.port + ' --output ' + out)
315 break
316 case 'P22':
317 case 'P23':
318 case 'P24':
319 case 'P25':
320 execSync(gpioCommand + ' --pin ' + node.port + ' --output ' + out)
321 break
322 }
323 } catch (err) {
324 allOK = false
325 node.status({ fill: 'red', shape: 'ring', text: 'waveshare-shield-adda-11010.status.not-running' })
326 RED.log.warn('waveshare-shield-adda-11010 : ' + RED._('waveshare-shield-adda-11010.errors.gpiofailure'))
327 }
328 if (done) { done() }
329 }
330
331 if (allOK === true) {
332 node.running = true
333 node.on('input', inputlistener)
334 } else {
335 node.status({ fill: 'grey', shape: 'dot', text: 'waveshare-shield-adda-11010.status.not-available' })
336 node.on('input', function (msg) {
337 node.status({ fill: 'grey', shape: 'dot', text: RED._('waveshare-shield-adda-11010.status.na', { value: msg.payload.toString() }) })
338 })
339 }
340
341 node.on('close', function (done) {
342 node.status({ fill: 'grey', shape: 'ring', text: 'waveshare-shield-adda-11010.status.closed' })
343 done()
344 })
345 }
346 RED.nodes.registerType('gpiooutput', gpiooutput)
347}
gpio
Definition gpio.py:1