mirror of
https://github.com/eclipse/upm.git
synced 2025-03-17 22:17:28 +03:00
4a1eb99d6d
Touched on all library brief descriptions for better integration with ISS and fixed a few typos and connection tags in the process. Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
112 lines
3.5 KiB
C++
112 lines
3.5 KiB
C++
/*
|
|
* Author: Jon Trulson <jtrulson@ics.com>
|
|
* Copyright (c) 2015-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.
|
|
*/
|
|
#pragma once
|
|
|
|
#include <string>
|
|
#include <rpr220.h>
|
|
|
|
namespace upm {
|
|
|
|
/**
|
|
* @brief RPR220 IR Reflective Sensor
|
|
* @defgroup rpr220 libupm-rpr220
|
|
* @ingroup seeed gpio light tsk hak
|
|
*/
|
|
/**
|
|
* @library rpr220
|
|
* @sensor rpr220
|
|
* @comname Infrared (IR) Reflective Sensor
|
|
* @altname Grove IR Reflective Sensor
|
|
* @type light
|
|
* @man seeed
|
|
* @web http://www.seeedstudio.com/wiki/Grove_-_Infrared_Reflective_Sensor
|
|
* @con gpio
|
|
* @kit tsk hak
|
|
*
|
|
* @brief API for the RPR220-based Grove IR Reflective Sensor
|
|
*
|
|
* UPM module for the Grove IR reflective sensor. The sensitivity
|
|
* can be adjusted with the potentiometer on the sensor module. It
|
|
* has a range of approximately 15 mm, and a quick response time.
|
|
*
|
|
* It detects high-contrast dark areas on a light background.
|
|
*
|
|
* This module allows the user to determine the current status
|
|
* (black detected or not). Additionally, if desired, an interrupt
|
|
* service routine (ISR) can be installed that is called when
|
|
* black is detected. Either method can be used, depending on your
|
|
* use case.
|
|
*
|
|
* @image html rpr220.jpg
|
|
* @snippet rpr220.cxx Interesting
|
|
* @snippet rpr220-intr.cxx Interesting
|
|
*/
|
|
class RPR220 {
|
|
public:
|
|
/**
|
|
* RPR220 constructor
|
|
*
|
|
* @param pin Digital pin to use
|
|
*/
|
|
RPR220(int pin);
|
|
|
|
/**
|
|
* RPR220 destructor
|
|
*/
|
|
~RPR220();
|
|
|
|
/**
|
|
* Gets the status of the pin; true means black has been detected
|
|
*
|
|
* @return True if the sensor has detected black
|
|
*/
|
|
bool blackDetected();
|
|
|
|
|
|
/**
|
|
* Installs an ISR to be called when
|
|
* black is detected
|
|
*
|
|
* @param isr Pointer to a function to be called on interrupt
|
|
* @param arg Pointer to an object to be supplied as an
|
|
* argument to the ISR.
|
|
*/
|
|
void installISR(void (*isr)(void *), void *arg);
|
|
|
|
/**
|
|
* Uninstalls the previously installed ISR
|
|
*
|
|
*/
|
|
void uninstallISR();
|
|
|
|
private:
|
|
/* Disable implicit copy and assignment operators */
|
|
RPR220(const RPR220&) = delete;
|
|
RPR220 &operator=(const RPR220&) = delete;
|
|
|
|
rpr220_context m_rpr220;
|
|
|
|
};
|
|
}
|