Rain Guage

Francois

@BulldogLowell do you mind sharing the sketch I not seeing in this forum or on the Build pages of MySensor.org

BulldogLowell

Sure, but I have that running at my 'other' house and it is on older version of MySensors (haven't upgraded there yet ;)

I'll take a whack at updating if you like... it needs to get done anyway... here it is:

/*
 Arduino Tipping Bucket Rain Gauge
 
 June 15, 2014
 
 Version 1.00b   
 
 Arduino Tipping Bucket Rain Gauge
 
 Utilizing a tipping bucket sensor, your Vera home automation controller and the MySensors.org 
 gateway you can measure and sense local rain.  This sketch will create two devices on your 
 Vera controller.  One will display your total precipitation for the last 24, 48, 72, 96 and 120
 hours.  The other, a sensor that changes state if there is recent rain (up to last 120 hours) 
 above a threshold.  Both these settings are user definable. 
 
 This sketch features the following:
 
 * Allows you to set the rain threshold in mm  
 * Allows you to determine the interval window up to 120 hours.
 * Displays the last 24, 48, 72, 96 and 120 hours total rain in Variable1 through Variable5
   of the Rain Sensor device
 * Configuration changes to Sensor device updated every 3 hours.
 * SHould run on any Arduino
 * Will retain Tripped/Not Tripped status and data in a power outage, saving small ammount
   of data to EEPROM (Circular Buffer to maximize life of EEBPROM
 * There is a unique setup requirement necessary in order to properly present the Vera device 
   variables.  The details are outlined in the sketch below.
 * LED status indicator
 
 by BulldogLowell@gmail.com for free public use
 
 */
#include <SPI.h>
#include <EEPROM.h>  
#include <RF24.h>
#include <Sensor.h>
//
#define STATE_LOCATION 513 // stay away from EEPROM used with Sensor.h
#define EEPROM_BUFFER 514  // location of the EEPROM circular buffer
#define BUFFER_LENGTH 121
//
Sensor gw;
boolean metric = false;
//
int eepromIndex;
int tipSensorPin = 3;
int ledPin = 5; //PWM capable required
unsigned long dataMillis;
unsigned long serialInterval = 10000UL;
const unsigned long oneHour = 60000UL;
unsigned long lastTipTime;
unsigned long lastBucketInterval;
unsigned long startMillis;
int dayBuckets [5] [2] = {
 { V_VAR1, 24 },
 { V_VAR2, 48 },
 { V_VAR3, 72 },
 { V_VAR4, 96 },
 { V_VAR5, 120},
 };
volatile byte rainBucket [120] ; // 5 days of data
const unsigned long calibrateFactor = 1UL; //Calibration in milimeters of rain per single tip
unsigned long rainRate = 0;
float currentRain = 0;
boolean wasTipped = false;
boolean updateVera;
int rainCount;
volatile int tipBuffer = 0;
byte rainWindow = 72;//default rain window in hours
int rainSensorThreshold = 15;//default rain sensor sensitivity in mm
byte hourCount = 24;
byte state;
byte oldState = -1;
unsigned long ledPulseTime = 500UL;
unsigned long pulseStart;
//
void setup()  
{ 
  Serial.begin(115200);
  gw.begin();
  //
  pinMode(tipSensorPin, OUTPUT);
  attachInterrupt (1, sensorTipped, CHANGE);
  pinMode(ledPin, OUTPUT);
  digitalWrite(ledPin, HIGH);
  gw.sendSketchInfo("Rain Guage", "1.00b"); 
  gw.sendSensorPresentation(1, S_RAIN);
  gw.sendSensorPresentation(2, S_MOTION);
  Serial.println(F("Sensor Presentation Complete"));
  pinMode(tipSensorPin, INPUT);
  //
  state = EEPROM.read(STATE_LOCATION);
  for (int i = 0; i < BUFFER_LENGTH; i++)
  {
    byte locator = EEPROM.read(EEPROM_BUFFER + i);
    if (locator == 0xFF)
    {
      eepromIndex = EEPROM_BUFFER + i;
      loadRainArray(eepromIndex);
      Serial.println(eepromIndex);
      break;
    }
  }
  //
  gw.sendVariable(2, V_TRIPPED, state);
  dataMillis = millis();
  startMillis = millis();
  lastTipTime = millis() - oneHour;
  // uncomment the following block the first time you include this device.  The delays
  // are necessary in order to create the five Variable buckets in the correct order.
  // Once you create them, you can comment out these lines and re-upload to your arduino
  //------------------------------------------------------
  /*
  for (int j = 0; j < 5; j++)
   {
   delay(2000);
   gw.sendVariable(1, dayBuckets[j] [0], 1);
   }
   delay(2000);
   gw.sendVariable(2,V_VAR1, 1);
   delay(2000);
   gw.sendVariable(2,V_VAR2, 1);
   */
  //------------------------------------------------------  
  rainWindow = atoi(gw.getStatus(2, V_VAR1));
  delay(2000);
  rainSensorThreshold = atoi(gw.getStatus(2, V_VAR2));
  gw.sendVariable(1, V_RAINRATE, 0);
  Serial.print(F("Radio Done"));  
  analogWrite(ledPin, 20);
}
//
void loop()     
{ 
  unsigned long measure = 0; // Check to see if we need to show sensor tripped in this block
  for (int i = 0; i < rainWindow; i++)
  {
    measure = measure + rainBucket [i];
  }
  measure >= rainSensorThreshold ? state = 1: state = 0;
  if (millis() - pulseStart < ledPulseTime)
  {
    analogWrite(ledPin, 255);
  }
  else 
  {
    analogWrite(ledPin, 20);
  }
  if (state != oldState)
  {
    gw.sendVariable(2, V_TRIPPED, state);
    EEPROM.write(STATE_LOCATION, state);
    oldState = state;
  }
  //
  if (millis() - lastTipTime >= oneHour)// timeout for rain rate
  {
    if (rainRate != 0)
    {
      rainRate = 0;
      gw.sendVariable(1, V_RAINRATE, rainRate);
    }
  }
  if (updateVera)
  {
    gw.sendVariable(1, V_RAINRATE, rainRate);
    updateVera = false;
  }
  //
  if ( (millis() - dataMillis) >= serialInterval)//Comment back in this block to enable Serial prints
  {
    for (int i = 24; i <= 120; i=i+24)
    {
      updateSerialData(i);
    }
    dataMillis = millis();
  }
  //
  if (tipBuffer > 0)
  {
    Serial.println(F("Sensor Tipped"));
    rainBucket [0] ++;
    pulseStart = millis();
    if (rainBucket [0] > 253) rainBucket[0] = 253; // odd occurance but prevent overflow
    int dayTotal = 0;
    for (int i = 0; i < 24; i++)
    {
      dayTotal = dayTotal + rainBucket [i];
    }
    gw.sendVariable(1, V_RAIN, dayTotal);
    unsigned long tipDelay = millis() - lastTipTime;
    if (tipDelay <= oneHour) 
    {
      rainRate = ((oneHour) / tipDelay);
      gw.sendVariable(1, V_RAINRATE, rainRate);
      Serial.print(F("RainRate= "));
      Serial.println(rainRate);
    }
    lastTipTime = millis();
    updateVera = true;
    tipBuffer--;
  }
  if ( (millis()- startMillis) >= oneHour)
  {
    Serial.println("one hour elapsed");
    //EEPROM write last value
    EEPROM.write(eepromIndex, rainBucket[0]);
    eepromIndex++;
    if (eepromIndex > EEPROM_BUFFER + BUFFER_LENGTH) eepromIndex = EEPROM_BUFFER;
    Serial.println(eepromIndex);
    EEPROM.write(eepromIndex, 0xFF);
    //
    for (int i = BUFFER_LENGTH - 1; i >= 0; i--)//cascade an hour of values
    {
      rainBucket [i + 1] = rainBucket [i];
    }
    rainBucket[0] = 0;
    gw.sendVariable(1, V_RAIN, tipCounter(24));// send 24hr tips
    startMillis = millis();
    for (int j = 0; j < 5; j++)
    {
      int total = 0;
      for (int i = 0; i < dayBuckets[j][1]; i++)
      {
        total = total + rainBucket [i];
      }
      gw.sendVariable( 1, dayBuckets[j] [0], total);
    }
    hourCount++;
    if (hourCount >=3)//8 times daily update the Sensor variables
    {
      rainWindow = atoi(gw.getStatus(2, V_VAR1));
      if (rainWindow < 6) 
      {
        rainWindow = 6;
        gw.sendVariable( 2, V_VAR1, rainWindow);
      }
      if (rainWindow > 120) 
      {
        rainWindow = 120;
        gw.sendVariable( 2, V_VAR2, rainWindow);
      }
      rainSensorThreshold = atoi(gw.getStatus(2, V_VAR2));
      delay(2000);
      //
      if (rainSensorThreshold < 1) 
      {
        rainSensorThreshold = 1;
        gw.sendVariable( 2, V_VAR2, rainSensorThreshold);
      }
      if (rainSensorThreshold > 1000) 
      {
        rainSensorThreshold = 1000;
        gw.sendVariable( 2, V_VAR2, rainSensorThreshold);
      }
      //
      hourCount = 0;
    }
  }
}
//
void sensorTipped()
{
  static unsigned long last_interrupt_time = 0;
  unsigned long interrupt_time = millis();
  if (interrupt_time - last_interrupt_time > 200)
  {
    tipBuffer++;
  }
  last_interrupt_time = interrupt_time;
}
//
unsigned long tipCounter(int x)
{
  int tipCount = 0;
  for ( int i = 0; i < x; i++)
  {
    tipCount = tipCount + rainBucket [i];
  }
  return tipCount;
}
//
void updateSerialData(int x)
{
  Serial.print(F("Tips last "));
  Serial.print(x);
  Serial.print(F("hours: "));
  int tipCount = 0;
  for (int i = 0; i < x; i++)
  {
    tipCount = tipCount + rainBucket [i];
  }
  Serial.println(tipCount);
}
void loadRainArray(int value)
{
  for (int i = 0; i < BUFFER_LENGTH - 1; i++)
   {
     value--;
     Serial.println(value);
     if (value < EEPROM_BUFFER) 
       {
         value = EEPROM_BUFFER + BUFFER_LENGTH;
       }
     byte rainValue = EEPROM.read(value);
     Serial.println(rainValue);
     if (rainValue < 255)
     {
       rainBucket[i] = rainValue;
     }
     else
     {
       rainBucket [i] = 0;
     }
   }
}

tomrask

Hey Francois

Thanks for a nice projekt. I am thinking on building one myself. But is it possible to log the rain for everyday and writing the data to a csv file so I can use the data in Excel on Windows.

Hope that you can help my.

Tom

BulldogLowell

@tomrask

Tom,

Are you wishing to

log to an SD card
collect data controller side (e.g. Vera or other controller)
transmit data directly to a server
something else....?

BulldogLowell

@BulldogLowell said:

#define STATE_LOCATION 513 // stay away from EEPROM used with Sensor.h
#define EEPROM_BUFFER 514  // location of the EEPROM circular buffer
#define BUFFER_LENGTH 121

@hek

are we still required to steer clear of MySensor's EEPROM in addresses 0-512?

tomrask

I use a vera light with a USB key where the data can be stored. It vill be better if I the date was on my dropbox og sendt to my NAS.

But I have not fount a way to do it.

Tom

hek

@hek

are we still required to steer clear of MySensor's EEPROM in addresses 0-512?

Use the saveState()/loadState() function in the MySensors library

nostradamux

@BulldogLowell

Hi!!

I was searching for a long time in internet any place where someone offers a design of this mechanism of rain gauge. Finally I've found you!. I really interested in having one, but I don't have a 3D (not jet!). Could you provide me one print? Let me know how is the process to get one, please ! (I am in Spain!)

Thank you

BulldogLowell

@nostradamux

I actually used www.3dhubs.com which I believe is a Dutch company. I looked, they have service in Spain!

the service connects you with owners of 3D printers who make money using their personal machines.

5546dug

@nostradamux I had one printed using @BulldogLowell design and thru 3Dhubs.com the build was good and I used abs also for material. My cost in USA was approx. $17 usd and took a day to print and receive, looks good.
However I have not gotten far with project due to other issues unrealated just with I had more time and experience.

But this group is most helpful for newbies!
Good luck

epierre

@BulldogLowell could you convert your 123D file to STL so that the 3DHub could be used please ?

this is how to do it:
http://sitesupport.123dapp.com/entries/20540436-How-to-export-an-STL-file-for-3D-printing-in-123D

thanks,

;-)

