diff --git a/program/SVET/.gitignore b/program/SVET/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/program/SVET/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/program/SVET/.vscode/extensions.json b/program/SVET/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/program/SVET/.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/program/SVET/include/README b/program/SVET/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/program/SVET/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/program/SVET/lib/README b/program/SVET/lib/README new file mode 100644 index 0000000..2593a33 --- /dev/null +++ b/program/SVET/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/program/SVET/platformio.ini b/program/SVET/platformio.ini new file mode 100644 index 0000000..67b7a07 --- /dev/null +++ b/program/SVET/platformio.ini @@ -0,0 +1,16 @@ +; 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 +monitor_rts = 0 +upload_speed = 378000 \ No newline at end of file diff --git a/program/SVET/src/core/SVETCore.cpp b/program/SVET/src/core/SVETCore.cpp new file mode 100644 index 0000000..cdb0be9 --- /dev/null +++ b/program/SVET/src/core/SVETCore.cpp @@ -0,0 +1,23 @@ +#include "SVETCore.h" + +/// @brief Method for run SVET Core (Must be placed on start() in main.cpp or main.ino) +/// @return true is start was successful or false if not +bool SVETCore::Start(){ + logger->Log("SVET Core is starting..."); + return true; +} +/// @brief Method for update SVET Core (Must be placed on loop() in main.cpp or main.ino) +void SVETCore::Loop(){ +} + +/// @brief Creating new instance of SVETCore. Can be the only one on the project +SVETCore::SVETCore(){ + logger = new Debug(); +} + +/// @brief Creating new instance of SVETCore. Can be the only one on the project +/// @param showDebugInfo Turn on or off debug info from SVETCore (Debug instance will still work) +/// @param baudRate Speed of serial port for Debug instance +SVETCore::SVETCore(bool showDebugInfo, short baudRate = 9600) : SVETCore(){ + this->showDebugInfo = showDebugInfo; +} \ No newline at end of file diff --git a/program/SVET/src/core/SVETCore.h b/program/SVET/src/core/SVETCore.h new file mode 100644 index 0000000..febe0aa --- /dev/null +++ b/program/SVET/src/core/SVETCore.h @@ -0,0 +1,11 @@ +#include "debug/Debug.h" + +class SVETCore{ + bool showDebugInfo{true}; +public: + Debug* logger; + bool Start(); + void Loop(); + SVETCore(); + SVETCore(bool showDebugInfo, short baudRate = 9600); +}; \ No newline at end of file diff --git a/program/SVET/src/core/debug/Debug.cpp b/program/SVET/src/core/debug/Debug.cpp new file mode 100644 index 0000000..b24e2f9 --- /dev/null +++ b/program/SVET/src/core/debug/Debug.cpp @@ -0,0 +1,70 @@ +#include "Debug.h" +#include +#include +/// @brief Creating new instance of a debug logger (Using HardwareSerial class) Can be the only one on the project +/// @param baudRate Speed of serial port +Debug::Debug(short baudRate = 9600, bool isCoreDebugAllowed = true){ + this->isCoreDebugAllowed = isCoreDebugAllowed; + if(!Serial) + Serial.begin(baudRate); +} +Debug::~Debug(){ + if(Serial) + Serial.end(); +} +char* Debug::messageTypeToString(MessageType messageType){ + switch (messageType) + { + case MessageType::LOG: + return "LOG"; + case MessageType::WARN: + return "WARN"; + case MessageType::ERROR: + return "ERROR"; + } +} +const char* Debug::getMessage(MessageType messageType, char* text){ + std::string output; + output.append("["); + output.append(messageTypeToString(messageType)); + output.append("]: "); + output.append(text); + return output.c_str(); +} +void Debug::Log(char* text){ + Serial.write(27); + Serial.print("[37;40m"); + Serial.println(getMessage(MessageType::LOG, text)); +} +void Debug::Warn(char* text){ + Serial.write(27); + Serial.print("[33;40m"); + Serial.println(getMessage(MessageType::WARN, text)); +} +void Debug::Error(char* text){ + Serial.write(27); + Serial.print("[31;40m"); + Serial.println(getMessage(MessageType::ERROR, text)); +} + +void Debug::CoreLog(char* text){ + if(!isCoreDebugAllowed) + return; + Serial.write(27); + Serial.print("[37;40m CORE:"); + Serial.println(getMessage(MessageType::LOG, text)); +} +void Debug::CoreWarn(char* text){ + if(!isCoreDebugAllowed) + return; + Serial.write(27); + Serial.print("[33;40m CORE:"); + Serial.println(getMessage(MessageType::WARN, text)); +} +void Debug::CoreError(char* text){ + if(!isCoreDebugAllowed) + return; + Serial.write(27); + Serial.print("[31;40m CORE:"); + Serial.println(getMessage(MessageType::ERROR, text)); +} \ No newline at end of file diff --git a/program/SVET/src/core/debug/Debug.h b/program/SVET/src/core/debug/Debug.h new file mode 100644 index 0000000..1efff95 --- /dev/null +++ b/program/SVET/src/core/debug/Debug.h @@ -0,0 +1,22 @@ +enum MessageType{ + LOG, + WARN, + ERROR +}; + +class Debug{ +private: + bool isCoreDebugAllowed{true}; + char* messageTypeToString(MessageType messageType); + const char* getMessage(MessageType messageType, char* text); +public: + void Log(char* text); + void Warn(char* text); + void Error(char* text); + + void CoreLog(char* text); + void CoreWarn(char* text); + void CoreError(char* text); + Debug(short baudRate = 9600, bool isCoreDebugAllowed = true); + ~Debug(); +}; \ No newline at end of file diff --git a/program/SVET/src/main.cpp b/program/SVET/src/main.cpp new file mode 100644 index 0000000..dab4ff8 --- /dev/null +++ b/program/SVET/src/main.cpp @@ -0,0 +1,15 @@ +#include +#include +#include "core/SVETCore.h" + +std::unique_ptr core; +void setup() { + bool isStarted{false}; + do{ + isStarted = core->Start(); + }while (!isStarted); +} + +void loop() { + core->Loop(); +} \ No newline at end of file