Restructured code files

This commit is contained in:
erwin 2023-06-29 21:45:54 +02:00
parent 4a34a7768c
commit 4c009ec225
8 changed files with 127 additions and 148 deletions

14
code/.gitignore vendored
View File

@ -1,14 +0,0 @@
# ---> VisualStudioCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets
# Local History for Visual Studio Code
.history/
# Built Visual Studio Code Extensions
*.vsix

127
code/.vscode/c_cpp_properties.json vendored Normal file
View File

@ -0,0 +1,127 @@
//
// !!! WARNING !!! AUTO-GENERATED FILE!
// PLEASE DO NOT MODIFY IT AND USE "platformio.ini":
// https://docs.platformio.org/page/projectconf/section_env_build.html#build-flags
//
{
"configurations": [
{
"name": "PlatformIO",
"includePath": [
"/home/erwin/Projects/Active/wastebin-notifier/include",
"/home/erwin/Projects/Active/wastebin-notifier/src",
"/home/erwin/Projects/Active/wastebin-notifier/.pio/libdeps/d1_mini_pro/FastLED/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SoftwareSerial/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SPI",
"/home/erwin/Projects/Active/wastebin-notifier/.pio/libdeps/d1_mini_pro/ArduinoJson/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/tools/sdk/include",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/tools/sdk/libc/xtensa-lx106-elf/include",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/cores/esp8266",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/tools/sdk/lwip2/include",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/variants/d1_mini",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ArduinoOTA",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/DNSServer/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/EEPROM",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266AVRISP/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266HTTPClient/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266HTTPUpdateServer/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266LLMNR",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266NetBIOS",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266SSDP",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266SdFat/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266WebServer/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266WiFi/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266WiFiMesh/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266httpUpdate/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266mDNS/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Ethernet/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/GDBStub/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Hash/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/LittleFS/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SD/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SDFS/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SPISlave/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Servo/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/TFT_Touch_Shield_V2",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Ticker/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Wire",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/esp8266/src",
"/home/erwin/.platformio/packages/tool-unity",
""
],
"browse": {
"limitSymbolsToIncludedHeaders": true,
"path": [
"/home/erwin/Projects/Active/wastebin-notifier/include",
"/home/erwin/Projects/Active/wastebin-notifier/src",
"/home/erwin/Projects/Active/wastebin-notifier/.pio/libdeps/d1_mini_pro/FastLED/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SoftwareSerial/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SPI",
"/home/erwin/Projects/Active/wastebin-notifier/.pio/libdeps/d1_mini_pro/ArduinoJson/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/tools/sdk/include",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/tools/sdk/libc/xtensa-lx106-elf/include",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/cores/esp8266",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/tools/sdk/lwip2/include",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/variants/d1_mini",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ArduinoOTA",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/DNSServer/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/EEPROM",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266AVRISP/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266HTTPClient/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266HTTPUpdateServer/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266LLMNR",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266NetBIOS",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266SSDP",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266SdFat/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266WebServer/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266WiFi/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266WiFiMesh/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266httpUpdate/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/ESP8266mDNS/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Ethernet/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/GDBStub/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Hash/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/LittleFS/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SD/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SDFS/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/SPISlave/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Servo/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/TFT_Touch_Shield_V2",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Ticker/src",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/Wire",
"/home/erwin/.platformio/packages/framework-arduinoespressif8266/libraries/esp8266/src",
"/home/erwin/.platformio/packages/tool-unity",
""
]
},
"defines": [
"PLATFORMIO=50004",
"ESP8266",
"ARDUINO_ARCH_ESP8266",
"ARDUINO_ESP8266_WEMOS_D1MINIPRO",
"F_CPU=80000000L",
"__ets__",
"ICACHE_FLASH",
"ARDUINO=10805",
"ARDUINO_BOARD=\"PLATFORMIO_D1_MINI_PRO\"",
"FLASHMODE_DIO",
"LWIP_OPEN_SRC",
"NONOSDK22x_190703=1",
"TCP_MSS=536",
"LWIP_FEATURES=1",
"LWIP_IPV6=0",
"VTABLES_IN_FLASH",
""
],
"cStandard": "c99",
"cppStandard": "c++11",
"compilerPath": "/home/erwin/.platformio/packages/toolchain-xtensa/bin/xtensa-lx106-elf-gcc",
"compilerArgs": [
"-mlongcalls",
"-mtext-section-literals",
""
]
}
],
"version": 4
}

View File

@ -1,39 +0,0 @@
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

View File

@ -1,46 +0,0 @@
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 a 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 <Foo.h>
#include <Bar.h>
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

View File

@ -1,14 +0,0 @@
; 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_mini_pro]
platform = espressif8266
board = d1_mini_pro
framework = arduino

View File

@ -1,9 +0,0 @@
#include <Arduino.h>
void setup() {
// put your setup code here, to run once:
}
void loop() {
// put your main code here, to run repeatedly:
}

View File

@ -1,15 +0,0 @@
#ifndef MAIN_H
#define MAIN_H
#define PIN_LEDSTRIP D2
#define PIN_SWITCH_DISABLE D4
#define PIN_SWITCH_ACTIVE D3
#define NUM_LEDS 5
#define BRIGHTNESS 127
#define LED_TYPE WS2811
#define COLOR_ORDER GRB
void display(CRGB color, bool blink);
#endif

View File

@ -1,11 +0,0 @@
This directory is intended for PlatformIO Unit Testing 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/page/plus/unit-testing.html