BulldogLowell

@epierre

exceeds max file size, so here is a link:

https://drive.google.com/file/d/0B3KGTJHUgpw1MVpaYnUyUDUwN0E/view?usp=sharing

petewill

@BulldogLowell Did you ever get around to updating the sketch to work with version 1.4.1? I'm finally getting around to making a rain gauge and I didn't want to recreate the wheel if you already made it and I missed it somewhere.

Thanks,

Pete

BulldogLowell

@petewill

Sorry for the lag time, I've been on Easter vacation with the family!

Yes, I did update it, but I don't have my laptop with me here. I'll post it when I return home, early next week.

petewill

@BulldogLowell Great, thanks! You are a way better coder than me and I was struggling to understand the code. I did learn quite a bit about interrupts when I was trying to figure it out though.

petewill

@BulldogLowell Any luck finding the sketch? Sorry to bug you, I was just hoping to get this project completed soon so I can work on the irrigation controller next. It's almost time to start watering the lawn/plants... Thanks!

BulldogLowell

@petewill
I am embarrassed to tell you that after updating my arduino software a while back, I cannot locate a compilable sketch!

I have Time Machine, but still can't find it... and it is running on my rain guage!!!

Here is a version that I have (which is titled RainGuage_V1.4.1.ino in my directory) which i found but cannot compile, it looks like a first save without edit?

