From e9e4dd5fb3eb520fcabc2487ca4be68d763e8d9d Mon Sep 17 00:00:00 2001 From: "yorick.geoffre" Date: Wed, 22 Mar 2023 21:59:51 +0100 Subject: [PATCH] first commit --- espCode/.gitignore | 5 ++++ espCode/.vscode/extensions.json | 10 +++++++ espCode/.vscode/settings.json | 5 ++++ espCode/include/I2CManagement.hpp | 29 +++++++++++++++++++ espCode/include/PinDefinitions.hpp | 28 ++++++++++++++++++ espCode/include/README | 39 +++++++++++++++++++++++++ espCode/lib/README | 46 ++++++++++++++++++++++++++++++ espCode/platformio.ini | 20 +++++++++++++ espCode/src/main.cpp | 11 +++++++ espCode/test/README | 11 +++++++ 10 files changed, 204 insertions(+) create mode 100644 espCode/.gitignore create mode 100644 espCode/.vscode/extensions.json create mode 100644 espCode/.vscode/settings.json create mode 100644 espCode/include/I2CManagement.hpp create mode 100644 espCode/include/PinDefinitions.hpp create mode 100644 espCode/include/README create mode 100644 espCode/lib/README create mode 100644 espCode/platformio.ini create mode 100644 espCode/src/main.cpp create mode 100644 espCode/test/README diff --git a/espCode/.gitignore b/espCode/.gitignore new file mode 100644 index 0000000..89cc49c --- /dev/null +++ b/espCode/.gitignore @@ -0,0 +1,5 @@ +.pio +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/espCode/.vscode/extensions.json b/espCode/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/espCode/.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/espCode/.vscode/settings.json b/espCode/.vscode/settings.json new file mode 100644 index 0000000..1428c38 --- /dev/null +++ b/espCode/.vscode/settings.json @@ -0,0 +1,5 @@ +{ + "files.associations": { + "random": "cpp" + } +} \ No newline at end of file diff --git a/espCode/include/I2CManagement.hpp b/espCode/include/I2CManagement.hpp new file mode 100644 index 0000000..a4a7587 --- /dev/null +++ b/espCode/include/I2CManagement.hpp @@ -0,0 +1,29 @@ +#include +#include +#include + +class I2CDevice{ + protected: + int _writeAddress = 0x00; + int _readAddress = 0xFF; + std::string _name = ""; + public: + int getWriteAddress(){return _writeAddress;} + int getReadAddress(){return _readAddress;} + std::string getname(){return _name;} + virtual bool checkAlive(){return false;} +}; + +class I2CManager{ + protected: + static std::vector _Devices; + static int _pinSCL; + static int _pinSDA; + public: + static void Setup(int pinSDA, int pinSCL); + static void I2CWrite(int address, int value); + static int I2CRead(int address, int size); + static void writeToRegister8bit(int message, int targetRegister, int i2cAddress); + static void registerNewDevice(I2CDevice* device){_Devices.push_back(device);} + static void scanAll(); +}; \ No newline at end of file diff --git a/espCode/include/PinDefinitions.hpp b/espCode/include/PinDefinitions.hpp new file mode 100644 index 0000000..d31d8b1 --- /dev/null +++ b/espCode/include/PinDefinitions.hpp @@ -0,0 +1,28 @@ +#include +#include +#include +#include + +extern SemaphoreHandle_t serial_mutex; + +extern void THREAD_SAFE_PRINTLN(String data); + +enum debugLevel{ + data = 0, + error = 1, + warn = 2, + info = 3, + verbose = 4 //only use as a last resort, it makes things go real bad on the serial port +}; + +#define DEBUGLEVEL debugLevel::data + +#define LOG_DATA(x) do { if (DEBUGLEVEL >= debugLevel::data) { THREAD_SAFE_PRINTLN(String("D")+x); } } while (0) + +#define LOG_ERROR(x) do { if (DEBUGLEVEL >= debugLevel::error) { THREAD_SAFE_PRINTLN(String("E")+x); } } while (0) + +#define LOG_WARN(x) do { if (DEBUGLEVEL >= debugLevel::warn) { THREAD_SAFE_PRINTLN(String("W")+x); } } while (0) + +#define LOG_INFO(x) do { if (DEBUGLEVEL >= debugLevel::info) { THREAD_SAFE_PRINTLN(String("I")+x); }} while (0) + +#define LOG_VERBOSE(x) do { if (DEBUGLEVEL >= debugLevel::verbose) { THREAD_SAFE_PRINTLN(String("V")+x); }} while (0) \ No newline at end of file diff --git a/espCode/include/README b/espCode/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/espCode/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/espCode/lib/README b/espCode/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/espCode/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 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 +#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/espCode/platformio.ini b/espCode/platformio.ini new file mode 100644 index 0000000..9e65e7f --- /dev/null +++ b/espCode/platformio.ini @@ -0,0 +1,20 @@ +; 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:esp32-c3-devkitm-1] +platform = espressif32 @ 4.2.0 +board = esp32-c3-devkitm-1 +framework = arduino +monitor_speed = 460800 +build_flags = + -D ARDUINO_USB_MODE=1 + -D ARDUINO_USB_CDC_ON_BOOT=1 + -D SERIALCONS=USBSerial +platform_packages = framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32/releases/download/2.0.3/esp32-2.0.3.zip \ No newline at end of file diff --git a/espCode/src/main.cpp b/espCode/src/main.cpp new file mode 100644 index 0000000..b59ae0a --- /dev/null +++ b/espCode/src/main.cpp @@ -0,0 +1,11 @@ +#include + +void setup(){ +Serial.begin(460800); +Serial1.begin(9600,SERIAL_8N1, 4,5); // 4: tx, 5: rx +} + +void loop(){ + Serial.println(Serial1.readStringUntil('\n')); + delay(300); +} \ No newline at end of file diff --git a/espCode/test/README b/espCode/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/espCode/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