Erriez HC-SR04

https://erriez.github.io/ErriezHCSR04/
Admin
Erriez HC-SR04 is an Arduino library for the ultrasonic distance sensor HC-SR04, supporting...
Tokens:2,562
Snippets:82
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### HC-SR04 Inch Example

Source: https://erriez.github.io/ErriezHCSR04/index.html

This example demonstrates how to measure distance in inches using the Erriez HC-SR04 library.

```c++
void loop()
{
float distance;
// Measure distance in Inch
distance = hcsr04.getDistanceInch();
// Print distance
Serial.print(F("Distance: "));
if (distance >= 0) {
Serial.print(distance);
Serial.println(F("\""));
} else {
Serial.println(F("-"));
}
// Wait
delay(250);
}
```

--------------------------------

### HC-SR04 Centimeter Example

Source: https://erriez.github.io/ErriezHCSR04/index.html

This example demonstrates how to measure distance in centimeters using the Erriez HC-SR04 library.

```c++
#include <ErriezHCSR04.h>
// Pin defines
#define TRIG_PIN 2
#define ECHO_PIN 3
// Create sensor object
ErriezHCSR04 hcsr04(TRIG_PIN, ECHO_PIN);
void setup()
{
// Initialize serial port
delay(500);
Serial.begin(115200);
while (!Serial) {
;
}
Serial.println(F("\nErriez HC-SR04 ultrasonic distance sensor example\n"));
// Initialize pins
hcsr04.begin();
}
void loop()
{
int16_t distance;
// Measure distance in centimeter
distance = hcsr04.getDistance();
// Print distance
Serial.print(F("Distance: "));
if (distance >= 0) {
Serial.print(distance);
Serial.println(F(" cm"));
} else {
Serial.println(F("-"));
}
// Wait
delay(250);
}
```

--------------------------------

### Get Distance in cm

Source: https://erriez.github.io/ErriezHCSR04/class_erriez_h_c_s_r04.html

Retrieves the distance measured by the sensor in centimeters.

```cpp
int16_t getDistance()
```

--------------------------------

### Get Distance in Inch

Source: https://erriez.github.io/ErriezHCSR04/class_erriez_h_c_s_r04.html

Retrieves the distance measured by the sensor in inches.

```cpp
float getDistanceInch()
```

--------------------------------

### Echo pin input.

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8h.html

Echo pin input.

```c++
#define HCSR04_ECHO_INPUT() { pinMode(_echoPin, INPUT); }
```

--------------------------------

### ErriezHCSR04 Constructor

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8cpp_source.html

Constructor for the ErriezHCSR04 class, initializing the trigger and echo pins.

```cpp
#include "ErriezHCSR04.h"


ErriezHCSR04::ErriezHCSR04(uint8_t triggerPin, uint8_t echoPin)
{
// Save pins
#ifdef __AVR
_triggerPort = digitalPinToPort(triggerPin);
_echoPort = digitalPinToPort(echoPin);

_triggerBit = digitalPinToBitMask(triggerPin);
_echoBit = digitalPinToBitMask(echoPin);
#else
_triggerPin = triggerPin;
#endif
_echoPin = echoPin;
}
```

--------------------------------

### ErriezHCSR04.h Header File

Source: https://erriez.github.io/ErriezHCSR04/dir_68267d1309a1af8e8297ef4c3efbcdba.html

The header file for the HC-SR04 ultrasonic distance sensor library for Arduino.

```c++
#include "ErriezHCSR04.h"

```

--------------------------------

### HCSR04_ECHO_INPUT macro

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8cpp_source.html

Defines the action to set the echo pin as input.

```cpp
#define HCSR04_ECHO_INPUT()
Echo pin input.
```

--------------------------------

### Initialize Pins

Source: https://erriez.github.io/ErriezHCSR04/class_erriez_h_c_s_r04.html

Initializes the trigger and echo pins.

```cpp
void begin()
```

--------------------------------

### Echo pin read.

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8h.html

Echo pin read.