I need to completely update Arduino, the version and mySensors but please look at this:

/*
 Arduino Tipping Bucket Rain Gauge
 
 June 15, 2014
 
 Version 1.00b   
 
 Arduino Tipping Bucket Rain Gauge
 
 Utilizing a tipping bucket sensor, your Vera home automation controller and the MySensors.org 
 gateway you can measure and sense local rain.  This sketch will create two devices on your 
 Vera controller.  One will display your total precipitation for the last 24, 48, 72, 96 and 120
 hours.  The other, a sensor that changes state if there is recent rain (up to last 120 hours) 
 above a threshold.  Both these settings are user definable. 
 
 This sketch features the following:
 
 * Allows you to set the rain threshold in mm  
 * Allows you to determine the interval window up to 120 hours.
 * Displays the last 24, 48, 72, 96 and 120 hours total rain in Variable1 through Variable5
   of the Rain Sensor device
 * Configuration changes to Sensor device updated every 3 hours.
 * SHould run on any Arduino
 * Will retain Tripped/Not Tripped status and data in a power outage, saving small ammount
   of data to EEPROM (Circular Buffer to maximize life of EEBPROM
 * There is a unique setup requirement necessary in order to properly present the Vera device 
   variables.  The details are outlined in the sketch below.
 * LED status indicator
 
 by BulldogLowell@gmail.com for free public use
 
 */
