1 /* 2 * Author: Jon Trulson <jtrulson@ics.com> 3 * Copyright (c) 2014 Intel Corporation. 4 * 5 * Permission is hereby granted, free of charge, to any person obtaining 6 * a copy of this software and associated documentation files (the 7 * "Software"), to deal in the Software without restriction, including 8 * without limitation the rights to use, copy, modify, merge, publish, 9 * distribute, sublicense, and/or sell copies of the Software, and to 10 * permit persons to whom the Software is furnished to do so, subject to 11 * the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be 14 * included in all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 20 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 22 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 23 */ 24 #pragma once 25 26 #include <string> 27 #include <mraa/gpio.h> 28 29 namespace upm { 30 /** 31 * @brief Grove Water Sensor library 32 * @defgroup grovewater libupm-grovewater 33 * @ingroup seeed gpio liquid eak 34 */ 35 36 /** 37 * @library grovewater 38 * @sensor grovewater 39 * @comname Grove Water Sensor 40 * @type liquid 41 * @man seeed 42 * @con gpio 43 * @kit eak 44 * 45 * @brief API for the Grove Water Sensor 46 * 47 * UPM module for the Grove Water sensor 48 * 49 * @image html grovewater.jpg 50 * @snippet grovewater.cxx Interesting 51 */ 52 class GroveWater { 53 public: 54 /** 55 * Grove digital water sensor constructor 56 * 57 * @param pin Digital pin to use 58 */ 59 GroveWater(int pin); 60 /** 61 * GroveWater destructor 62 */ 63 ~GroveWater(); 64 /** 65 * Gets the water (wet/not wet) value from the sensor 66 * 67 * @return True if the sensor is wet, false otherwise 68 */ 69 bool isWet(); 70 71 private: 72 mraa_gpio_context m_gpio; 73 }; 74 } 75