From b851795692d0b8bfd9bd7e66872779f3559598cc Mon Sep 17 00:00:00 2001 From: "Hudson C. Dalpra" Date: Wed, 7 Feb 2024 16:32:27 +1300 Subject: [PATCH] ci(repo): set up platformio project --- .editorconfig | 12 +++++ .github/CODEOWNERS | 3 ++ .github/workflows/ci.yml | 26 ++++++++++ .gitignore | 102 +++++++++++++++++++++++++++++++++++++++ .vscode/extensions.json | 10 ++++ README.md | 5 +- include/README | 38 +++++++++++++++ lib/README | 48 ++++++++++++++++++ platformio.ini | 14 ++++++ src/main.cpp | 16 ++++++ test/README | 11 +++++ 11 files changed, 283 insertions(+), 2 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/CODEOWNERS create mode 100644 .github/workflows/ci.yml 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/.editorconfig b/.editorconfig new file mode 100644 index 0000000..680d12c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +indent_style = space +indent_size = 8 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..0982fe5 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# Every request must be reviewed and accepted by: + +* @hcd-bdltd diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..dbe7eb9 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,26 @@ +name: PlatformIO CI + +on: + pull_request: + branches: ["main"] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - uses: actions/cache@v3 + with: + path: | + ~/.cache/pip + ~/.platformio/.cache + key: ${{ runner.os }}-pio + - uses: actions/setup-python@v4 + with: + python-version: "3.9" + - name: Install PlatformIO Core + run: pip install --upgrade platformio + + - name: Build PlatformIO Project + run: pio run diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7e11980 --- /dev/null +++ b/.gitignore @@ -0,0 +1,102 @@ +# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,platformio,c,c++ +# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,platformio,c,c++ + +### C ### +# Prerequisites +*.d + +# Object files +*.o +*.ko +*.obj +*.elf + +# Linker output +*.ilk +*.map +*.exp + +# Precompiled Headers +*.gch +*.pch + +# Libraries +*.lib +*.a +*.la +*.lo + +# Shared objects (inc. Windows DLLs) +*.dll +*.so +*.so.* +*.dylib + +# Executables +*.exe +*.out +*.app +*.i*86 +*.x86_64 +*.hex + +# Debug files +*.dSYM/ +*.su +*.idb +*.pdb + +# Kernel Module Compile Results +*.mod* +*.cmd +.tmp_versions/ +modules.order +Module.symvers +Mkfile.old +dkms.conf + +### C++ ### +# Prerequisites + +# Compiled Object files +*.slo + +# Precompiled Headers + +# Compiled Dynamic libraries + +# Fortran module files +*.mod +*.smod + +# Compiled Static libraries +*.lai + +# Executables + +### PlatformIO ### +.pioenvs +.piolibdeps +.clang_complete +.gcc-flags.json +.pio + +### VisualStudioCode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/extensions.json +!.vscode/*.code-snippets + +# Local History for Visual Studio Code +.history/ + +# Built Visual Studio Code Extensions +*.vsix + +### VisualStudioCode Patch ### +# Ignore all local history of files +.history +.ionide + +# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,platformio,c,c++ 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/README.md b/README.md index 36e8972..3da66a6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ -# simple-foc-tuning -SimpleFOC auto-tuning example +# SimpleFOC tuning + +SimpleFOC auto-tuning example using [SimpleFOC](https://simplefoc.com/) with [B-G431B-ESC1](https://www.st.com/en/evaluation-tools/b-g431b-esc1.html) diff --git a/include/README b/include/README new file mode 100644 index 0000000..2031e8f --- /dev/null +++ b/include/README @@ -0,0 +1,38 @@ +# 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 + + diff --git a/lib/README b/lib/README new file mode 100644 index 0000000..7d4723b --- /dev/null +++ b/lib/README @@ -0,0 +1,48 @@ +# 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) +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: + +``` 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 + +- diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..11bff8f --- /dev/null +++ b/platformio.ini @@ -0,0 +1,14 @@ +; 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:disco_b_g431b_esc1] +platform = ststm32 +board = disco_b_g431b_esc1 +framework = arduino diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..2f114cc --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,16 @@ +#include + +// put function declarations here: +int myFunction(int, int); + +void setup() { + // put your setup code here, to run once: + int result = myFunction(2, 3); +} + +void loop() { + // put your main code here, to run repeatedly: +} + +// put function definitions here: +int myFunction(int x, int y) { return x + y; } diff --git a/test/README b/test/README new file mode 100644 index 0000000..a4e642b --- /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: + +-