upm  0.1.8
Sensor/Actuator repository for libmraa (v0.4.5)
 All Data Structures Files Functions Variables Macros Pages
hcsr04.h
1 /*
2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
3  * Copyright (c) 2014 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 <string>
27 #include <mraa/aio.h>
28 #include <mraa/gpio.h>
29 #include <mraa/pwm.h>
30 #include <sys/time.h>
31 
32 #define HIGH 1
33 #define LOW 0
34 
35 #define MAX_PERIOD 7968
36 #define TRIGGER_PULSE 10
37 
38 namespace upm {
39 
48 class HCSR04 {
49  public:
58  HCSR04 (uint8_t triggerPin, uint8_t echoPin, void (*fptr)(void *));
59 
63  ~HCSR04 ();
64 
68  int getDistance ();
69 
75  void ackEdgeDetected ();
76 
77  uint8_t m_doWork;
82  std::string name()
83  {
84  return m_name;
85  }
86 
87  private:
88  mraa_pwm_context m_pwmTriggerCtx;
89  mraa_gpio_context m_echoPinCtx;
90 
91  uint8_t m_waitEcho;
92  long m_RisingTimeStamp;
93  long m_FallingTimeStamp;
94  uint8_t m_InterruptCounter;
95 
96  std::string m_name;
97 };
98 
99 }
HCSR04(uint8_t triggerPin, uint8_t echoPin, void(*fptr)(void *))
Definition: hcsr04.cxx:34
~HCSR04()
Definition: hcsr04.cxx:56
uint8_t m_doWork
Definition: hcsr04.h:77
void ackEdgeDetected()
Definition: hcsr04.cxx:83
std::string name()
Definition: hcsr04.h:82
int getDistance()
Definition: hcsr04.cxx:67
C++ API for HCSR04 (ultrasonic ranging module) component.
Definition: hcsr04.h:48