#include <SPI.h>
#include <EEPROM.h>  
#include <RF24.h>
#include <Sensor.h>
//
#define STATE_LOCATION 513 // stay away from EEPROM used with Sensor.h
#define EEPROM_BUFFER 514  // location of the EEPROM circular buffer
#define BUFFER_LENGTH 121
//
Sensor gw;
boolean metric = false;
//
int eepromIndex;
int tipSensorPin = 3;
int ledPin = 5; //PWM capable required
unsigned long dataMillis;
unsigned long serialInterval = 10000UL;
const unsigned long oneHour = 60000UL;
unsigned long lastTipTime;
unsigned long lastBucketInterval;
unsigned long startMillis;
int dayBuckets [5] [2] = {
 { V_VAR1, 24 },
 { V_VAR2, 48 },
 { V_VAR3, 72 },
 { V_VAR4, 96 },
 { V_VAR5, 120},
 };
volatile byte rainBucket [120] ; // 5 days of data
const unsigned long calibrateFactor = 1UL; //Calibration in milimeters of rain per single tip
unsigned long rainRate = 0;
float currentRain = 0;
boolean wasTipped = false;
boolean updateVera;
int rainCount;
volatile int tipBuffer = 0;
byte rainWindow = 72;//default rain window in hours
int rainSensorThreshold = 15;//default rain sensor sensitivity in mm
byte hourCount = 24;
byte state;
byte oldState = -1;
unsigned long ledPulseTime = 500UL;
unsigned long pulseStart;
//
void setup()  
{ 
  Serial.begin(115200);
  gw.begin();
  //
  pinMode(tipSensorPin, OUTPUT);
  attachInterrupt (1, sensorTipped, CHANGE);
  pinMode(ledPin, OUTPUT);
  digitalWrite(ledPin, HIGH);
  gw.sendSketchInfo("Rain Guage", "1.00b"); 
  gw.sendSensorPresentation(1, S_RAIN);
  gw.sendSensorPresentation(2, S_MOTION);
  Serial.println(F("Sensor Presentation Complete"));
  pinMode(tipSensorPin, INPUT);
  //
  state = EEPROM.read(STATE_LOCATION);
  for (int i = 0; i < BUFFER_LENGTH; i++)
  {
    byte locator = EEPROM.read(EEPROM_BUFFER + i);
    if (locator == 0xFF)
    {
      eepromIndex = EEPROM_BUFFER + i;
      loadRainArray(eepromIndex);
      Serial.println(eepromIndex);
      break;
    }
  }
  //
  gw.sendVariable(2, V_TRIPPED, state);
  dataMillis = millis();
  startMillis = millis();
  lastTipTime = millis() - oneHour;
  // uncomment the following block the first time you include this device.  The delays
  // are necessary in order to create the five Variable buckets in the correct order.
  // Once you create them, you can comment out these lines and re-upload to your arduino
  //------------------------------------------------------
  /*
  for (int j = 0; j < 5; j++)
   {
   delay(2000);
   gw.sendVariable(1, dayBuckets[j] [0], 1);
   }
   delay(2000);
   gw.sendVariable(2,V_VAR1, 1);
   delay(2000);
   gw.sendVariable(2,V_VAR2, 1);
   */
  //------------------------------------------------------  
  rainWindow = atoi(gw.getStatus(2, V_VAR1));
  delay(2000);
  rainSensorThreshold = atoi(gw.getStatus(2, V_VAR2));
  gw.sendVariable(1, V_RAINRATE, 0);
  Serial.print(F("Radio Done"));  
  analogWrite(ledPin, 20);
}
//
void loop()     
{ 
  unsigned long measure = 0; // Check to see if we need to show sensor tripped in this block
  for (int i = 0; i < rainWindow; i++)
  {
    measure = measure + rainBucket [i];
  }
  measure >= rainSensorThreshold ? state = 1: state = 0;
  if (millis() - pulseStart < ledPulseTime)
  {
    analogWrite(ledPin, 255);
  }
  else 
  {
    analogWrite(ledPin, 20);
  }
  if (state != oldState)
  {
    gw.sendVariable(2, V_TRIPPED, state);
    EEPROM.write(STATE_LOCATION, state);
    oldState = state;
  }
  //
  if (millis() - lastTipTime >= oneHour)// timeout for rain rate
  {
    if (rainRate != 0)
    {
      rainRate = 0;
      gw.sendVariable(1, V_RAINRATE, rainRate);
    }
  }
  if (updateVera)
  {
    gw.sendVariable(1, V_RAINRATE, rainRate);
    updateVera = false;
  }
  //
  if ( (millis() - dataMillis) >= serialInterval)//Comment back in this block to enable Serial prints
  {
    for (int i = 24; i <= 120; i=i+24)
    {
      updateSerialData(i);
    }
    dataMillis = millis();
  }
  //
  if (tipBuffer > 0)
  {
    Serial.println(F("Sensor Tipped"));
    rainBucket [0] ++;
    pulseStart = millis();
    if (rainBucket [0] > 253) rainBucket[0] = 253; // odd occurance but prevent overflow
    int dayTotal = 0;
    for (int i = 0; i < 24; i++)
    {
      dayTotal = dayTotal + rainBucket [i];
    }
    gw.sendVariable(1, V_RAIN, dayTotal);
    unsigned long tipDelay = millis() - lastTipTime;
    if (tipDelay <= oneHour) 
    {
      rainRate = ((oneHour) / tipDelay);
      gw.sendVariable(1, V_RAINRATE, rainRate);
      Serial.print(F("RainRate= "));
      Serial.println(rainRate);
    }
    lastTipTime = millis();
    updateVera = true;
    tipBuffer--;
  }
  if ( (millis()- startMillis) >= oneHour)
  {
    Serial.println("one hour elapsed");
    //EEPROM write last value
    EEPROM.write(eepromIndex, rainBucket[0]);
    eepromIndex++;
    if (eepromIndex > EEPROM_BUFFER + BUFFER_LENGTH) eepromIndex = EEPROM_BUFFER;
    Serial.println(eepromIndex);
    EEPROM.write(eepromIndex, 0xFF);
    //
    for (int i = BUFFER_LENGTH - 1; i >= 0; i--)//cascade an hour of values
    {
      rainBucket [i + 1] = rainBucket [i];
    }
    rainBucket[0] = 0;
    gw.sendVariable(1, V_RAIN, tipCounter(24));// send 24hr tips
    startMillis = millis();
    for (int j = 0; j < 5; j++)
    {
      int total = 0;
      for (int i = 0; i < dayBuckets[j][1]; i++)
      {
        total = total + rainBucket [i];
      }
      gw.sendVariable( 1, dayBuckets[j] [0], total);
    }
    hourCount++;
    if (hourCount >=3)//8 times daily update the Sensor variables
    {
      rainWindow = atoi(gw.getStatus(2, V_VAR1));
      if (rainWindow < 6) 
      {
        rainWindow = 6;
        gw.sendVariable( 2, V_VAR1, rainWindow);
      }
      if (rainWindow > 120) 
      {
        rainWindow = 120;
        gw.sendVariable( 2, V_VAR2, rainWindow);
      }
      rainSensorThreshold = atoi(gw.getStatus(2, V_VAR2));
      delay(2000);
      //
      if (rainSensorThreshold < 1) 
      {
        rainSensorThreshold = 1;
        gw.sendVariable( 2, V_VAR2, rainSensorThreshold);
      }
      if (rainSensorThreshold > 1000) 
      {
        rainSensorThreshold = 1000;
        gw.sendVariable( 2, V_VAR2, rainSensorThreshold);
      }
      //
      hourCount = 0;
    }
  }
}
//
void sensorTipped()
{
  static unsigned long last_interrupt_time = 0;
  unsigned long interrupt_time = millis();
  if (interrupt_time - last_interrupt_time > 200)
  {
    tipBuffer++;
  }
  last_interrupt_time = interrupt_time;
}
//
unsigned long tipCounter(int x)
{
  int tipCount = 0;
  for ( int i = 0; i < x; i++)
  {
    tipCount = tipCount + rainBucket [i];
  }
  return tipCount;
}
//
void updateSerialData(int x)
{
  Serial.print(F("Tips last "));
  Serial.print(x);
  Serial.print(F("hours: "));
  int tipCount = 0;
  for (int i = 0; i < x; i++)
  {
    tipCount = tipCount + rainBucket [i];
  }
  Serial.println(tipCount);
}
void loadRainArray(int value)
{
  for (int i = 0; i < BUFFER_LENGTH - 1; i++)
   {
     value--;
     Serial.println(value);
     if (value < EEPROM_BUFFER) 
       {
         value = EEPROM_BUFFER + BUFFER_LENGTH;
       }
     byte rainValue = EEPROM.read(value);
     Serial.println(rainValue);
     if (rainValue < 255)
     {
       rainBucket[i] = rainValue;
     }
     else
     {
       rainBucket [i] = 0;
     }
   }
}

