hestia/functions.js

384 lines
16 KiB
JavaScript
Raw Normal View History

2022-12-06 05:05:35 +00:00
// Physical Pin numbers for GPIO
const augerPin = 7; // Pin for controlling the relay for the pellet auger motor.
const igniterPin = 13; // Pin for controlling the relay for the igniter.
const blowerPin = 15; // Pin for controlling the relay for the combustion blower/exhaust.
const pofPin = 16; // Pin for sensing the status (open/closed) of the Proof of Fire switch.
const tempPin = 18; // Pin for receiving data from a DS18B20 OneWire temperature sensor.
const vacuumPin = 22; // Pin for sensing the status (open/closed) of the vacuum switch.
2022-12-06 05:28:14 +00:00
// Require the package for pulling version numbers
const package = require('./package.json');
// Import the config file
const config = require('./config.json');
2022-12-06 05:28:14 +00:00
// Get environment variables
const dotenv = require('dotenv').config();
// Module for working with files
const fs = require('fs');
2022-12-04 01:54:30 +00:00
// Promises I think?
const { resolve } = require('path');
2022-12-04 00:55:47 +00:00
// The functions we'll export to be used in other files
const functions = {
auger: {
2022-12-04 01:54:30 +00:00
// Gets called once the Auger Pin has been setup by rpi-gpio
ready(err) {
if (err) throw err;
console.log('Auger GPIO Ready');
return;
2022-12-03 23:20:38 +00:00
},
// Turns the auger on (Pin 7 high)
2022-12-04 00:55:47 +00:00
on(gpio) {
return new Promise((resolve) => {
if (process.env.ONPI == 'true') {
gpio.write(7, true, function(err) {
if (err) throw err;
resolve('Auger turned on.');
});
} else {
resolve('Simulated auger turned on.');
}
});
},
// Turns the auger off (pin 7 low)
2022-12-04 01:25:18 +00:00
off(gpio) {
return new Promise((resolve) => {
if (process.env.ONPI == 'true') {
gpio.write(7, false, function(err) {
if (err) throw err;
2022-12-06 05:32:26 +00:00
resolve('Auger turned off.');
});
} else {
resolve('Simulated auger turned off.');
}
});
},
// Cycles the auger using the two functions above this one (functions.auger.on() and functions.auger.off())
// Sleeps in between cycles using functions.sleep()
2022-12-04 00:59:12 +00:00
cycle(gpio) {
return new Promise((resolve) => {
2022-12-04 01:54:30 +00:00
// Turn the auger on
this.on(gpio).then((res) => {
2022-12-04 01:54:30 +00:00
// Log action if in debug mode
if (config.debugMode) console.log(`[${(Date.now() - config.startTime)/1000}] I: ${res}`);
2022-12-04 01:54:30 +00:00
// Sleep for the time set in env variables
functions.sleep(config.augerOnTime).then((res) => {
2022-12-04 01:54:30 +00:00
// Log action if in debug mode
if (config.debugMode) console.log(`[${(Date.now() - config.startTime)/1000}] I: ${res}`);
2022-12-04 01:54:30 +00:00
// Turn the auger off
this.off(gpio).then((res) => {
2022-12-04 01:54:30 +00:00
// Log action if in debug mode
if (config.debugMode) console.log(`[${(Date.now() - config.startTime)/1000}] I: ${res}`);
2022-12-04 01:54:30 +00:00
// Sleep for the time set in env variables
functions.sleep(config.augerOffTime).then((res) => {
2022-12-04 01:54:30 +00:00
// Log action if in debug mode
if (config.debugMode) console.log(`[${(Date.now() - config.startTime)/1000}] I: ${res}`);
2022-12-04 01:54:30 +00:00
// Resolve the promise, letting the main script know the cycle is complete
resolve("Cycle complete.");
});
});
});
});
});
},
},
files: {
2022-12-04 01:54:30 +00:00
// Check for a preset-list of files in the root directory of the app
check() {
return new Promise((resolve, reject) => {
2022-12-04 01:54:30 +00:00
// Check for pause file existing
if (fs.existsSync('./pause')) {
2022-12-04 01:54:30 +00:00
// Resolve the promise, letting the main script know what we found
resolve("pause");
}
2022-12-04 01:54:30 +00:00
// Check for reload file existing
if (fs.existsSync('./reload')) {
2022-12-04 01:54:30 +00:00
// Resolve the promise, letting the main script know what we found
resolve("reload");
}
2022-12-04 01:54:30 +00:00
// Check for quit file existing
if (fs.existsSync('./quit')) {
2022-12-04 01:54:30 +00:00
// Resolve the promise, letting the main script know what we found
resolve("quit");
}
// Check for ignite file existing
if (fs.existsSync('./ignite')) {
resolve('ignite');
}
2022-12-08 17:37:37 +00:00
// Check for start file existing
if (fs.existsSync('./start')) {
resolve('start');
}
2022-12-04 01:54:30 +00:00
// Resolve the promise, letting the main script know what we found (nothing)
resolve("none");
});
},
},
commands: {
2022-12-08 17:37:37 +00:00
// Prepare the stove for starting
startup (gpio) {
fs.unlink('./start', (err) => {
if (err) throw err;
});
return new Promise((resolve, reject) => {
if (process.env.ONPI == 'true') {
// Turn the combustion blower on
functions.power.blower.on(gpio).then(res => {
resolve(`I: Combustion blower has been enabled.`);
}).catch(rej => {
reject(`E: There was a problem starting the combustion blower: ${rej}`);
});
} else {
resolve(`I: Simulated combustion blower turned on.`);
}
});
},
2022-12-04 01:54:30 +00:00
// Pauses the script for the time defined in env variables
pause() {
return new Promise((resolve) => {
2022-12-08 17:37:37 +00:00
if (config.debugMode) console.log(`[${(Date.now() - config.startTime)/1000}] I: Pausing for ${config.pauseTime}ms`);
functions.sleep(config.pauseTime).then(() => { resolve(); });
});
},
2022-12-04 01:54:30 +00:00
// Reload the environment variables on the fly
reload(envs) {
return new Promise((resolve) => {
2022-12-04 01:54:30 +00:00
// Re-require dotenv because inheritance in js sucks
const dotenv = require('dotenv').config({ override: true });
2022-12-04 01:54:30 +00:00
// Delete the reload file
fs.unlink('./reload', (err) => {
if (err) throw err;
if (config.debugMode) console.log('Deleted reload file.');
});
2022-12-04 01:54:30 +00:00
// Print out the new environment variables
// This should be printed regardless of debug status, maybe prettied up TODO?
console.log('Reloaded environment variables.');
console.log(`ONTIME=${config.augerOnTime}\nOFFTIME=${config.augerOffTime}\nPAUSETIME=${config.pauseTime}\nDEBUG=${config.debugMode}\nONPI=${process.env.ONPI}`);
2022-12-04 01:54:30 +00:00
// Resolve the promise, letting the main script know we're done reloading the variables and the cycle can continue
resolve();
});
},
2022-12-04 01:54:30 +00:00
// Shutdown the script gracefully
quit() {
2022-12-04 01:54:30 +00:00
// Delete the quit file
fs.unlink('./quit', (err) => {
if (err) throw err;
if (config.debugMode) console.log('Removed quit file.');
});
2022-12-04 01:54:30 +00:00
// Print out that the script is quitting
console.log('Quitting...');
2022-12-04 01:54:30 +00:00
// Quit the script
process.exit();
},
ignite(gpio) {
config.status.igniter = 1;
config.igniterOnTime = Date.now();
config.igniterOffTime = config.igniterOnTime + config.igniterWaitTime; // 7 Minutes, 420,000ms
return new Promise((resolve, reject) => {
fs.unlink('./ignite', (err) => {
if (err) reject(err);
if (config.debugMode) console.log(`[${(Date.now() - config.startTime)/1000}] I: Delete the ignite file.`);
});
if (process.env.ONPI == 'true') {
gpio.write(igniterPin, true, (err) => {
if (err) reject(err);
resolve('Igniter turned on.');
});
} else {
resolve('Simulated igniter turned on.');
}
});
},
},
tests: {
vacuum(gpio) {
return new Promise((resolve, reject) => {
gpio.read(vacuumPin, (err, status) => {
if (err) reject(err);
resolve(status);
});
});
},
pof(gpio) {
return new Promise((resolve, reject) => {
gpio.read(pofPin, (err, status) => {
if (err) reject(err);
resolve(status);
});
});
},
igniter(gpio) {
2022-12-08 17:37:37 +00:00
return new Promise((resolve, reject) => {
var statusMsg = "";
if (config.status.igniter == 1) {
2022-12-08 17:37:37 +00:00
statusMsg += "The igniter is on.\n";
} else if (config.status.igniter == 0) {
2022-12-08 17:37:37 +00:00
statusMsg += "The igniter is off.\n";
} else {
2022-12-08 17:37:37 +00:00
reject("E: Unable to determine igniter status.");
}
if (config.igniterOnTime > 0) {
const humanStartTime = new Date(config.igniterOnTime).toISOString();
const humanEndTime = new Date(config.igniterOffTime).toISOString();
2022-12-08 17:37:37 +00:00
if (Date.now() < config.igniterOffTime && config.status.igniter == 1) {
statusMsg += `Igniter started: ${humanStartTime}.\n`;
statusMsg += `Igniter scheduled to stop: ${humanEndTime}.\n`;
}
// Shut the igniter off if it's past the waiting period
if ((Date.now() > config.igniterOffTime) && (config.status.igniter == 1)) {
if (process.env.ONPI == 'true') {
gpio.write(igniterPin, false, (err) => {
if (err) throw(err);
config.status.igniter = 0;
2022-12-08 17:37:37 +00:00
statusMsg += `${new Date().toISOString()} I: Turned off igniter.`;
functions.tests.pof(gpio).then(res => {
if (res) {
config.status.seenFire = true;
} else {
reject(`E: No Proof of Fire after igniter shut off.`);
}
}).catch(rej => {
});
});
} else {
config.status.igniter = 0;
2022-12-08 17:37:37 +00:00
statusMsg += `${new Date().toISOString()} I: Simulated igniter turned off.`;
}
2022-12-08 17:37:37 +00:00
} else if ((Date.now() > config.igniterOffTime) && (config.status.igniter == 0)) {
statusMsg += `The igniter was turned off at ${new Date(config.igniterOffTime).toISOString()}.`;
}
} else {
statusMsg += 'The igniter hasn\'t been started yet.';
}
resolve(statusMsg);
});
}
},
power: {
igniter: {
on(gpio) {
// TODO
return new Promise((resolve, reject) => {
gpio.write(igniterPin, true, (err) => {
if (err) reject(err);
resolve();
});
});
},
off(gpio) {
// TODO
return new Promise((resolve, reject) => {
gpio.write(igniterPin, false, (err) => {
if (err) reject(err);
resolve();
});
});
},
},
blower: {
on(gpio) {
// TODO
return new Promise((resolve, reject) => {
gpio.write(blowerPin, true, (err) => {
if (err) reject(err);
resolve();
});
});
},
off(gpio) {
// TODO
return new Promise((resolve, reject) => {
gpio.write(blowerPin, false, (err) => {
if (err) reject(err);
resolve();
});
});
},
},
},
2022-12-06 05:05:35 +00:00
// Sleeps for any given milliseconds
sleep(ms) {
return new Promise((resolve) => {
// if (config.debugMode) console.log(`Sleeping for ${ms}ms`);
2022-12-04 01:54:30 +00:00
// Function to be called when setTimeout finishes
const finish = () => {
2022-12-04 01:54:30 +00:00
// Resolve the promise
resolve(`Slept for ${ms}ms`);
2022-12-04 01:54:30 +00:00
};
// The actual sleep function, sleeps for ms then calls finish()
setTimeout(finish, ms);
});
},
2022-12-04 01:54:30 +00:00
// Initializes rpi-gpio, or resolves if not on a raspberry pi
2022-12-04 00:55:47 +00:00
init(gpio) {
return new Promise((resolve, reject) => {
2022-12-06 05:29:03 +00:00
// Boot/About/Info
2022-12-06 05:31:21 +00:00
console.log(`== Lennox Winslow PS40
2022-12-06 05:28:14 +00:00
== Pellet Stove Control Panel
== Author: Skylar Grant
== Version: v${package.version}
==
== Startup Time: ${new Date().toISOString()}
==
== Environment variables:
== == ONTIME=${config.augerOnTime}
== == OFFTIME=${config.augerOffTime}
== == PAUSETIME=${config.pauseTime}
== == DEBUG=${config.debugMode}
2022-12-06 05:28:14 +00:00
== == ONPI=${process.env.ONPI}`);
2022-12-04 00:55:47 +00:00
// Set up GPIO 4 (pysical pin 7) as output, then call functions.auger.ready()
if (process.env.ONPI == 'true') {
2022-12-06 05:05:35 +00:00
// Init the Auger pin
gpio.setup(augerPin, gpio.DIR_OUT, (err) => {
2022-12-04 00:55:47 +00:00
if (err) reject(err);
if (config.debugMode) console.log('== Auger pin initialized.');
2022-12-06 05:05:35 +00:00
// Init the igniter pin
gpio.setup(igniterPin, gpio.DIR_OUT, (err) => {
if (err) reject(err);
if (config.debugMode) console.log('== Igniter pin initialized.');
2022-12-06 05:05:35 +00:00
// Init the blower pin
gpio.setup(blowerPin, gpio.DIR_OUT, (err) => {
if (err) reject(err);
if (config.debugMode) console.log('== Combustion blower pin initialized.');
2022-12-06 05:05:35 +00:00
// Init the Proof of Fire pin
gpio.setup(pofPin, gpio.DIR_IN, (err) => {
if (err) reject(err);
if (config.debugMode) console.log('== Proof of Fire pin initialized.');
2022-12-08 17:47:50 +00:00
// Init the Vacuum Switch pin
gpio.setup(vacuumPin, gpio.DIR_IN, (err) => {
2022-12-06 05:05:35 +00:00
if (err) reject(err);
2022-12-08 17:47:50 +00:00
if (config.debugMode) console.log('== Vacuum Switch pin initialized.');
// Resolve the promise now that all pins have been initialized
resolve('== GPIO Initialized.');
2022-12-06 05:05:35 +00:00
});
2022-12-08 17:47:50 +00:00
// Init the Temp Sensor pin
// gpio.setup(tempPin, gpio.DIR_IN, (err) => {
// if (err) reject(err);
// if (config.debugMode) console.log('== Temperature pin initialized.');
// });
2022-12-06 05:05:35 +00:00
});
});
});
2022-12-04 00:55:47 +00:00
});
} else {
2022-12-04 01:54:30 +00:00
// Resolve the promise
resolve('== GPIO Not Available');
2022-12-04 00:55:47 +00:00
}
});
2022-12-03 23:20:38 +00:00
},
}
2022-12-04 01:54:30 +00:00
// Export the above object, functions, as a module
module.exports = { functions };