upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
Data Structures | Functions | Typedefs
Include dependency graph for water.h:

API Description

/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2016 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#include <unistd.h>
#include <signal.h>
#include "water.h"
#include "upm_utilities.h"
int shouldRun = true;
void sig_handler(int signo)
{
if (signo == SIGINT)
shouldRun = false;
}
int main ()
{
signal(SIGINT, sig_handler);
// Instantiate a Water sensor on digital pin D2
if (!sensor)
{
printf("water_init() failed.\n");
return(1);
}
while (shouldRun)
{
if (water_is_wet(sensor))
printf("Sensor is wet\n");
else
printf("Sensor is dry\n");
upm_delay(1);
}
printf("Exiting...\n");
water_close(sensor);
return 0;
}

Go to the source code of this file.

Data Structures

struct  _water_context
 

Functions

water_context water_init (unsigned int pin)
 
void water_close (water_context dev)
 
bool water_is_wet (const water_context dev)
 

Typedefs

typedef struct _water_contextwater_context
 

Function Documentation

water_context water_init ( unsigned int  pin)

Water initializer

Parameters
pinDigital pin to use
Returns
an initialized device context on success, NULL on error.

Here is the call graph for this function:

void water_close ( water_context  dev)

Water close function

Here is the caller graph for this function:

bool water_is_wet ( const water_context  dev)

Gets the water (wet/not wet) value from the sensor.

Returns
true if the sensor is wet, false otherwise

Here is the caller graph for this function:

Typedef Documentation

typedef struct _water_context * water_context

Device context