@petewill

I will convert this this weekend.

BulldogLowell

@petewill

Her is an untested go at it, and a very down and dirty update... I will test it probably Wednesday night, when I am back home. Let me know if you can!

/*
 Arduino Tipping Bucket Rain Gauge

 April 26, 2015

 Version 1.01b for MySensors version 1.4.1

 Arduino Tipping Bucket Rain Gauge

 Utilizing a tipping bucket sensor, your Vera home automation controller and the MySensors.org
 gateway you can measure and sense local rain.  This sketch will create two devices on your
 Vera controller.  One will display your total precipitation for the last 24, 48, 72, 96 and 120
 hours.  The other, a sensor that changes state if there is recent rain (up to last 120 hours)
 above a threshold.  Both these settings are user definable.

 This sketch features the following:

 * Allows you to set the rain threshold in mm
 * Allows you to determine the interval window up to 120 hours.
 * Displays the last 24, 48, 72, 96 and 120 hours total rain in Variable1 through Variable5
   of the Rain Sensor device
 * Configuration changes to Sensor device updated every 3 hours.
 * SHould run on any Arduino
 * Will retain Tripped/Not Tripped status and data in a power outage, saving small ammount
   of data to EEPROM (Circular Buffer to maximize life of EEPROM)
 * There is a unique setup requirement necessary in order to properly present the Vera device
   variables.  The details are outlined in the sketch below.
 * LED status indicator

 by BulldogLowell@gmail.com for free public use

 */
