Tally Counter I2C module

Introduction
Sensor Datasheet
Sensor Constructor
Example Code
Classes
Defines
Sensor Timing
Events

Classes for the Tally Counter I2C external event counter.

Introduction

Northern Widget's Tally is

a minimal ultra low power digital event counter, designed to be a counterpart to a traditional data logger to measure and average rapid events like an anemometer reading.

It communicates over I2C at either 3.3 or 5V.

The [Tally_Library] (https://github.com/EnviroDIY/Tally_Library/tree/Dev_I2C) is used internally for communication with the Tally.

Warning

Northern Widget considers this sensor to be one of their "bleeding edge" sensors. As such, it is subject to change at any time. This library may not be updated immediately to reflect changes on the part of Northern Widget.

As an event counter, the Tally should be continuously powered (at 3.3V or 5V). It does have a large on-board capacitor which can act as a battery to ride out power shortages, but that shouldn't be expected to perform as a long-term solution. If you do chose to switch the power for the Tally counter, be very conscious of the fact that the library is designed to run power this (and all other) sensors for the very minimum amount of time possible to get a reading. This means the capacitor will be running at a very low duty cycle; likely less than 1% if the sensors are only powered a few seconds every few minutes. A super-capacitor is NOT an instantly charged battery and will not keep the counter powered at too low a duty cycle.

Sensor Datasheet

Documentation for the sensor can be found at:

Sensor Constructor

TallyCounterI2C(int8_t powerPin = -1, uint8_t i2cAddressHex = TALLY_ADDRESS_BASE)

Construct a new Tally Counter I2C object using the primary hardware I2C instance.

Parameters
powerPin	The pin on the mcu controlling power to TallyCounterI2C. The default is to use -1 for continuous power because a counting device must always be on. However, the Tally also has a super capacitor that will keep it running even while powered down while the logger is in sleep during the interval between measurements. The Tally Counter I2C can use either a 3.3V or 5V power source.
i2cAddressHex	The I2C address of the Tally Counter I2C is 0x33 by default.

Parameters

powerPin

The pin on the mcu controlling power to TallyCounterI2C.

The default is to use -1 for continuous power because a counting device must always be on. However, the Tally also has a super capacitor that will keep it running even while powered down while the logger is in sleep during the interval between measurements.
The Tally Counter I2C can use either a 3.3V or 5V power source.

i2cAddressHex

The I2C address of the Tally Counter I2C is 0x33 by default.

Example Code

The Tally countetr is used in the menu a la carte example.

Classes

class TallyCounterI2C: The Sensor sub-class for the Tally Counter I2C.
class TallyCounterI2C_Events: The Variable sub-class used for the events output from a Tally Counter I2C - shows the number of events since last read.

Defines

#define TALLY_NUM_VARIABLES = 1: Sensor::_numReturnedValues; the Tally can report 1 value.
#define TALLY_INC_CALC_VARIABLES = 0: Sensor::_incCalcValues; we don't calculate any additional values.
#define TALLY_ADDRESS_BASE = 0x33: The default address of the Tally.

Sensor Timing

The sensor timing for a Northern Widget Tally event counter

Readings transferred from the reed-switch counting device (i.e. anemometer or tipping bucket) to the logger are from past events, so there is no need to wait for stability or measuring.

#define TALLY_WARM_UP_TIME_MS = 10: Sensor::_warmUpTime_ms; Tally warms up in <10 ms.
#define TALLY_STABILIZATION_TIME_MS = 10: Sensor::_stabilizationTime_ms; Tally is stable after <10ms.
#define TALLY_MEASUREMENT_TIME_MS = 10: Sensor::_measurementTime_ms; Tally takes <10ms to complete a measurement.

Events

The events variable from a Northern Widget Tally event counter

Range and accuracy depend on the sensor used
- For wind, we often use [Inspeed WS2R Version II Reed Switch Anemometer] (https://www.store.inspeed.com/Inspeed-Version-II-Reed-Switch-Anemometer-Sensor-Only-WS2R.htm)

TallyCounterI2C_Events(TallyCounterI2C* parentSense, const char* uuid = "", const char* varCode = TALLY_EVENTS_DEFAULT_CODE) explicit

Construct a new TallyCounterI2C_Events object.

Parameters
parentSense	The parent TallyCounterI2C providing the result values.
uuid	A universally unique identifier (UUID or GUID) for the variable; optional with the default value of an empty string.
varCode	A short code to help identify the variable in files; optional with a default value of "TallyCounterI2CEvents".

#define TALLY_EVENTS_RESOLUTION = 0: Decimals places in string representation; events are an integer should be 0 - resolution is 1 event.
#define TALLY_EVENTS_VAR_NUM = 0: Sensor variable number; events is stored in sensorValues[0].
#define TALLY_EVENTS_VAR_NAME = "counter": Variable name in ODM2 controlled vocabulary; "counter".
#define TALLY_EVENTS_UNIT_NAME = "event": Variable unit name in ODM2 controlled vocabulary; "event".
#define TALLY_EVENTS_DEFAULT_CODE = "TallyCounterI2CEvents": Default variable short code; "TallyCounterI2CEvents".