diff --git a/docs/platformio_doc.md b/docs/platformio_doc.md old mode 100644 new mode 100755 index a207793..85ebb95 --- a/docs/platformio_doc.md +++ b/docs/platformio_doc.md @@ -1,4 +1,7 @@ + + + ## platformio_library
@@ -116,10 +119,11 @@ expected by PlatformIO.
 
 
 
+
 ## platformio_project
 
 
-platformio_project(name, board, deps, environment_kwargs, framework, platform, src)
+platformio_project(name, board, build_flags, deps, environment_kwargs, framework, platform, src)
 
@@ -173,6 +177,19 @@ mandatory.

+ + build_flags + + List of strings; optional +

+ A list of strings, any provided strings will directly appear in the +generated platformio.ini file in the build_flags option for the selected +env:board section. Refer to the [Project Configuration File manual]( +http://docs.platformio.org/en/latest/projectconf.html) for the available +options. +

+ + deps @@ -234,201 +251,3 @@ the project that contains the Arduino setup() and loop() functions. This is mand -## _emit_build_action - -
-_emit_build_action(ctx, project_dir)
-
- -Emits a Bazel action that unzips the libraries and builds the project. - -### Parameters - - - - - - - - - - - - -
project_dir - required. -

- A string, the main directory of the PlatformIO project. - This is where the zip files will be extracted. -

-
- - -## _emit_executable_action - -
-_emit_executable_action(ctx)
-
- -Emits a Bazel action that produces executable script. - -When the script is executed, the compiled firmware gets uploaded to the -Arduino device. - - -### Parameters - - - - - - - - ctx) - - -Emits a Bazel action that generates the PlatformIO configuration file. - -### Parameters - -
- - - - - - ctx) - - -Emits a Bazel action that outputs the project main C++ file. - -### Parameters - -
- - - - - - ctx) - - -Collects all transitive dependencies and emits the zip output. - -Outputs a zip file containing the library in the directory structure expected -by PlatformIO. - - -### Parameters - -
- - - - - - ctx) - - -Builds and optionally uploads (when executed) a PlatformIO project. - -Outputs the C++ source file containing the Arduino setup() and loop() -functions renamed according to PlatformIO needs, a platformio_ini with the -project configuration file for PlatformIO and the firmware. The firmware_elf -is the compiled version of the Arduino firmware for the specified board. - - -### Parameters - -
- - - - - -