#include <SPI.h>
#include <MySensor.h>
#include <EEPROM.h>

#define RADIO_ID 99

#define STATE_LOCATION 513 // stay away from EEPROM used with Sensor.h
#define EEPROM_BUFFER 514  // location of the EEPROM circular buffer
#define BUFFER_LENGTH 121  // buffer plus the current hour
//
MySensor gw;
//
MyMessage msgRainRate(1, V_RAINRATE);
MyMessage msgRain(1, V_RAIN);
MyMessage msgRainVAR1(1, V_VAR1);
MyMessage msgRainVAR2(1, V_VAR2);
MyMessage msgRainVAR3(1, V_VAR3);
MyMessage msgRainVAR4(1, V_VAR4);
MyMessage msgRainVAR5(1, V_VAR5);

MyMessage msgTripped(2, S_MOTION);
MyMessage msgTrippedVar1(2, V_VAR1);
MyMessage msgTrippedVar2(2, V_VAR2);
//
boolean metric = false;
//
int eepromIndex;
int tipSensorPin = 3;
int ledPin = 5; //PWM capable required
unsigned long dataMillis;
unsigned long serialInterval = 10000UL;
const unsigned long oneHour = 60000UL;
unsigned long lastTipTime;
unsigned long lastBucketInterval;
unsigned long startMillis;
int dayBuckets [5] [2] = {
  { V_VAR1, 24 },
  { V_VAR2, 48 },
  { V_VAR3, 72 },
  { V_VAR4, 96 },
  { V_VAR5, 120},
};
volatile byte rainBucket [120] ; // 5 days of data
const unsigned long calibrateFactor = 1UL; //Calibration in milimeters of rain per single tip
unsigned long rainRate = 0;
float currentRain = 0;
boolean wasTipped = false;
boolean updateVera;
int rainCount;
volatile int tipBuffer = 0;
byte rainWindow = 72;         //default rain window in hours
int rainSensorThreshold = 15; //default rain sensor sensitivity in mm
byte hourCount = 24;
byte state;
byte oldState = -1;
//
void setup()
{
  Serial.begin(115200);
  gw.begin(getVariables, RADIO_ID);
  //
  pinMode(tipSensorPin, OUTPUT);
  attachInterrupt (1, sensorTipped, CHANGE);
  pinMode(ledPin, OUTPUT);
  digitalWrite(ledPin, HIGH);
  gw.sendSketchInfo("Rain Guage", "1.01b");
  gw.present(1, S_RAIN);
  gw.present(2, S_MOTION);
  Serial.println(F("Sensor Presentation Complete"));
  pinMode(tipSensorPin, INPUT);
  //
  state = EEPROM.read(STATE_LOCATION);    //retreive prior state from EEPROM
  gw.send(msgTripped.set(state), false);  //send state to Vera
  delay(250);                             // recharge the capacitor
  //
  boolean isDataOnEeprom = false;
  for (int i = 0; i < BUFFER_LENGTH; i++)
  {
    byte locator = EEPROM.read(EEPROM_BUFFER + i);
    if (locator == 0xFF)  // found the EEPROM circular buffer index
    {
      eepromIndex = EEPROM_BUFFER + i;
      loadRainArray(eepromIndex);
      isDataOnEeprom = true;
      Serial.println(eepromIndex);
      break;
    }
  }
  //
  if (!isDataOnEeprom)
  {
    // load all zeroes to EEPROM?
    // I gotta check this out!!!
  }
  //
  // reset the timers
  dataMillis = millis();
  startMillis = millis();
  lastTipTime = millis() - oneHour;
  gw.request(2, V_VAR1);
  delay(250);
  gw.request(2, V_VAR2);
  delay(250);
  Serial.print(F("Radio Done"));
  analogWrite(ledPin, 20);
}
//
void loop()
{
  gw.process();
  pulseLED();
  //
  // let's constantly check to see if the rain in the past rainWindow hours is greater than rainSensorThreshold
  //
  int measure = 0; // Check to see if we need to show sensor tripped in this block
  for (int i = 0; i < rainWindow; i++)
  {
    measure += rainBucket [i];
  }
  state = (measure >= rainSensorThreshold);
  if (state != oldState)
  {
    gw.send(msgTripped.set(state), false);
    delay(250);
    EEPROM.write(STATE_LOCATION, state);
    oldState = state;
  }
  //
  // Now lets reset the rainRate to zero if no tips in the last hour
  //
  if (millis() - lastTipTime >= oneHour)// timeout for rain rate
  {
    if (rainRate != 0)
    {
      rainRate = 0;
      gw.send(msgRainRate.set(0));
      delay(250);
    }
  }
  // if tipped,send updates to VERA
  //
  if (updateVera)
  {
    gw.send(msgRainRate.set(rainRate));
    delay(250);
    updateVera = false;
  }
  /*
  if ( (millis() - dataMillis) >= serialInterval)//Comment back in this block to enable Serial prints
  {
    for (int i = 24; i <= 120; i = i + 24)
    {
      updateSerialData(i);
    }
    dataMillis = millis();
  }
  */
  if (tipBuffer > 0)
  {
    Serial.println(F("Sensor Tipped"));
    rainBucket [0] ++;
    //
    if (rainBucket [0] > 253) rainBucket[0] = 253; // odd occurance but prevent overflow
    int dayTotal = 0;
    for (int i = 0; i < 24; i++)
    {
      dayTotal = dayTotal + rainBucket [i];
    }
    gw.send(msgRain.set(dayTotal));
    delay(250);
    unsigned long tipDelay = millis() - lastTipTime;
    if (tipDelay <= oneHour)
    {
      rainRate = ((oneHour) / tipDelay);
      gw.send(msgRainRate.set(rainRate));
      Serial.print(F("RainRate= "));
      Serial.println(rainRate);
    }
    lastTipTime = millis();
    updateVera = true;
    tipBuffer--;
  }
  if (millis() - startMillis >= oneHour)
  {
    Serial.println("one hour elapsed");
    //EEPROM write last value
    EEPROM.write(eepromIndex, rainBucket[0]);
    eepromIndex++;
    if (eepromIndex > EEPROM_BUFFER + BUFFER_LENGTH) eepromIndex = EEPROM_BUFFER;
    Serial.println(eepromIndex);
    EEPROM.write(eepromIndex, 0xFF);
    //
    for (int i = BUFFER_LENGTH - 1; i >= 0; i--)//cascade an hour of values
    {
      rainBucket [i + 1] = rainBucket [i];
    }
    rainBucket[0] = 0;
    gw.send(msgRain.set(tipCounter(24)));// send 24hr tips
    delay(250);
    transmitRainData(); // send all of the 5 buckets of data to controller
    startMillis = millis();
  }
}
//
void sensorTipped()
{
  static unsigned long last_interrupt_time = 0;
  unsigned long interrupt_time = millis();
  if (interrupt_time - last_interrupt_time > 200)
  {
    tipBuffer++;
  }
  last_interrupt_time = interrupt_time;
}
//
int tipCounter(int hours)
{
  int tipCount = 0;
  for ( int i = 0; i < hours; i++)
  {
    tipCount = tipCount + rainBucket [i];
  }
  return tipCount;
}
//
void updateSerialData(int x)
{
  Serial.print(F("Tips last "));
  Serial.print(x);
  Serial.print(F("hours: "));
  int tipCount = 0;
  for (int i = 0; i < x; i++)
  {
    tipCount = tipCount + rainBucket [i];
  }
  Serial.println(tipCount);
}
void loadRainArray(int value)
{
  for (int i = 0; i < BUFFER_LENGTH - 1; i++)
  {
    value--;
    Serial.println(value);
    if (value < EEPROM_BUFFER)
    {
      value = EEPROM_BUFFER + BUFFER_LENGTH;
    }
    byte rainValue = EEPROM.read(value);
    Serial.println(rainValue);
    if (rainValue < 255)
    {
      rainBucket[i] = rainValue;
    }
    else
    {
      rainBucket [i] = 0;
    }
  }
}

