File tree 6 files changed +197
-0
lines changed
6 files changed +197
-0
lines changed Original file line number Diff line number Diff line change
1
+ .pio
2
+ .pioenvs
3
+ .piolibdeps
4
+ .vscode
Original file line number Diff line number Diff line change
1
+ # Continuous Integration (CI) is the practice, in software
2
+ # engineering, of merging all developer working copies with a shared mainline
3
+ # several times a day < https://docs.platformio.org/page/ci/index.html >
4
+ #
5
+ # Documentation:
6
+ #
7
+ # * Travis CI Embedded Builds with PlatformIO
8
+ # < https://docs.travis-ci.com/user/integration/platformio/ >
9
+ #
10
+ # * PlatformIO integration with Travis CI
11
+ # < https://docs.platformio.org/page/ci/travis.html >
12
+ #
13
+ # * User Guide for `platformio ci` command
14
+ # < https://docs.platformio.org/page/userguide/cmd_ci.html >
15
+ #
16
+ #
17
+ # Please choose one of the following templates (proposed below) and uncomment
18
+ # it (remove "# " before each line) or use own configuration according to the
19
+ # Travis CI documentation (see above).
20
+ #
21
+
22
+
23
+ #
24
+ # Template #1: General project. Test it using existing `platformio.ini`.
25
+ #
26
+
27
+ # language: python
28
+ # python:
29
+ # - "2.7"
30
+ #
31
+ # sudo: false
32
+ # cache:
33
+ # directories:
34
+ # - "~/.platformio"
35
+ #
36
+ # install:
37
+ # - pip install -U platformio
38
+ # - platformio update
39
+ #
40
+ # script:
41
+ # - platformio run
42
+
43
+
44
+ #
45
+ # Template #2: The project is intended to be used as a library with examples.
46
+ #
47
+
48
+ # language: python
49
+ # python:
50
+ # - "2.7"
51
+ #
52
+ # sudo: false
53
+ # cache:
54
+ # directories:
55
+ # - "~/.platformio"
56
+ #
57
+ # env:
58
+ # - PLATFORMIO_CI_SRC=path/to/test/file.c
59
+ # - PLATFORMIO_CI_SRC=examples/file.ino
60
+ # - PLATFORMIO_CI_SRC=path/to/test/directory
61
+ #
62
+ # install:
63
+ # - pip install -U platformio
64
+ # - platformio update
65
+ #
66
+ # script:
67
+ # - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N
Original file line number Diff line number Diff line change
1
+
2
+ This directory is intended for project header files.
3
+
4
+ A header file is a file containing C declarations and macro definitions
5
+ to be shared between several project source files. You request the use of a
6
+ header file in your project source file (C, C++, etc) located in `src` folder
7
+ by including it, with the C preprocessing directive `#include'.
8
+
9
+ ```src/main.c
10
+
11
+ #include "header.h"
12
+
13
+ int main (void)
14
+ {
15
+ ...
16
+ }
17
+ ```
18
+
19
+ Including a header file produces the same results as copying the header file
20
+ into each source file that needs it. Such copying would be time-consuming
21
+ and error-prone. With a header file, the related declarations appear
22
+ in only one place. If they need to be changed, they can be changed in one
23
+ place, and programs that include the header file will automatically use the
24
+ new version when next recompiled. The header file eliminates the labor of
25
+ finding and changing all the copies as well as the risk that a failure to
26
+ find one copy will result in inconsistencies within a program.
27
+
28
+ In C, the usual convention is to give header files names that end with `.h'.
29
+ It is most portable to use only letters, digits, dashes, and underscores in
30
+ header file names, and at most one dot.
31
+
32
+ Read more about using header files in official GCC documentation:
33
+
34
+ * Include Syntax
35
+ * Include Operation
36
+ * Once-Only Headers
37
+ * Computed Includes
38
+
39
+ https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
Original file line number Diff line number Diff line change
1
+
2
+ This directory is intended for project specific (private) libraries.
3
+ PlatformIO will compile them to static libraries and link into executable file.
4
+
5
+ The source code of each library should be placed in a an own separate directory
6
+ ("lib/your_library_name/[here are source files]").
7
+
8
+ For example, see a structure of the following two libraries `Foo` and `Bar`:
9
+
10
+ |--lib
11
+ | |
12
+ | |--Bar
13
+ | | |--docs
14
+ | | |--examples
15
+ | | |--src
16
+ | | |- Bar.c
17
+ | | |- Bar.h
18
+ | | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
19
+ | |
20
+ | |--Foo
21
+ | | |- Foo.c
22
+ | | |- Foo.h
23
+ | |
24
+ | |- README --> THIS FILE
25
+ |
26
+ |- platformio.ini
27
+ |--src
28
+ |- main.c
29
+
30
+ and a contents of `src/main.c`:
31
+ ```
32
+ #include <Foo.h>
33
+ #include <Bar.h>
34
+
35
+ int main (void)
36
+ {
37
+ ...
38
+ }
39
+
40
+ ```
41
+
42
+ PlatformIO Library Dependency Finder will find automatically dependent
43
+ libraries scanning project source files.
44
+
45
+ More information about PlatformIO Library Dependency Finder
46
+ - https://docs.platformio.org/page/librarymanager/ldf.html
Original file line number Diff line number Diff line change
1
+ ; PlatformIO Project Configuration File
2
+ ;
3
+ ; Build options: build flags, source filter
4
+ ; Upload options: custom upload port, speed and extra flags
5
+ ; Library options: dependencies, extra library storages
6
+ ; Advanced options: extra scripting
7
+ ;
8
+ ; Please visit documentation for the other options and examples
9
+ ; https://docs.platformio.org/page/projectconf.html
10
+
11
+ [platformio]
12
+ src_dir = wled00
13
+
14
+ [env:esp01]
15
+ platform = espressif8266
16
+ board = esp01
17
+ framework = arduino
18
+ monitor_speed = 115200
19
+ ; lib_ldf_mode = chain+ # for overwriting MQTT_MAX_PACKET_SIZE in MqttJsonClient.h, see: http://docs.platformio.org/en/latest/librarymanager/ldf.html#ldf-mode
20
+ ; build_flags = -DMQTT_MAX_PACKET_SIZE
21
+ lib_deps =
22
+ Blynk
23
+ PubSubClient
24
+ E131
25
+ Time
26
+ Timezone
27
+ webserver
28
+ WS2812FX
29
+ NeoPixelBus
30
+ FastLED
Original file line number Diff line number Diff line change
1
+
2
+ This directory is intended for PIO Unit Testing and project tests.
3
+
4
+ Unit Testing is a software testing method by which individual units of
5
+ source code, sets of one or more MCU program modules together with associated
6
+ control data, usage procedures, and operating procedures, are tested to
7
+ determine whether they are fit for use. Unit testing finds problems early
8
+ in the development cycle.
9
+
10
+ More information about PIO Unit Testing:
11
+ - https://docs.platformio.org/page/plus/unit-testing.html
You can’t perform that action at this time.
0 commit comments