-- fill-column: 100 --
This repo holds the hardware designs, firmware source code, design documents, and backend code for KnowIt ObjectNet's SnappySense environmental sensor device and its AWS IoT based backend.
End users want to go directly to the user manual: firmware-arduino/MANUAL.md.
Developers can start looking in BACKGROUND.md for background, requirements, and that type of discussion.
The v1.0.0 device has an Espressif ESP32 module-on-a-chip and a number of environmental sensors
(temperature, humidity, air quality, and other things - see firmware-arduino/src/sensor.h), as
well as a small OLED display.
The v1.1.0 device additionally has a small speaker. Note the pinout for v1.1 differs from v1.0 in some respects, be sure to use the correct firmware.
The standard v1.x firmware has FreeRTOS at the base and the Arduino framework layered on top and is
written in C++, see firmware-arduino/src.
The device user experience during setup and use is described in the user manual: firmware-arduino/MANUAL.md.
The firmware architecture is documented at the beginning of firmware-arduino/src/main.cpp, with
pointers to other files.
The device architecture, as seen by software (peripheral addresses, MCU pins, etc), is documented in
firmware-arduino/src/device.cpp.
Device schematics and data sheets will appear in this repo eventually (Issue #31). See hardware/.
For the Arduino firmware we use Visual Studio Code for the development environment.
Before you build the first time, you will need to install the PlatformIO extension in VSCode, see platformio.org for pointers. Basically if you're using VSCode you need to get the platformio.org extension installed from the extension manager within VSCode. (If you're not using VSCode you're on your own.)
If you are working on Linux, you will run into a bug in the source code for DFRobot_EnvironmentalSensor.h. It includes the file "String.h" but this must be "string.h", because that's the name of the file. This has also been fixed upstream but version 1.0.3 does not appear to have made it into the platformio databases, so it must be fixed manually.
Coding standards are documented at the beginning of firmware-arduino/src/main.h.
Source code for the Arduino-based firmware is in firmware-arduino/src/, start with
firmware-arduino/src/main.cpp and firmware-arduino/src/main.h.
Enable DEVELOPMENT in firmware-arduino/src/main.h to make it easier to develop and test.
Make a copy of firmware-arduino/src/development_config_template.txt as
firmware-arduino/src/development_config.h and make modifications in that copy for your local
setup, as this file is required to provide default settings.
To make a release build:
- Be sure to disable
SNAPPY_DEVELOPMENTinfirmware-arduino/src/main.h. - Adjust any other switches in
firmware-arduino/src/main.hthat might feel like they are development-only. - Pay attention to warnings during build, as some switches that should not be on during release cause warnings to be printed if they are enabled.
Experimental code for firmware based directly on the esp32-idf framework and FreeRTOS (lower level
than Arduino but better engineered) is in firmware-idf/.
Work in progress, though fully functional. See documents in aws/ for more.
Work in progress. The system is able to connect to non-AWS brokers such as RabbitMQ using a username/password system. There is a simple server in util/mqtt-server that will also connect to the broker and receive the data and save them in a simple database.