MatrixMiniR4 1.1.5
Matrix Mini R4 Arduino Library API Documentation
Loading...
Searching...
No Matches
MiniR4_Grove_US< PIN1, PIN2 > Class Template Reference

A class for interfacing with Grove Ultrasonic Ranger. More...

#include <MiniR4_Grove_US.h>

Public Member Functions

 MiniR4_Grove_US ()
 
long MeasureInCentimeters (uint32_t timeout=1000000L)
 Measures the distance in centimeters.
 
long MeasureInMillimeters (uint32_t timeout=1000000L)
 Measures the distance in millimeters.
 
long MeasureInInches (uint32_t timeout=1000000L)
 Measures the distance in inches.
 

Detailed Description

template<uint8_t PIN1, uint8_t PIN2>
class MiniR4_Grove_US< PIN1, PIN2 >

A class for interfacing with Grove Ultrasonic Ranger.

This class allows measuring distances in centimeters, millimeters, and inches using the Grove Ultrasonic Ranger sensor. It works by sending ultrasonic pulses and measuring the time taken for the pulse to return.

Template Parameters
PIN1Unused pin (for future use).
PIN2Pin number where the sensor is connected.

Definition at line 69 of file MiniR4_Grove_US.h.

Constructor & Destructor Documentation

◆ MiniR4_Grove_US()

template<uint8_t PIN1, uint8_t PIN2>
MiniR4_Grove_US< PIN1, PIN2 >::MiniR4_Grove_US ( )
inline

Definition at line 72 of file MiniR4_Grove_US.h.

Member Function Documentation

◆ MeasureInCentimeters()

template<uint8_t PIN1, uint8_t PIN2>
long MiniR4_Grove_US< PIN1, PIN2 >::MeasureInCentimeters ( uint32_t timeout = 1000000L)
inline

Measures the distance in centimeters.

Parameters
timeoutTimeout in microseconds (default: 1 second).
Returns
The measured distance in centimeters.

Definition at line 82 of file MiniR4_Grove_US.h.

◆ MeasureInInches()

template<uint8_t PIN1, uint8_t PIN2>
long MiniR4_Grove_US< PIN1, PIN2 >::MeasureInInches ( uint32_t timeout = 1000000L)
inline

Measures the distance in inches.

Parameters
timeoutTimeout in microseconds (default: 1 second).
Returns
The measured distance in inches.

Definition at line 106 of file MiniR4_Grove_US.h.

◆ MeasureInMillimeters()

template<uint8_t PIN1, uint8_t PIN2>
long MiniR4_Grove_US< PIN1, PIN2 >::MeasureInMillimeters ( uint32_t timeout = 1000000L)
inline

Measures the distance in millimeters.

Parameters
timeoutTimeout in microseconds (default: 1 second).
Returns
The measured distance in millimeters.

Definition at line 94 of file MiniR4_Grove_US.h.


The documentation for this class was generated from the following file: