Simple_HCSR04
A simple wrapper for the HC-SR04 Module to be used for e.g. an Arduino.
Simple_HCSR04.h
Go to the documentation of this file.
1 
12 #ifndef HCSR04_H_
13 #define HCSR04_H_
14 
15 #include <Arduino.h>
16 
23 {
24 private:
25 
31  Simple_HCSR04();
32 
34  const short ECHO_PIN;
36  const short TRIG_PIN;
37 
38 public:
44  {
45  private:
51  Measurement();
52 
53  const unsigned long m_measurement;
54 
55  public:
62  Measurement(unsigned long measurement);
63 
69  unsigned long mm() const;
70 
76  unsigned long cm() const;
77 
83  float dm() const;
84 
90  float m() const;
91 
92  };
93 
101  Simple_HCSR04(const short echo_pin, const short trig_pin);
102 
108  short getEchoPin() const;
109 
115  short getTrigPin() const;
116 
123  Measurement* measure();
124 
125 };
126 
127 #endif
Simple_HCSR04::Measurement::m
float m() const
Measurement/ Distance in meters.
Definition: Simple_HCSR04.cpp:42
Simple_HCSR04
A simple wrapper for measuring the distance with an HC-SR04 Module.
Definition: Simple_HCSR04.h:22
Simple_HCSR04::getEchoPin
short getEchoPin() const
Getter for the Echo pin.
Definition: Simple_HCSR04.cpp:65
Simple_HCSR04::Measurement::cm
unsigned long cm() const
Measurement/ Distance in centimeters.
Definition: Simple_HCSR04.cpp:32
Simple_HCSR04::measure
Measurement * measure()
Measures the distance between the module and the object in front of it. Warning: this function needs ...
Definition: Simple_HCSR04.cpp:80
Simple_HCSR04::Measurement::mm
unsigned long mm() const
Measurement/ Distance in millimeters.
Definition: Simple_HCSR04.cpp:27
Simple_HCSR04::Measurement
A simple wrapper for holding the measured distance.
Definition: Simple_HCSR04.h:43
Simple_HCSR04::Measurement::dm
float dm() const
Measurement/ Distance in decimeters.
Definition: Simple_HCSR04.cpp:37
Simple_HCSR04::getTrigPin
short getTrigPin() const
Getter for the Trig pin.
Definition: Simple_HCSR04.cpp:70