void transmitRainData(void)
{
  int rainUpdateTotal = 0;
  for (int i = 0; i < 24; i++)
  {
    rainUpdateTotal += rainBucket[i];
  }
  gw.send(msgRainVAR1.set(rainUpdateTotal));
  delay(250);
  for (int i = 24; i < 48; i++)
  {
    rainUpdateTotal += rainBucket[i];
  }
  gw.send(msgRainVAR2.set(rainUpdateTotal));
  delay(250);
  for (int i = 48; i < 72; i++)
  {
    rainUpdateTotal += rainBucket[i];
  }
  gw.send(msgRainVAR3.set(rainUpdateTotal));
  delay(250);
  for (int i = 72; i < 96; i++)
  {
    rainUpdateTotal += rainBucket[i];
  }
  gw.send(msgRainVAR4.set(rainUpdateTotal));
  delay(250);
  for (int i = 96; i < 120; i++)
  {
    rainUpdateTotal += rainBucket[i];
  }
  gw.send(msgRainVAR5.set(rainUpdateTotal));
  delay(250);
}

void getVariables(const MyMessage &message)
{
  if (message.sensor == 1)
  {
    // nothing to do here
  }
  else if (message.sensor == 2)
  {
    if (message.type == V_VAR1)
    {
      rainWindow = atoi(message.data);
      if (rainWindow > 120)
      {
        rainWindow = 120;
      }
      else if (rainWindow < 6)
      {
        rainWindow = 6;
      }
      if (rainWindow != atoi(message.data))   // if I changed the value back inside the boundries, push that number back to Vera
      {
        gw.send(msgTrippedVar1.set(rainWindow));
      }
    }
    else if (message.type == V_VAR2)
    {
      rainSensorThreshold = atoi(message.data);
      if (rainSensorThreshold > 1000)
      {
        rainSensorThreshold = 1000;
      }
      else if (rainSensorThreshold < 1)
      {
        rainSensorThreshold = 1;
      }
      if (rainSensorThreshold != atoi(message.data))  // if I changed the value back inside the boundries, push that number back to Vera
      {
        gw.send(msgTrippedVar2.set(rainSensorThreshold));
      }
    }
  }
}
void pulseLED(void)
{
  static boolean ledState = true;
  static unsigned long pulseStart = millis();
  if (millis() - pulseStart < 500UL)
  {
    digitalWrite(ledPin, !ledState);
    pulseStart = millis();
  }
}

