Merge pull request #23 from mcci-catena/TMM-catena4460-aqi

Add Catena 4460 AQI sketch

Author: terrillmoore

.gitignore

@@ -45,3 +45,6 @@ __vm
 
 # VS Code things
 .vscode
+
+# the build directory
+build

README.md

@@ -10,13 +10,15 @@ This repository is the top-level repository for the software. In order to build,
 <!-- TOC depthFrom:2 -->
 
 - [Sketch Overview](#sketch-overview)
-    - [catena4450m101_sensor1](#catena4450m101_sensor1)
-    - [catena4410_sensor1](#catena4410_sensor1)
-    - [catena4410_test3](#catena4410_test3)
-    - [catena4410_test1, catena4410_test2](#catena4410_test1-catena4410_test2)
-    - [catena4450_test01](#catena4450_test01)
-    - [catena4450m101_sensor](#catena4450m101_sensor)
-    - [catena4450m102_pond](#catena4450m102_pond)
+	- [Full Sensor Programs](#full-sensor-programs)
+		- [catena4450m101_sensor1](#catena4450m101_sensor1)
+		- [catena4450m102_pond](#catena4450m102_pond)
+		- [catena4460_aqi](#catena4460_aqi)
+		- [catena4410_sensor1](#catena4410_sensor1)
+	- [Test programs](#test-programs)
+		- [catena4410_test3](#catena4410_test3)
+		- [catena4410_test1, catena4410_test2](#catena4410_test1-catena4410_test2)
+		- [catena4450_test01](#catena4450_test01)
 - [Extras](#extras)
 - [Required Board-Support Packages](#required-board-support-packages)
 - [Required Libraries](#required-libraries)
@@ -29,79 +31,87 @@ This repository is the top-level repository for the software. In order to build,
 
 ## Sketch Overview
 
-There are two kinds of sketches here: test programs (catena4410_test1, catene4410_test2, catena4410_test3, catena4450_test1), and full sensor programs (catena4410_sensor1, catena4420_test1, catena4450_sensor1).
+There are two kinds of sketches here: test programs (catena4410_test1, catene4410_test2, catena4410_test3, catena4420_test1,catena4450_test1), and full sensor programs (catena4410_sensor1,  catena4450m101_sensor1, catena4450m102_pond, catena4460_aqi).
 
 The sketches that use LoRaWAN take advantage of the [MCCI](http://www.mcci.com) [arduino-lorawan](https://github.com/mcci-catena/arduino-lorawan) library to cleanly separate the application from the network transport.
 
 The sensor sketches also use the RTCZero library to sleep the CPU.
 
-### catena4450m101_sensor1
+### Full Sensor Programs
+
+#### catena4450m101_sensor1
 
 This is the application written for the Catena 4450 power monitoring node used in the [Ithaca Power Project](https://ithaca-power.mcci.com). It uses FRAM-based provisioning (so there is no need to edit code to change LoRaWAN keys or other settings).
 
-### catena4410_sensor1
+#### catena4450m102_pond
+
+This is the Tzu Chi University / Asolar Hualian research farm project sketch, upgraded for use with the Catena 4450. It uses the integrated FRAM for provisioning, auto-detects the attached sensors, and transmits data in format 0x15.
+
+#### catena4460_aqi
+
+This sketch collects and transmits air-quality information using the Bosch BME680 sensor on the MCCI Catena 4460. It transmits data in format 0x17.
+
+#### catena4410_sensor1
 
 This sketch is the application written for the Tzu Chi University / Asolar Hualian research farm project. One firmware image is used for a variety of sensors. You can configure a given sensor as a general purpose device or as a specific subset, referencing back to the Atmel SAMD21 CPU's unique identifier.  All provisioning is done at compile time, but the network keys and other sensitive information is placed in a special library that is outside the normal set of repositories.
 
 The sketch transmits data in format 0x11.
 
-### catena4410_test3
+### Test programs
+
+#### catena4410_test3
 
 This is the primary test app used when bringing up and provisioning Catena 4410 units for use with The Things Network.
 
-### catena4410_test1, catena4410_test2
+#### catena4410_test1, catena4410_test2
 
 These are simpler test programs. They were rarely used after test3 was ready, but they may be useful for test of future Catena 441x variants
 with different sensor configurations.
 
-### catena4450_test01
+#### catena4450_test01
 
 This is the primary (non-LoRaWAN) test sketch for the Catena 4450.
 
-### catena4450m101_sensor
-
-This is the sketch used with the Catena 4450 for power sensing for the Ithaca Power project. It uses the integrated FRAM for provisioning, and transmits data in format 0x14.
-
-### catena4450m102_pond
-
-This is the Tzu Chi University / Asolar Hualian research farm project sketch, upgraded for use with the Catena 4450. It uses the integrated FRAM for provisioning, auto-detects the attached sensors, and transmits data in format 0x15.
-
 ## Extras
 
-The directory `extras` contains documenation and sample scripts for decoding the various formats.
+The directory `extras` contains documentation and sample scripts for decoding the various formats.
 
 ## Required Board-Support Packages
 
-All board support packages are maintained by MCCI. You should add the path to the reference Json file in your Arduino preferences. As of this writing, the file name to add to the list is:
-
-```
-https://github.com/mcci-catena/arduino-boards/raw/master/BoardManagerFiles/package_mcci_index.json
-```
-
-Check the [MCCI board support repository](https://github.com/mcci-catena/arduino-boards) for the latest information.
+All board support packages are maintained by MCCI. You should add the path to the reference Json file in your Arduino preferences. See the README for [arduino-boards](https://github.com/mcci-catena/arduino-boards) for more informatin.
 
 ## Required Libraries
 
 A number of libraries are required by this code. `catena4450m101_sensor1` contains a Bash script [`git-boot.sh`](https://github.com/mcci-catena/Catena-Sketches/blob/master/catena4450m101_sensor/git-boot.sh) that can be used to download all the libraries, using a simple database stored in [`git-repos.dat`](https://github.com/mcci-catena/Catena-Sketches/blob/master/catena4450m101_sensor/git-repos.dat).
 
-* [MCCI's Catena Platform library](https://github.com/mcci-catena/CatenaArduinoPlatform) provides an enhanced environment for portable sketch development. It includes an command-processing framework, an elaborate persistant storage framework, encoding libraries, support for storing the persistent data from the `arduino-lorawan` library, and so forth.
-* [MCCI's Arduino-LoRaWAN library](https://github.com/mcci-catena/arduino-lorawan) is a structured wrapper for the Arduino LMIC library, with the neccessary hooks for interfacing to persistent storage.
+* [MCCI's Catena Platform library](https://github.com/mcci-catena/Catena-Arduino-Platform) provides an enhanced environment for portable sketch development. It includes an command-processing framework, an elaborate persistent storage framework, encoding libraries, support for storing the persistent data from the `arduino-lorawan` library, and so forth.
+
+* [MCCI's Arduino-LoRaWAN library](https://github.com/mcci-catena/arduino-lorawan) is a structured wrapper for the Arduino LMIC library, with the necessary hooks for interfacing to persistent storage.
+
 * [MCCI's Ardino LMIC library](https://github.com/mcci-catena/arduino-lmic) is MCCI's fork of [The Things Network New York Arduino LMIC code](https://github.com/things-nyc/arduino-lmic).
+
 * [MCCI's ADK](https://github.com/mcci-catena/Catena-mcciadk) is MCCI's general-purpose cross-platform "XDK" library, ported to the Arduino environment.
+
 * [MCCI's Fork of the SAMD RTCZero library](https://github.com/mcci-catena/RTCZero) has the somewhat more substantial changes needed to allow the various processor sleep modes to be accessed, and to allow for some debuggging of the sleep mode chosen.
 
 ## Libraries for sensor work
 
 * [MCCI's Adafruit BME280 library](https://github.com/mcci-catena/Adafruit_BME280_Library) is used to make temperature, humidity and barometric pressure measurements using the [Adafruit BME280 breakout board](https://www.adafruit.com/products/2652), which we connect via I2C. It's based on the Adafruit library, but updated so that temperature, humidity and pressure are all read at the same time, to avoid data instability.
+
 * The [OneWire](https://github.com/mcci-catena/OneWire) and [Arduino Temperature Control Library](https://github.com/mcci-catena/Arduino-Temperature-Control-Library) are used for making measurements from Dallas-Semiconductor-based temperature sensors such as the [immersible sensor](https://www.adafruit.com/products/381) from Adafruit.
+
 * The [Adafruit Sensor Library](https://github.com/mcci-catena/Adafruit_Sensor) and the [Adafruit TSL2561 Lux Sensor Library](https://github.com/mcci-catena/Adafruit_TSL2561) are used for making ambient light measurements with the Adafruit [TSL2561 Lux Sensor](https://www.adafruit.com/products/439)
+
 * The [SHT1x library](https://github.com/mcci-catena/SHT1x) is used for measuring soil temperature and humidity using the Adafruit [SHT10 sensor](https://www.adafruit.com/products/1298).
 
 ## Related Work
+
 * [MCCI's Fork of the Map The Things Arduino Sketch](https://github.com/mcci-catena/mapthethings-arduino) contains, on the MCCI-Catena branch, a port of that app supporting OTAA, using the Catena libraries.
+
 * [MCCI's Catena Hardware Repository](https://github.com/mcci-catena/HW-Designs) contains hardware design information and schematics.
 
 ## Boilerplate
+
 MCCI work is released under the MIT public license. All other work from contributors (repositories forked to the MCCI Catena [github page](https://github.com/mcci-catena/)) are licensed according to the terms of those modules.
 
 Support inquiries may be filed at [https:://portal.mcci.com](https:://portal.mcci.com) or as tickets on [github](https://github.com/mcci-catena). We are very busy, so we can't promise to help; but we'll do our best.
@@ -114,4 +124,10 @@ Thanks to Amy Chen of Asolar, Josh Yu, and to Tzu-Chih University for funding th
 
 Further thanks to [Adafruit](https://www.adafruit.com/) for the wonderful Feather M0 LoRa platform, to [The Things Network](https://www.thethingsnetwork.org) for the LoRaWAN-based infrastructure, to [The Things Network New York](https://thethings.nyc) and [TTN Ithaca](https://ttni.tech) for the inspiration and support, and to the myriad people who have contributed to the Arduino and LoRaWAN infrastructure.
 
-**MCCI** and **Catena** are registered trademarks of MCCI Corporation.
+MCCI and MCCI Catena are registered trademarks of MCCI Corporation.
+
+LoRa is a registered trademark of Semtech Corporation.
+
+LoRaWAN is a trademark of the LoRa Alliance.
+
+All other trademarks are the property of their respective owners.

catena4450m101_sensor/git-boot.sh

@@ -5,10 +5,10 @@
 # Module:	gitboot.sh
 #
 # Function:
-# 	Load the repositories for building this sketch
+# 	Install the libraries needed for building a given sketch.
 #
 # Copyright notice:
-# 	This file copyright (C) 2017 by
+# 	This file copyright (C) 2017-2018 by
 #
 #		MCCI Corporation
 #		3520 Krums Corners Road
@@ -72,26 +72,12 @@ else
   exit 1
 fi
 
-##############################################################################
-# load the list of repos
-##############################################################################
-
-### use a long quoted string to get the repositories
-### into LIBRARY_REPOS.  Multiple lines for readabilty.
-LIBRARY_REPOS_DAT="${PDIR}/git-repos.dat"
-if [ ! -f "${LIBRARY_REPOS_DAT}" ]; then
-	_fatal "can't find suitable git-repos.dat:" "${LIBRARY_REPOS_DAT}"
-fi
-
-# parse the repo file, deleting comments
-LIBRARY_REPOS=$(sed -e 's/#.*$//' ${PDIR}/git-repos.dat)
-
 ##############################################################################
 # Scan the options
 ##############################################################################
 
 LIBRARY_ROOT="${LIBRARY_ROOT_DEFAULT}"
-USAGE="${PNAME} -[D l* T u v]; ${PNAME} -H for help"
+USAGE="${PNAME} -[D l* T u v] [datafile...]; ${PNAME} -H for help"
 
 #OPTDEBUG and OPTVERBOS are above
 OPTDRYRUN=0
@@ -130,15 +116,20 @@ Switches:
 			Default is $LIBRARY_ROOT_DEFAULT.
 	-S		Skip repos that already exist; -nS means
 			don't run if any repo already exist.
-			Only consulted if -nu. 
-	-T		Do a trial run (go through the motions 
+			Only consulted if -nu.
+	-T		Do a trial run (go through the motions
 			but don't do anything).
 	-u		Do a git pull if repo already is found.
 			-nu just skips the repository if it already
 			exists. -nu is the default.
 	-v		turns on verbose mode; -nv is the default.
 	-H		prints this help message.
 
+Data files:
+	The arguments specify repositories to be fetched, one repository
+	per line, in the form https://github.com/orgname/repo.git (or
+	similar). Blank lines and comments beginning with '#' are ignored.
+
 .
 		exit 0;;
 	\?)	echo "$USAGE" 1>&2
@@ -149,10 +140,31 @@ done
 #### get rid of scanned options ####
 shift `expr $OPTIND - 1`
 
-if [ $# -ne 0 ]; then
-	_error "extra arguments: $@"
+if [ $# -eq 0 ]; then
+	if [ -f "${PWD}/git-repos.dat" ]; then
+		LIBRARY_REPOS_DAT="${PWD}/git-repos.dat"
+	else
+		LIBRARY_REPOS_DAT="${PDIR}/git-repos.dat"
+	fi
+	_verbose "setting LIBRARY_REPOS_DAT to ${LIBRARY_REPOS_DAT}"
+	set -- "${LIBRARY_REPOS_DAT}"
 fi
 
+##############################################################################
+# load the list of repos
+##############################################################################
+
+### use a long quoted string to get the repositories
+### into LIBRARY_REPOS.  Multiple lines for readabilty.
+for LIBRARY_REPOS_DAT in "$@" ; do
+	if [ ! -f "${LIBRARY_REPOS_DAT}" ]; then
+		_fatal "can't find git-repos data file:" "${LIBRARY_REPOS_DAT}"
+	fi
+done
+
+# parse the repo file, deleting comments and eliminating duplicates
+LIBRARY_REPOS=$(sed -e 's/#.*$//' "$@" | LC_ALL=C sort -u)
+
 #### make sure LIBRARY_ROOT is really a directory
 if [ ! -d "$LIBRARY_ROOT" ]; then
 	_fatal "LIBRARY_ROOT: Can't find Arduino libraries:" "$LIBRARY_ROOT"