Published October 15, 2015 © Apache-2.0

Water detection system

Get notified of a water leak wherever you are

BeginnerFull instructions provided11,155

Things used in this project

Hardware components

Particle Photon

you can use a Photon or a Core (you do not need both)

Particle Spark Core

you can use a Photon or a Core (you do not need both)

water leak sensor

you can get one of these, or just search ebay for "water leak sensor" to get an alternative

Software apps and online services

Pushbullet

Story

Disaster can be around the corner

A pretty frustrating situation one can experience in North America, at least in the parts of North America where houses have basements, is to go down your basement one day and find it with ten centimeters of water. What is worse, this could have happened in the past week or so, and one never realizes it until their feet get wet when going to get that expensive wine from the cellar!

Another bad experience could arise from your beautiful aquarium, when something goes wrong with it while you are not there. This can potentially damage your property and your neighbor's one floor below! Not only that, what is going to happen to your beautiful clown fish if you don't get there on time?

I remember when my neighbor next door told me the story about his water heater reaching its end of life and started leaking water. It wasn't long until his family realized that the hot water was not hot anymore, just that it was during a weekend when plumbers are more expensive to call. Ouch.

And even if you don't have a basement or an aquarium (or a water heater?), a pipe is a pipe, a sump-pump is a sump-pump, a dishwasher is a dishwasher and a washing machine is a washing machine, and something could go wrong with any of them at any point in time, creating the unexpected kind of trouble nobody was ....errr.... expecting!

Solutions can be around the corner, too

I hope I did not scare you big time with the previous list of potential disasters.

So, for being better prepared for the unexpected, or at least to be aware of such a situation right away, we will use a Particle Photon and a water leak sensor, that's it!

Ok, ok, maybe we'll use some bits on the internet, plus some more on your router, and surely some on your phone.

The architecture

We want instant alerts if water is detected, and instant alerts for me today mean receiving a notification on any (or all) of my devices -- that could be my phone or my computer.

Instant alerts in all your devices thanks to Pushbullet, webhooks and the Particle Cloud

This is how it works:

The firmware running in the Particle, will publish a cloud event once water is detected.

This published cloud event in turn will get intercepted by a webhook living in the Particle cloud.

This webhook will push a notification to Pushbullet.

Pushbullet in turn, will push it to our devices.

The hardware

1- The Particle Photon

In case you did not know what a Particle Photon is, it is a great Arduino compatible WiFi development kit that allows us to connect many types of sensors to the internet. Wait, that was incomplete... The Particle Photon allows us to connect many types of things to the internet, be it a sensor, another device, a garage door and why not, a water sensor.

The Particle Photon comes standard with a Particle cloud platform, and it brings with it browser-based, wireless flashing!

1 / 3 • Ohhh the cloud...

2- The water leak sensor

Think about it: for water detection we could just use two exposed wires, since water is a great conductor. If the wires are close enough, once water touches them it will shortcut them and this would be easy to detect with a digital input in our Particle Photon.

Now think about it again: will our project look professional and beautiful? Hum, maybe not.

So for beauty's sake we will buy something better looking than simple, exposed wires: its evolution!

1 / 2 • The beautiful water leak sensor

We will profit from the Particle's internal pull-up resistors and connect the water leak sensor between ground and the digital input D0.

Note: if you want to monitor different spots, you can connect more water leak sensors to different digital inputs in the Particle (and modify the firmware accordingly) or connect the sensors in parallel like it is described in this project.

The software

There are two parts to this equation:

the firmware - flash it in your Particle and you are ready to go

the webhook - requires some configuration, see below

Configure the webhook to connect to pushbullet

Head to the pushbullet site, sign up for an account if you don't have one already and get your Access Token from the settings page.

Note: do not share this Pushbullet Access Token, since it grants access to your account!

Now save in your computer the webhook code (find it in the software section below) in a file named webhook.json.

Edit the webhook.json file just created and replace your Access Token in the Bearer field (you have to replace 123456789012345678901234567890 with your Access Token). Save and close the file.

Once the file is edited with the token, you are ready to upload this webhook to the Particle cloud.

Configure the webhook in the Particle cloud

Webhooks are configured via the particle CLI. If you don't have it installed already, please do so following the instructions here.

Once installed, open a console and type:

particle webhook create webhook.json

The output of that command would look like this:

Using settings from the file webhook.jsonSending webhook request { uri: 'https://api.particle.io/v1/webhooks', method: 'POST', json: { eventName: 'pushbullet', url: 'https://api.pushbullet.com/v2/pushes', requestType: 'POST', headers: { Authorization: 'Bearer 123456789012345678901234567890', 'Content-Type': 'application/json' }, json: { type: 'note', title: '{{SPARK_EVENT_VALUE}}', body: '' }, mydevices: true, event: 'pushbullet', deviceid: undefined }, headers: { Authorization: 'Bearer skljhklasjhdfjklhasdkljfhklasjhdf' } }Successfully created webhook with ID 1234kljhl123h41234jklh

That means the webhook got configured correctly.

In action!

To test everything is properly configured, drop the water leak sensor in a glass of water and observe that the on-board led in the Particle dev kit will light up.

Ten seconds after, you should receive a notification in your devices, be it your phone or your computer (this requires a pushbullet app installed).

