Raspberries/upm
Public Access
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rpr220: add C driver and examples; FTI; C++ wraps C

Browse Source 
Signed-off-by: Jon Trulson <jtrulson@ics.com>
This commit is contained in:
Jon Trulson
2016-10-14 13:53:00 -06:00
parent 78904ef2b8
commit 770e43c627
9 changed files with 549 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
src/rpr220/rpr220.hpp
View File

@@ -1,6 +1,6 @@
/*
* Author: Jon Trulson <jtrulson@ics.com>
* Copyright (c) 2015 Intel Corporation.
* 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
@@ -24,92 +24,92 @@
#pragma once
#include <string>
#include <mraa/gpio.h>
#include <rpr220.h>
namespace upm {
/**
* @brief RPR220 IR Reflective Sensor library
* @defgroup rpr220 libupm-rpr220
* @ingroup seeed gpio light tsk hak
*/
/**
* @library rpr220
* @sensor rpr220
* @comname RPR220 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
* @brief RPR220 IR Reflective Sensor library
* @defgroup rpr220 libupm-rpr220
* @ingroup seeed gpio light tsk hak
*/
/**
* @library rpr220
* @sensor rpr220
* @comname RPR220 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
*
* @param pin Digital pin to use
*/
RPR220(int pin);
/**
* RPR220 destructor
*/
~RPR220();
/**
* Gets the status of the pin; true means black has been detected
* @brief API for the RPR220-based Grove IR Reflective Sensor
*
* @return True if the sensor has detected black
* 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
*/
bool blackDetected();
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();
#if defined(SWIGJAVA) || defined(JAVACALLBACK)
void installISR(jobject runnable);
void installISR(jobject runnable);
#else
/**
* Installs an ISR to be called when
* black is detected
*
* @param fptr 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);
/**
* Installs an ISR to be called when
* black is detected
*
* @param fptr 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);
#endif
/**
* Uninstalls the previously installed ISR
*
*/
void uninstallISR();
/**
* Uninstalls the previously installed ISR
*
*/
void uninstallISR();
private:
rpr220_context m_rpr220;
private:
#if defined(SWIGJAVA) || defined(JAVACALLBACK)
void installISR(void (*isr)(void *), void *arg);
void installISR(void (*isr)(void *), void *arg);
#endif
bool m_isrInstalled;
mraa_gpio_context m_gpio;
};
};
}