Catena4430_Sensor

This sketch is actually a fully implemented sensor that uses a 4610 + 4430 to make a mouse/rat activity tracker with LoRaWAN® backhaul and local SD card data storage. You can learn more about this project at https://mouserat.org.

This sketch also includes the feature of getting the network time and configuring the RTC.

Data is acquired continuously driven by the polling loop (in Catena4430_cMeasurementLoop.cpp). Various timers cause the data to be sampled. The main timer fires nominally every six minutes, and causes a sample to be taken of the data for the last 6 minutes. The data is then uplinked via LoRaWAN (if provisioned), and written to the SD card (if time is set).

This sketch is the production firmware for the MCCI® Catena 4430 Animal Activity Sensor.

Contents:

Introduction
Integration with Catena 4610
Installing and Building
Overview
Activities
Primary Data Acquisition
Indication with LED
Commands
Required libraries
Meta

Introduction

The MCCI Catena 4430 Animal Activity Tracker is an accessory for Adafruit Feather-compatible CPU boards such as the Adafruit Feather M0 or the MCCI Catena 4610. As the name suggests, it allows real-time tracking of the activity of research animals (mice, rats, and so forth) in cages. Data can be stored in an SD card and also transmitted over LoRaWAN networks such as The Things Network or Helium. Local accessories such as pellet feeders can also be controlled.

The product is available stand-alone, or built up into complete sensors, from the MCCI Store.

With an MCCI Catena 4610 mounted, the assembly looks like this:

Prior to assembly, the Catena 4430 looks like this:

The Catena 4430 adds the following functions to any compatible Feather-like board.