```c++
#define HCSR04_ECHO_READ() ( digitalRead(_echoPin) )
```

--------------------------------

### ErriezHCSR04::begin

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8cpp_source.html

Initializes the trigger and echo pins for the HC-SR04 sensor.

```cpp
void ErriezHCSR04::begin()
{
// TRIG pin output low
HCSR04_TRIG_LOW();
HCSR04_TRIG_OUTPUT();

// ECHO pin input
HCSR04_ECHO_INPUT();
}
```

--------------------------------

### HCSR04_TRIG_OUTPUT macro

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8cpp_source.html

Defines the action to set the trigger pin as output.

```cpp
#define HCSR04_TRIG_OUTPUT()
Trigger pin output.
```

--------------------------------

### HC-SR04 ultrasonic distance sensor library for Arduino.

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8h.html

Include dependency graph for ErriezHCSR04.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.

```c++
#include <Arduino.h>
```

--------------------------------

### Trigger pin output.

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8h.html

Trigger pin output.

```c++
#define HCSR04_TRIG_OUTPUT() { pinMode(_triggerPin, OUTPUT); }
```

--------------------------------

### Constructor

Source: https://erriez.github.io/ErriezHCSR04/class_erriez_h_c_s_r04.html

Constructor for the ErriezHCSR04 class.

```cpp
ErriezHCSR04(uint8_t triggerPin, uint8_t echoPin)
```

--------------------------------

### HCSR04_TRIG_LOW macro

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8cpp_source.html

Defines the action to set the trigger pin low.

```cpp
#define HCSR04_TRIG_LOW()
Trigger pin low.
```

--------------------------------

### HCSR04_TRIG_HIGH macro

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8cpp_source.html

Defines the action to set the trigger pin high.

```cpp
#define HCSR04_TRIG_HIGH()
Trigger pin high.
```

--------------------------------

### ErriezHCSR04::getDistanceInch

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8cpp_source.html

Measures and returns the distance in inches using the HC-SR04 sensor. Returns -1.0 for invalid distances.

```cpp
float ErriezHCSR04::getDistanceInch()
{
int16_t distanceCm;

// Read distance in centimeter
distanceCm = getDistance();

if (distanceCm >= 0) {
// Convert cm to inch
return (float)distanceCm / 2.54;
} else {
// Invalid distance
return -1.0;
}
}
```

--------------------------------

### Trigger pin low.

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8h.html

Trigger pin low.

```c++
#define HCSR04_TRIG_LOW() { digitalWrite(_triggerPin, LOW); }
```

--------------------------------

### ErriezHCSR04::getDistance

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8cpp_source.html

Measures and returns the distance in centimeters using the HC-SR04 sensor. Returns -1 for invalid distances (greater than 400cm).

```cpp
int16_t ErriezHCSR04::getDistance()
{
uint16_t distance;

// Wait at least 2 microseconds with TRIG pin low before starting measurement
HCSR04_TRIG_LOW();
delayMicroseconds(2);

// Generate 10 ms pulse TRIG pin
HCSR04_TRIG_HIGH();
delayMicroseconds(10);
HCSR04_TRIG_LOW();

// Reads the ECHO pin, returns the sound wave travel time in microseconds
// Distance = (high level time * velocity (340M/S)) / 2;
distance = (pulseIn(_echoPin, HIGH) * 0.034) / 2;

// Max range is around 400cm
if (distance > 400) {
// Invalid distance
distance = -1;
}

return distance;
}
```

--------------------------------

### Trigger pin high.

Source: https://erriez.github.io/ErriezHCSR04/_erriez_h_c_s_r04_8h.html

Trigger pin high.

```c++
#define HCSR04_TRIG_HIGH() { digitalWrite(_triggerPin, HIGH); }
```

--------------------------------

### Class Definition

Source: https://erriez.github.io/ErriezHCSR04/class_erriez_h_c_s_r04.html

The ErriezHCSR04 class is defined in ErriezHCSR04.h.

```cpp
#include <ErriezHCSR04.h>
```
Tokens:
Raw