From 578f6d5756ead1664dfb5bb9880169cc85d841f3 Mon Sep 17 00:00:00 2001 From: hans-jurgen Date: Fri, 11 Oct 2024 12:54:07 +0200 Subject: [PATCH] 2024-10-1100 Start --- .gitignore | 5 ++ .vscode/extensions.json | 10 +++ include/README | 39 ++++++++++++ lib/README | 46 ++++++++++++++ platformio.ini | 21 +++++++ src/main.cpp | 136 ++++++++++++++++++++++++++++++++++++++++ test/README | 11 ++++ 7 files changed, 268 insertions(+) create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 include/README create mode 100644 lib/README create mode 100644 platformio.ini create mode 100644 src/main.cpp create mode 100644 test/README diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch 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/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..8d97eb8 --- /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:upesy_wroom] +platform = espressif32 +board = upesy_wroom +framework = arduino +monitor_port = /dev/ttyUSB0 +monitor_speed = 115200 +monitor_filters = time +lib_deps = + # The exact version + bodmer/TFT_eSPI @ 2.5.43 + paulstoffregen/XPT2046_Touchscreen @ 0.0.0-alpha+sha.26b691b2c8 diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..d2da9b4 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,136 @@ +#include + + + + + +/* Rui Santos & Sara Santos - Random Nerd Tutorials + THIS EXAMPLE WAS TESTED WITH THE FOLLOWING HARDWARE: + 1) ESP32-2432S028R 2.8 inch 240×320 also known as the Cheap Yellow Display (CYD): https://makeradvisor.com/tools/cyd-cheap-yellow-display-esp32-2432s028r/ + SET UP INSTRUCTIONS: https://RandomNerdTutorials.com/cyd/ + 2) REGULAR ESP32 Dev Board + 2.8 inch 240x320 TFT Display: https://makeradvisor.com/tools/2-8-inch-ili9341-tft-240x320/ and https://makeradvisor.com/tools/esp32-dev-board-wi-fi-bluetooth/ + SET UP INSTRUCTIONS: https://RandomNerdTutorials.com/esp32-tft/ + Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files. + The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +*/ + +#include +#include // Hardware-specific library + +/* Install the "TFT_eSPI" library by Bodmer to interface with the TFT Display - https://github.com/Bodmer/TFT_eSPI + *** IMPORTANT: User_Setup.h available on the internet will probably NOT work with the examples available at Random Nerd Tutorials *** + *** YOU MUST USE THE User_Setup.h FILE PROVIDED IN THE LINK BELOW IN ORDER TO USE THE EXAMPLES FROM RANDOM NERD TUTORIALS *** + FULL INSTRUCTIONS AVAILABLE ON HOW CONFIGURE THE LIBRARY: https://RandomNerdTutorials.com/cyd/ or https://RandomNerdTutorials.com/esp32-tft/ */ +//#include + + +// Install the "XPT2046_Touchscreen" library by Paul Stoffregen to use the Touchscreen - https://github.com/PaulStoffregen/XPT2046_Touchscreen +// Note: this library doesn't require further configuration +#include + + +TFT_eSPI tft = TFT_eSPI(); + +// Touchscreen pins +#define XPT2046_IRQ 36 // T_IRQ +#define XPT2046_MOSI 32 // T_DIN +#define XPT2046_MISO 39 // T_OUT +#define XPT2046_CLK 25 // T_CLK +#define XPT2046_CS 33 // T_CS + +SPIClass touchscreenSPI = SPIClass(VSPI); +XPT2046_Touchscreen touchscreen(XPT2046_CS, XPT2046_IRQ); + +#define SCREEN_WIDTH 320 +#define SCREEN_HEIGHT 240 +#define FONT_SIZE 2 + +// Touchscreen coordinates: (x, y) and pressure (z) +int x, y, z; + +// Print Touchscreen info about X, Y and Pressure (Z) on the Serial Monitor +void printTouchToSerial(int touchX, int touchY, int touchZ) { + Serial.print("X = "); + Serial.print(touchX); + Serial.print(" | Y = "); + Serial.print(touchY); + Serial.print(" | Pressure = "); + Serial.print(touchZ); + Serial.println(); +} + +// Print Touchscreen info about X, Y and Pressure (Z) on the TFT Display +void printTouchToDisplay(int touchX, int touchY, int touchZ) { + // Clear TFT screen + tft.fillScreen(TFT_WHITE); + tft.setTextColor(TFT_BLACK, TFT_WHITE); + + int centerX = SCREEN_WIDTH / 2; + int textY = 80; + + String tempText = "X = " + String(touchX); + tft.drawCentreString(tempText, centerX, textY, FONT_SIZE); + + textY += 20; + tempText = "Y = " + String(touchY); + tft.drawCentreString(tempText, centerX, textY, FONT_SIZE); + + textY += 20; + tempText = "Pressure = " + String(touchZ); + tft.drawCentreString(tempText, centerX, textY, FONT_SIZE); +} + +void setup() { + Serial.begin(115200); + + // Start the SPI for the touchscreen and init the touchscreen + touchscreenSPI.begin(XPT2046_CLK, XPT2046_MISO, XPT2046_MOSI, XPT2046_CS); + touchscreen.begin(); + // Set the Touchscreen rotation in landscape mode + // Note: in some displays, the touchscreen might be upside down, so you might need to set the rotation to 3: touchscreen.setRotation(3); + touchscreen.setRotation(1); + + // Start the tft display + tft.init(); + // Set the TFT display rotation in landscape mode + tft.setRotation(1); + + // Clear the screen before writing to it + tft.fillScreen(TFT_WHITE); + tft.setTextColor(TFT_BLACK, TFT_WHITE); + + // Set X and Y coordinates for center of display + int centerX = SCREEN_WIDTH / 2; + int centerY = SCREEN_HEIGHT / 2; + + tft.drawCentreString("Hello, world!", centerX, 30, FONT_SIZE); + tft.drawCentreString("Touch screen to test", centerX, centerY, FONT_SIZE); +} + +void loop() { + // Checks if Touchscreen was touched, and prints X, Y and Pressure (Z) info on the TFT display and Serial Monitor + if (touchscreen.tirqTouched() && touchscreen.touched()) { + // Get Touchscreen points + TS_Point p = touchscreen.getPoint(); + // Calibrate Touchscreen points with map function to the correct width and height + x = map(p.x, 200, 3700, 1, SCREEN_WIDTH); + y = map(p.y, 240, 3800, 1, SCREEN_HEIGHT); + z = p.z; + + printTouchToSerial(x, y, z); + printTouchToDisplay(x, y, z); + + delay(100); + } +} + + + + + + + + + + + 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