Switch to bulleted lists

This commit is contained in:
Skylar Grant 2022-11-26 22:37:13 -05:00
parent 5c86fed160
commit 5dfdc44eb4

View File

@ -11,13 +11,13 @@ Three GPIO pins are used along with a common ground to control three relays, sup
For ease of adaption, connection, and prototyping I've decided to use Cat 5 ethernet cabling and RJ45 connectors to connect the Raspberry Pi to the stove, and to a breadboard mockup of the sensors and switches for testing. For ease of adaption, connection, and prototyping I've decided to use Cat 5 ethernet cabling and RJ45 connectors to connect the Raspberry Pi to the stove, and to a breadboard mockup of the sensors and switches for testing.
# Environment Variables # Environment Variables
ONTIME - How long to turn the auger on, in milliseconds. * ONTIME - How long to turn the auger on, in milliseconds.
OFFTIME - How long to wait between turning the auger on, in milliseconds. * OFFTIME - How long to wait between turning the auger on, in milliseconds.
PAUSETIME - How long to pause when a `pause` file is detected, in milliseconds. * PAUSETIME - How long to pause when a `pause` file is detected, in milliseconds.
DEBUG - Displays extra log information when set to `true` * DEBUG - Displays extra log information when set to `true`
# Controls # Controls
Run with `node main.js > log.txt &` to launch it in the background, piping output to a file `log.txt` which can be read from later. * Run with `node main.js > log.txt &` to launch it in the background, piping output to a file `log.txt` which can be read from later.
Pause the script by creating a file named `pause` in the root directory. * Pause the script by creating a file named `pause` in the root directory.
Reload the environment variables by creating a file named `reload` in the root directory. * Reload the environment variables by creating a file named `reload` in the root directory.
Quit the script by creating a file named `quit` in the root directory. * Quit the script by creating a file named `quit` in the root directory.