If the condition continues (ie: water is detected), the notifications are configured to be sent as follows:

at 10 seconds,

at 1 minute,

at 5 minutes

at 15 minutes,

at 1 hour,

every 4 hours ever after, until the situation gets rectified

Flood notifications in your phone!

The end

So, did you build something similar? are you planning to? any questions?

leave me a note below,

Gustavo.

Psst: please find my other projects here.

Help

If you require professional help with your projects, don't hesitate to write me a line about your needs at gusgonnet@gmail.com. Thank you!

Code

// This #include statement was automatically added by the Particle IDE.
#include "elapsedMillis/elapsedMillis.h"

String _version = "0.04";

//this reads the flood sensor every 2 seconds
#define FLOOD_READ_INTERVAL 2000

//this defines the frequency of the notifications sent to the user
#define FLOOD_FIRST_ALARM 10000 //10 seconds
#define FLOOD_SECOND_ALARM 60000 //1 minute
#define FLOOD_THIRD_ALARM 300000 //5 minutes
#define FLOOD_FOURTH_ALARM 900000 //15 minutes
#define FLOOD_FIFTH_ALARM 3600000 //1 hour
#define FLOOD_SIXTH_ALARM 14400000 //4 hours - and every 4 hours ever after, until the situation is rectified (ie no more water is detected)

#define FLOOD_NOTIF "FLOOD"

elapsedMillis flood_timer;
elapsedMillis flood_alarm_timer;

int flood_alarms_array[6]={FLOOD_FIRST_ALARM, FLOOD_SECOND_ALARM, FLOOD_THIRD_ALARM, FLOOD_FOURTH_ALARM, FLOOD_FIFTH_ALARM, FLOOD_SIXTH_ALARM};
int flood_alarm_index = 0;
bool flood_detected = false;
unsigned long flood_next_alarm = 0;

int FLOOD_SENSOR = D0;
int LED = D7;

void setup() {
 pinMode(FLOOD_SENSOR, INPUT_PULLUP);
 pinMode(LED, OUTPUT);
 Spark.publish("device starting", "Firmware version: " + _version, 60, PRIVATE);
}

void loop() {

    flood_check();
    
    if ( flood_detected ) {
        flood_notify_user();
    }
}

/*******************************************************************************
 * Function Name  : flood_check
 * Description    : check water leak sensor at FLOOD_READ_INTERVAL, turns on led on D7 and raises alarm if water is detected
 * Return         : 0
 *******************************************************************************/
int flood_check()
{
    if (flood_timer < FLOOD_READ_INTERVAL) {
        return 0;
    }
    
    //time is up, so reset timer
    flood_timer = 0;

    if (not digitalRead(FLOOD_SENSOR)) {
        
        //if flood is already detected, no need to do anything, since an alarm will be fired
        if (flood_detected){
            return 0;
        }
        
        flood_detected = true;
    
        //reset alarm timer
        flood_alarm_timer = 0;

        //set next alarm
        flood_alarm_index = 0;
        flood_next_alarm = flood_alarms_array[0];
        
        digitalWrite(LED,HIGH);
    } else {
        
        digitalWrite(LED,LOW);
        flood_detected = false;
    }
    return 0;
}

/*******************************************************************************
 * Function Name  : flood_notify_user
 * Description    : will fire notifications to user at scheduled intervals
 * Return         : 0
 *******************************************************************************/
int flood_notify_user()
{

    if (flood_alarm_timer < flood_next_alarm) {
        return 0;
    }

    
    //time is up, so reset timer
    flood_alarm_timer = 0;
    
    //set next alarm or just keep current one if there are no more alarms to set
    if (flood_alarm_index < arraySize(flood_alarms_array)-1) {
        flood_alarm_index = flood_alarm_index + 1;
        flood_next_alarm = flood_alarms_array[flood_alarm_index];
    }

    //send an alarm to user (this one goes to the dashboard)
    Spark.publish(FLOOD_NOTIF, "Flood detected!", 60, PRIVATE);

    //send an alarm to user (this one goes to pushbullet servers)
    Spark.publish("pushbullet", "Flood detected!", 60, PRIVATE);
   
   return 0; 
}

Credits

gusgonnet

37 projects • 306 followers

With a decade of Software Engineering experience in IoT, I focus on creating Particle IoT solutions coupled with mobile and web applications

Water detection system

Things used in this project

Hardware components

Software apps and online services

Story

Disaster can be around the corner

Solutions can be around the corner, too

The architecture

The hardware

1- The Particle Photon

2- The water leak sensor

The software

Configure the webhook to connect to pushbullet

Configure the webhook in the Particle cloud

In action!

The end

Help

Schematics

waterLeakSensor.jpg

Code

Particle firmware

pushbullet webhook

Credits

gusgonnet

Comments

Embed the widget on your own site

Water detection system

Water detection system

Things used in this project

Hardware components

Software apps and online services

Story

Disaster can be around the corner

Solutions can be around the corner, too

The architecture

The hardware

1- The Particle Photon

2- The water leak sensor

The software

Configure the webhook to connect to pushbullet

Configure the webhook in the Particle cloud

In action!

The end

Help

Schematics

waterLeakSensor.jpg

Code

Particle firmware

pushbullet webhook

Credits

gusgonnet

Comments

Related channels and tags