commit e75dc39664d216bf6539c3e2b98bcb3136d9d2f3 Author: zzzz Date: Thu Apr 25 22:41:36 2024 +0200 Project setup (Display, Servo, TouchBtn) 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..f8041db --- /dev/null +++ b/platformio.ini @@ -0,0 +1,17 @@ +; 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:d1] +platform = espressif8266 +board = d1 +framework = arduino +lib_deps = + contrem/arduino-timer@^3.0.1 + adafruit/Adafruit SSD1306@^2.5.9 diff --git a/src/SmartServo.cpp b/src/SmartServo.cpp new file mode 100644 index 0000000..43d1217 --- /dev/null +++ b/src/SmartServo.cpp @@ -0,0 +1,54 @@ +#include +#include + +class SmartServo +{ +public: + SmartServo(int pin) + { + myservo.attach(pin); + } + + static bool bounceServo(SmartServo *servo) + { + if (servo->toggle) + { + servo->moveServoToZero(); + } + else + { + servo->moveServoTo180(); + } + servo->toggle = !servo->toggle; + return true; + } + + void moveServoToZero() + { + moveServoTo(0, 10); + } + void moveServoTo180() + { + moveServoTo(180, 5); + } + + // Note: This blocks execution until servo finished moving. + void moveServoTo(int pos, int stepSize) + { + int currentPos = myservo.read(); + for (int p = currentPos; p < pos; p += stepSize) + { + myservo.write(p); + delay(10); + } + for (int p = currentPos; p > pos; p -= stepSize) + { + myservo.write(p); + delay(10); + } + } + +private: + Servo myservo; + bool toggle = false; +}; \ No newline at end of file diff --git a/src/SmartServo.hpp b/src/SmartServo.hpp new file mode 100644 index 0000000..c168202 --- /dev/null +++ b/src/SmartServo.hpp @@ -0,0 +1,11 @@ +#pragma once + +class SmartServo +{ +public: + SmartServo(int pin); + void moveServoTo(int pos, int stepSize); + void moveServoToZero(); + void moveServoTo180(); + bool bounceServo(void *); +}; \ No newline at end of file diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..b19c0c8 --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,68 @@ +#include +#include +#include + +#include +#include +#include +#include + +#include "main.hpp" +#include "SmartServo.cpp" + +#define WIRE Wire + +#define DISPLAY_PIN 4 // D2 (SDA) +#define SERVO_PIN 2 // D4 +#define TOUCH_BTN_PIN 0 // D3 + +auto display = Adafruit_SSD1306(128, 32, &WIRE); + +auto timer = timer_create_default(); + +SmartServo smartServo(SERVO_PIN); + +void setup() +{ + // Serial.begin(9600); + + pinMode(LED_BUILTIN, OUTPUT); + pinMode(TOUCH_BTN_PIN, INPUT); + + display.begin(SSD1306_SWITCHCAPVCC, 0x3C); // Address 0x3C for 128x32 + // Show image buffer on the display hardware. + // Since the buffer is intialized with an Adafruit splashscreen + // internally, this will display the splashscreen. + display.display(); + + // Clear the buffer. + // display.clearDisplay(); + // display.display(); + + smartServo.moveServoToZero(); + + // timer.every(1000, toggle_led); + // timer.every(2000, reinterpret_cast::handler_t>(SmartServo::bounceServo), &smartServo); +} + +void loop() +{ + timer.tick(); + + if (digitalRead(TOUCH_BTN_PIN) == HIGH) + { + digitalWrite(LED_BUILTIN, HIGH); + } + else + { + digitalWrite(LED_BUILTIN, LOW); + } + + // display.display(); +} + +bool toggle_led(void *) +{ + digitalWrite(LED_BUILTIN, !digitalRead(LED_BUILTIN)); + return true; // repeat? true +} \ No newline at end of file diff --git a/src/main.hpp b/src/main.hpp new file mode 100644 index 0000000..43659e5 --- /dev/null +++ b/src/main.hpp @@ -0,0 +1 @@ +bool toggle_led(void *); \ No newline at end of file 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