Document protocol spec in comment

This commit is contained in:
Starbeamrainbowlabs 2020-03-13 01:42:43 +00:00
parent 70984d14d7
commit 438b28f1b5
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 16 additions and 0 deletions

View File

@ -16,8 +16,24 @@
See the LICENSE file for details.
***************************************************************************/
/*
Adapted by Starbeamrainbowlabs <https://starbeamrainbowlabs.com/>
GitHub: @sbrl | Twitter: @SBRLabs | Reddit: u/Starbeamrainbowlabs
# PROTOCOL SPEC
## INPUT
4 character commands. Whitespace and non-printable characters are ignored.
### COMMANDS
Command | Meaning
--------|-----------------------------------------------------------
read | Read the sensor values and write the result to stdout
*/
#include <Wire.h>
#include <SPI.h>
// These libraries need installing in the Arduino IDE Library Manager (if you install the BME280 one it should prompt for the unified sensor library automatically)
#include <Adafruit_Sensor.h>
#include <Adafruit_BME280.h>