commit
b6aa61f79b
7 changed files with 131 additions and 0 deletions
@ -0,0 +1,5 @@ |
|||||
|
.pio |
||||
|
.vscode/.browse.c_cpp.db* |
||||
|
.vscode/c_cpp_properties.json |
||||
|
.vscode/launch.json |
||||
|
.vscode/ipch |
||||
@ -0,0 +1,7 @@ |
|||||
|
{ |
||||
|
// See http://go.microsoft.com/fwlink/?LinkId=827846 |
||||
|
// for the documentation about the extensions.json format |
||||
|
"recommendations": [ |
||||
|
"platformio.platformio-ide" |
||||
|
] |
||||
|
} |
||||
@ -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 |
||||
@ -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 <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 |
||||
@ -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:uno] |
||||
|
platform = atmelavr |
||||
|
board = uno |
||||
|
framework = arduino |
||||
@ -0,0 +1,9 @@ |
|||||
|
#include <Arduino.h> |
||||
|
|
||||
|
void setup() { |
||||
|
// put your setup code here, to run once:
|
||||
|
} |
||||
|
|
||||
|
void loop() { |
||||
|
// put your main code here, to run repeatedly:
|
||||
|
} |
||||
@ -0,0 +1,11 @@ |
|||||
|
|
||||
|
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 |
||||
Loading…
Reference in new issue