petewill

@BulldogLowell Awesome, thank you very much! I know what it's like to lose code that way. I have done the same thing myself...

Yes, I will test this. I'll do my best to get it tested tonight. I'm combining it with some other sensors (light and temp/humidity) so once I get everything merged I'll be able to upload it.

I'll let you know what I find.

Thanks again!

Pete

petewill

@BulldogLowell

Ok, I made the necessary changes for my application and I had a couple of questions along the way.

I have never worked with eeprom so I don't pretend to know anything about it (it's now on my list of things to research though). Anyway, I noticed above hek recommended using the "saveState()/loadState() function in the MySensors library". Is that necessary in your code or are we ok as is? It seems to be functioning ok for me when I compile it so maybe not...
I would like to trigger my rain sensor as soon as the first bucket has tipped (I have scenes that tell me to close the windows etc. when it's raining). Is changing the rainSensorThreshold value to 1 an appropriate way to do that or should I create another child node for my purposes? Maybe I should use rainRate in my PLEG instead?
My tipping bucket was pulled from an existing rain gauge and according to my calculations (which may be off) each bucket is .7mm of rain. I don't know much about unsigned long variables but I'm wondering if I need to change "const unsigned long calibrateFactor" to a float or something?

Thanks for all your help!!

Pete

Rain Guage

23

11.7k

11.2k

113.1k