2 * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
3 * Copyright (c) 2014 Intel Corporation.
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:
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
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.
35 #define MAX_PERIOD 7968
36 #define TRIGGER_PULSE 10
41 * @brief C++ API for HCSR04 (ultrasonic ranging module) component
43 * This file defines the HCSR04 C++ interface for libhcsr04
45 * @snippet hcsr04.cxx Interesting
51 * Instanciates a HCSR04 object
53 * @param triggerPin pin for triggering the sensor for distance
54 * @param echoPin pulse response to triggering
55 * @param fptr function pointer for handling raising and
58 HCSR04 (uint8_t triggerPin, uint8_t echoPin, void (*fptr)(void *));
61 * HCSR04 object destructor.
66 * Get the distance from the sensor.
71 * On each interrupt this function will detect if the interrupt
72 * was falling edge or rising.
73 * Should be called from the interrupt handler.
75 void ackEdgeDetected ();
77 uint8_t m_doWork; /**< Flag to controll blocking function while waiting for falling edge interrupt */
80 * Return name of the component
88 maa_pwm_context m_pwmTriggerCtx;
89 maa_gpio_context m_echoPinCtx;
92 long m_RisingTimeStamp;
93 long m_FallingTimeStamp;
94 uint8_t m_InterruptCounter;