mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 21:17:29 +03:00
283fce619e
In an effort to clean-up and standardize UPM library
documentation, this commit updates (and in most cases,
unifies) the CMake description string AND CXX header
@comname string.
Strings were taken from datasheets when possible, spelling
mistakes were addressed, copy/paste errors where fixed,
Title Case was used, etc.
* Tested/updated/added @web tags
* Added/updated invalid sensor images
* Added/updated @man tags, added missing manufacturers
Signed-off-by: Noel Eck <noel.eck@intel.com>
127 lines
2.9 KiB
C++
127 lines
2.9 KiB
C++
/*
|
|
* Author: Jon Trulson <jtrulson@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 <stdint.h>
|
|
#include <sys/time.h>
|
|
#include <mraa/gpio.h>
|
|
|
|
namespace upm {
|
|
/**
|
|
* @brief Ear-clip Heart Rate Sensor library
|
|
* @defgroup ehr libupm-ehr
|
|
* @ingroup seeed gpio medical
|
|
*/
|
|
|
|
/**
|
|
* @library ehr
|
|
* @sensor ehr
|
|
* @comname Ear-clip Heart Rate Sensor
|
|
* @type medical
|
|
* @man seeed
|
|
* @con gpio
|
|
*
|
|
* @brief API for the Ear-clip Heart Rate Sensor
|
|
*
|
|
* UPM module for the ear-clip heart rate sensor. It is used to measure your
|
|
* heart rate.
|
|
*
|
|
* @image html ehr.jpg
|
|
* @snippet ehr.cxx Interesting
|
|
*/
|
|
class EHR {
|
|
public:
|
|
/**
|
|
* EHR constructor
|
|
*
|
|
* @param pin Digital pin to use
|
|
*/
|
|
EHR(int pin);
|
|
/**
|
|
* EHR destructor
|
|
*/
|
|
~EHR();
|
|
/**
|
|
* Returns the time of milliseconds elapsed since initClock()
|
|
* was last called.
|
|
*
|
|
* @return Elapsed milliseconds
|
|
*/
|
|
uint32_t getMillis();
|
|
|
|
/**
|
|
* Resets the clock
|
|
*
|
|
*/
|
|
void initClock();
|
|
|
|
/**
|
|
* Resets the beat counter to 0. The beat counter should be
|
|
* stopped via stopBeatCounter() prior to calling this function.
|
|
*
|
|
*/
|
|
void clearBeatCounter();
|
|
|
|
/**
|
|
* Starts the beat counter
|
|
*
|
|
*/
|
|
void startBeatCounter();
|
|
|
|
/**
|
|
* Stops the beat counter
|
|
*
|
|
*/
|
|
void stopBeatCounter();
|
|
|
|
/**
|
|
* Gets the beat Counter
|
|
*
|
|
* @return Beat counter
|
|
*/
|
|
uint32_t beatCounter();
|
|
|
|
/**
|
|
* Computes the heart rate
|
|
*
|
|
* @return Computed heart rate
|
|
*/
|
|
int heartRate();
|
|
|
|
private:
|
|
/**
|
|
* Beat interrupt service routine (ISR)
|
|
*
|
|
*/
|
|
static void beatISR(void *ctx);
|
|
|
|
volatile uint32_t m_beatCounter;
|
|
struct timeval m_startTime;
|
|
mraa_gpio_context m_gpio;
|
|
};
|
|
}
|
|
|
|
|