1 /* 2 * Author: Zion Orent <sorent@ics.com> 3 * Copyright (c) 2015 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 <mraa/gpio.h> 27 28 namespace upm { 29 /** 30 * @brief Water Level Switch Library 31 * @defgroup waterlevel libupm-waterlevel 32 * @ingroup seeed gpio liquid 33 */ 34 /** 35 * @library waterlevel 36 * @sensor waterlevel 37 * @comname Grove Water Level Sensor 38 * @type liquid 39 * @man seeed 40 * @con gpio 41 * 42 * @brief UPM module for the Grove Water Level Switch 43 * 44 * This switch is a device used to sense the level of liquid within a tank, 45 * it may actuate a pump, an indicator, an alarm, or other devices. 46 * 47 * @image html waterlevel.jpg 48 * @snippet apds9002.cxx Interesting 49 */ 50 class WaterLevel { 51 public: 52 /** 53 * WaterLevel constructor 54 * 55 * @param pin Digital pin to use 56 */ 57 WaterLevel(int pin); 58 /** 59 * WaterLevel destructor 60 */ 61 ~WaterLevel(); 62 /** 63 * @return bool Determines whether liquid has risen above the sensor 64 */ 65 bool isSubmerged(); 66 67 private: 68 mraa_gpio_context m_gpio; 69 }; 70 } 71