An abstract base class for some sonar classes defined as part of this API. More...
#include <fastarduino/devices/sonar.h>
Public Types | |
| using | RTT = timer::RTT< NTIMER_ > |
The type of timer::RTT used by this sonar instance. More... | |
Public Member Functions | |
| bool | ready () const |
| Indicate if an echo pulse measure is ready to read. More... | |
| uint16_t | latest_echo_us () const |
| Get the latest measured echo pulse duration. More... | |
Detailed Description
class devices::sonar::AbstractSonar< NTIMER_ >
An abstract base class for some sonar classes defined as part of this API.
You should not need to subclass AbstractSonar yourself in general.
- Template Parameters
-
NTIMER_ the AVR timer of the timer::RTTto use for this sonar
- See also
- board::Timer
- timer::RTT
- HCSR04
Member Typedef Documentation
◆ RTT
| using devices::sonar::AbstractSonar< NTIMER_ >::RTT = timer::RTT<NTIMER_> |
The type of timer::RTT used by this sonar instance.
Member Function Documentation
◆ ready()
|
inline |
Indicate if an echo pulse measure is ready to read.
This can be useful when using asynchronous modes, and checking from time to time if, after a trigger pulse, an echo pulse has already been received or not yet.
- Return values
-
true an echo pulse duration is available false an echo pulse duration is not yet available
- See also
- latest_echo_us()
◆ latest_echo_us()
|
inline |
Get the latest measured echo pulse duration.
If a trigger pulse was sent but no echo received yet, then the method immediataly returns 0. It also returns 0, as a convention, if a timeout occurred, i.e. no echo pulse was received in expected time.
- Returns
- the latest measured echo pulse duration in microseconds
The documentation for this class was generated from the following file:
- fastarduino/devices/sonar.h