Passive Infrared (PIR) motion sensor. This can be mounted on the front or back or the board.
A battery-backed real-time clock (compatible with Adafruit's Adalogger FeatherWing).
An SD-card slot similar to the Adalogger, but different in a couple of ways. First the SD-card is electrically buffered going to and from the system; it can't interfere with the SPI bus when you're not using it. Second, the SD-card slot has a dedicated power supply that is off by default.
Three additional lights (red, green, and blue).
A JST XH-4 receptacle (in older units, a screw terminal) with four posts: two I/O signals, power, and ground. The power at the interconnect can be turned on and off under software control.

Integration with Catena 4610

The Catena 4610 has the following features.

LoRaWAN-compatible radio and software
Bosch BME280 temperature/humidity/pressure sensor
Silicon Labs Si1133 ambient light sensor

Installing and Building

The best way to install and build this software is to start with COLLECTION-mouserat-activity, a top-level collection that includes this repository as a submodule, along with the required libraries and a build procedure that uses the arduino-cli. It is, of course, also possible to install the libraries individually and build with a variety of build procedures. See "Required libraries" for details.

Overview

The primary function of the Catena 4430 is to capture and transmit real-time animal movement to remote data consumers, using LoRaAWAN. For consistency with MCCI's other monitoring products, information is captured and transmitted at six minute intervals.

This firmware has the following features.

During startup, the sketch initializes in-built sensors of Catena 4610, RTC and PIR sensor on Catena 4430.
If the device is provisioned as a LoRaWAN device, it enters the measurement loop.
The device does not enter deep sleep intead uses Low-Power Timer to sleep for 200 milli-seconds between each poll.
Temperature, Humidity and Pressure are measured by the BME280.
Data is encoded into binary and transmitted to the LoRaWAN network, using LoRaWAN port 2 (port 3 if RTC is set using Network time), as a class A device.
The sketch uses mcci-catena/mcci-catena-4430 library to measure read PIR data, Pellet count and to set/change RTC time.
The sketch uses the Catena Arduino Platform, and therefore the basic provisioning commands from the platform are always available while the sketch is running. This also allows user commands to be added if desired.
The McciCatena::cPollableObject paradigm is used to simplify the coordination of the activities described above.

Activities

Setup: an activity that launches the other activities.
Primary Data Acquisition: the activity that configures the PIR sensor, and then takes data. It wakes up periodically, poll registers, computes and send an uplink on LoRaWAN.
LoRaWAN control: this activity manages transmission and reception of data over LoRaWAN.
Local serial command processor
[Future] A firmware update activity
[Future] An activity to handle copying firmware

Primary Data Acquisition

The primary loop wakes up based on elapsed time, makes a series of measurements, scales them, and transmits them.

It senses temp sensor data, light sensor data, PIR sensor (activity) data, pellet feeder data, battery level, and boot count. By default, the cycle time is every six minutes, but this can be adjusted using the cycle-time downlink.

Indication with LED

Catena 4610 board has an onboard (Red) LED and Catena 4430 has three LEDs (Red, Green and Blue). These LEDs are used for indication for different cases.

Device Error
Status indication
Mouse Activity

Device Error

Error	LED behavior
RTC incative	Double blink Red 5 times
SD card error	Double blink Green 5 times
LoRa not provisioned	Double blink Blue 5 times

User Indication

Activity	LED behavior
Updating SD card with `.bin` file	Red, Blue, Green solid ON for entire duration
Time window for Double RESET	Catena 4610 onboard LED solid ON for 3 seconds

***NOTE: On double RESET, the OperatingFlags toggle between 0x00000001 and 0x40000001.

Mouse Activity

Activity	LED behavior
Activity detected on PIR sensor	Red on activity detection
Rising edge detected on A1	Green on for one cycle (200ms)
Rising edge detected on A2	Blue on for one cycle (200ms)

OperatingFlags

0x00000001 - At this case, LEDs are utilized as mentioned in above three cases
0x40000001 - At this case, all LEDs including LED on Catena 4610 will stay in OFF state.

Commands

In addition to the default commands provided by the library, the sketch provides the following commands:

`date`

Get or set the date and time in RTC. The clock runs in the UTC/GMT/Z time-zone.

To get the date, enter command date on a line by itself.

To set date and time, enter command - date yyyy-mm-dd hh:mm:ssz

To set date only, enter command - date yyyy-mm-dd

To set time only, enter command - date hh:mm:ssz

`dir`, `tree`

Displays the root directory name OR dirctory of path.

To display the root directory, enter command dir.

To produce a recursive directory list, enter command tree.

`log`

Get or set the debug mask, which controls the verbosity of debug output from the library.

To get the debug mask, enter command log on a line by itself.

To set the debug mask, enter debugmask number, where number is a C-style number indicating the value. For example, log 0x0C is the same as debugmask 12 -- it turns on bits 2, and 3.

The following bits are defined.

Bit	Mask	Name	Description
0	0x00000001	`kError`	Enables error messages
1	0x00000002	`kWarning`	Enables warning messages (none are defined at present)
2	0x00000004	`kTrace`	Enables trace messages. This specifically causes the FSM transitions to be displayed.
3	0x00000008	`kInfo`	Enables informational messages (none are defined at present)

Required libraries

The following Arduino standard libraries are used in this project.

SPI
Wire

The following additional libraries are used in this project.

Changing SD Cards While Operating

No problem, but wait for the red light to be out for 5 seconds.

File format

Typical File Content

Time,DevEUI,Raw,Vbat,Vsystem,Vbus,BootCount,T,RH,P,Light,P[0].delta,P[0].total,P[1].delta,P[1].total,Act[7],Act[6],Act[5],Act[4],Act[3],Act[2],Act[1],Act[0]
2019-11-19T08:41:03Z,"0002cc010000046b","224afe6d1f7d421d523a1c1af15ea72d7b0062000000000000",4.13,,5.14,28,26.94,17.77,96923.00,98,0,0,0,0,,,,,,,,
2019-11-19T08:51:26Z,"0002cc010000046b","224afe6f8efd3dd83a7b1c194d5ea432270066000000000000cdd4e61dfc53f47f6ff36d15",3.87,,3.65,28,25.30,19.59,96910.00,102,0,0,0,0,,,0.16,0.25,-0.28,-0.54,-0.10,-0.01

Trademarks and copyright

MCCI and MCCI Catena are registered trademarks of MCCI Corporation. LoRa is a registered trademark of Semtech Corporation. LoRaWAN is a registered trademark of the LoRa Alliance.

License

This repository is released under the MIT license. Commercial licenses are also available from MCCI Corporation.

Support Open Source Hardware and Software

MCCI invests time and resources providing this open source code, please support MCCI and open-source hardware by purchasing products from MCCI, Adafruit and other open-source hardware/software vendors!

For information about MCCI's products, please visit store.mcci.com.

dhineshkumarmcci/Catena4430_Sensor