commit 74110a2b935aa30ee4d8db200c28f8252e7e5b52 Author: Thorsten Date: Wed Jan 1 18:10:10 2025 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8256337 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch +settings-my-ignore.h diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..137dcf3 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# Ultraschall-Entfernungsmesser mit OLED-Anzeige + +Dieses Programm misst Entfernungen mit einem HC-SR04-Ultraschallsensor und zeigt die Werte auf einem SH1106 OLED-Display an. Es wurde für den ESP8266 (NodeMCU) entwickelt und nutzt die U8g2-Bibliothek zur Anzeige. + +Ein Projekt zur Visualisierung von Energiedaten von **Tasmota-Messgeräten** mit einem **ESP8266** und einem 1602 LCD. +Das Script fragt periodisch zwei Tasmota-Geräte nach ihrer gemessenen Leistung und zeigt diese auf dem Display an. +Ein einfacher Energie-Monitor. + +## Funktionen + +- Misst Entfernungen in Zentimetern (cm). + +- Zeigt den gemessenen Wert in großer Schrift auf dem OLED-Display an. + +## Hardwareanforderungen + +1. ESP8266 NodeMCU +2. HC-SR04 Ultraschallsensor +3. SH1106 OLED-Display (128x64 Pixel) + +## Anschlüsse + +### SH1106 OLED-Display + +| Sensor-Pin | ESP8266-Pin | +|------------|-------------| +| VCC | 5V | +| GND | GND | +| TRIG | D6 (GPIO12) | +| ECHO | D5 (GPIO14) | + +### HC-SR04 Ultraschallsensor + +| Display-Pin | ESP8266-Pin | +|-------------|-------------| +| VCC | 5V | +| GND | GND | +| SDA | D2 (GPIO4) | +| SCL | D1 (GPIO5) | + + +Projektbild + +## Installation + +1. Bibliotheken installieren: +Stelle sicher, dass die folgende Bibliothek in deinem platformio.ini-Projekt installiert ist: +```cpp +lib_deps = + olikraus/U8g2 @ ^2.34.1 +``` +2. Code hochladen: + - Kopiere den Code aus der Hauptdatei in dein PlatformIO-Projekt. + - Verbinde den ESP8266 mit deinem Computer. + - Lade den Code auf den ESP8266 hoch., + + +## Nutzung + +1. Schließe die Hardware gemäß der oben angegebenen Tabelle an. +2. Starte das Programm. +3. Beobachte die gemessene Entfernung auf dem OLED-Display. \ No newline at end of file diff --git a/circuit-diagram/circuit-diagram.spl8 b/circuit-diagram/circuit-diagram.spl8 new file mode 100644 index 0000000..6fd78e8 Binary files /dev/null and b/circuit-diagram/circuit-diagram.spl8 differ diff --git a/images/image_1.png b/images/image_1.png new file mode 100644 index 0000000..45ba161 Binary files /dev/null and b/images/image_1.png differ diff --git a/include/README b/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/include/README @@ -0,0 +1,39 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..2593a33 --- /dev/null +++ b/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..b044415 --- /dev/null +++ b/platformio.ini @@ -0,0 +1,21 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env:nodemcuv2] +platform = espressif8266 +board = nodemcuv2 +framework = arduino +upload_speed = 115200 +monitor_speed = 115200 +lib_deps = + adafruit/Adafruit SSD1306 @ ^2.5.7 + adafruit/Adafruit GFX Library @ ^1.11.7 + adafruit/Adafruit BusIO @ ^1.14.1 + olikraus/U8g2 @ ^2.34.20 \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..4840050 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,50 @@ +#include + +#define TRIG_PIN 12 +#define ECHO_PIN 14 + +#define SOUND_SPEED 0.034 +#define CM_TO_INCH 0.393701 + +long duration; +int distanceCm; + +// Initialisierung für das Display +U8G2_SH1106_128X64_NONAME_F_HW_I2C u8g2(U8G2_R0, /* reset=*/U8X8_PIN_NONE); + +void setup() { + Serial.begin(115200); + pinMode(TRIG_PIN, OUTPUT); // TRIG_PIN als Ausgang + pinMode(ECHO_PIN, INPUT); // ECHO_PIN als Eingang + + u8g2.begin(); + u8g2.setFont(u8g2_font_logisoso32_tf); // Große Schriftart +} + +void loop() { + // Ultraschallsensor auslösen + digitalWrite(TRIG_PIN, LOW); + delayMicroseconds(2); + digitalWrite(TRIG_PIN, HIGH); + delayMicroseconds(10); + digitalWrite(TRIG_PIN, LOW); + + // Echo-Zeit messen + duration = pulseIn(ECHO_PIN, HIGH); + + // Distanz berechnen + distanceCm = duration * SOUND_SPEED / 2; + + // Ausgabe im Serial Monitor + Serial.print("Distance (cm): "); + Serial.println(distanceCm); + + // Anzeige auf dem Display + u8g2.clearBuffer(); + u8g2.setCursor(0, 48); // Textposition für große Schrift + u8g2.print(distanceCm); + u8g2.print(" cm"); + u8g2.sendBuffer(); // Buffer an das Display senden + + delay(500); +} diff --git a/test/README b/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html