/*
* Author: Zion Orent <sorent@ics.com>
* Copyright (c) 2014 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.
*/
#pragma once
#include <string>
#include <mraa/aio.h>
namespace upm {
/**
* @brief BISS0001 Motion Sensor library
* @defgroup biss0001 libupm-biss0001
* @ingroup seeed gpio light tsk
*/
/**
* @library biss0001
* @sensor biss0001
* @comname BISS0001 Motion Sensor
* @altname Grove PIR Motion Sensor
* @type light
* @man seeed
* @web http://www.seeedstudio.com/depot/Grove-PIR-Motion-Sensor-p-802.html
* @con gpio
* @kit tsk
*
* @brief API for the BISS0001 Motion Sensor
*
* UPM module for the BISS0001 Motion Sensor
*
* @image html biss0001.jpg
* @snippet biss0001.cxx Interesting
*/
class BISS0001 {
public:
/**
* BISS0001 motion sensor constructor
*
* @param pin Digital pin to use
*/
BISS0001(int pin);
/**
* BISS0001 destructor
*/
~BISS0001();
/**
* Gets the motion value from the sensor
*
* @return Motion reading
*/
bool value();
private:
mraa_gpio_context m_gpio;
};
}