From 2b0c07119853d66581079f674bb993251c4afc46 Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 12 Apr 2022 19:44:46 +0200 Subject: [PATCH] Add Arduino-Pico example --- .../arduino-blink-earlephilhower/.gitignore | 1 + .../arduino-blink-earlephilhower/README.md | 25 ++++++++++ .../include/README | 39 ++++++++++++++++ .../arduino-blink-earlephilhower/lib/README | 46 +++++++++++++++++++ .../platformio.ini | 21 +++++++++ .../arduino-blink-earlephilhower/src/main.cpp | 15 ++++++ .../arduino-blink-earlephilhower/test/README | 11 +++++ 7 files changed, 158 insertions(+) create mode 100644 examples/arduino-blink-earlephilhower/.gitignore create mode 100644 examples/arduino-blink-earlephilhower/README.md create mode 100644 examples/arduino-blink-earlephilhower/include/README create mode 100644 examples/arduino-blink-earlephilhower/lib/README create mode 100644 examples/arduino-blink-earlephilhower/platformio.ini create mode 100644 examples/arduino-blink-earlephilhower/src/main.cpp create mode 100644 examples/arduino-blink-earlephilhower/test/README diff --git a/examples/arduino-blink-earlephilhower/.gitignore b/examples/arduino-blink-earlephilhower/.gitignore new file mode 100644 index 0000000..03f4a3c --- /dev/null +++ b/examples/arduino-blink-earlephilhower/.gitignore @@ -0,0 +1 @@ +.pio diff --git a/examples/arduino-blink-earlephilhower/README.md b/examples/arduino-blink-earlephilhower/README.md new file mode 100644 index 0000000..1d46eff --- /dev/null +++ b/examples/arduino-blink-earlephilhower/README.md @@ -0,0 +1,25 @@ +How to build PlatformIO based project +===================================== + +<<<<<<< HEAD +1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html) +======= +1. [Install PlatformIO Core](https://docs.platformio.org/page/core.html) +>>>>>>> e08da697f0a750d5ebdd17d299d262b729e67c42 +2. Download [development platform with examples](https://github.com/platformio/platform-raspberrypi/archive/develop.zip) +3. Extract ZIP archive +4. Run these commands: + +```shell +# Change directory to example +$ cd platform-raspberrypi/examples/arduino-blink + +# Build project +$ pio run + +# Upload firmware +$ pio run --target upload + +# Clean build files +$ pio run --target clean +``` diff --git a/examples/arduino-blink-earlephilhower/include/README b/examples/arduino-blink-earlephilhower/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/examples/arduino-blink-earlephilhower/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/examples/arduino-blink-earlephilhower/lib/README b/examples/arduino-blink-earlephilhower/lib/README new file mode 100644 index 0000000..6debab1 --- /dev/null +++ b/examples/arduino-blink-earlephilhower/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/examples/arduino-blink-earlephilhower/platformio.ini b/examples/arduino-blink-earlephilhower/platformio.ini new file mode 100644 index 0000000..86a3b50 --- /dev/null +++ b/examples/arduino-blink-earlephilhower/platformio.ini @@ -0,0 +1,21 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter, extra scripting +; Upload options: custom port, speed and extra flags +; Library options: dependencies, extra library storages +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[env] +platform = raspberrypi +framework = arduino +platform_packages = + maxgerhardt/framework-arduinopico@https://github.com/earlephilhower/arduino-pico.git + maxgerhardt/toolchain-pico@https://github.com/earlephilhower/pico-quick-toolchain/releases/download/1.3.3-a/x86_64-linux-gnu.arm-none-eabi-ed6d983.220212.tar.gz + +[env:pico] +board = pico + +[env:nanorp2040connect] +board = nanorp2040connect diff --git a/examples/arduino-blink-earlephilhower/src/main.cpp b/examples/arduino-blink-earlephilhower/src/main.cpp new file mode 100644 index 0000000..8c4e60f --- /dev/null +++ b/examples/arduino-blink-earlephilhower/src/main.cpp @@ -0,0 +1,15 @@ +#include + +// the setup routine runs once when you press reset: +void setup() { + // initialize the digital pin as an output. + pinMode(LED_BUILTIN, OUTPUT); +} + +// the loop routine runs over and over again forever: +void loop() { + digitalWrite(LED_BUILTIN, HIGH); // turn the LED on (HIGH is the voltage level) + delay(1000); // wait for a second + digitalWrite(LED_BUILTIN, LOW); // turn the LED off by making the voltage LOW + delay(1000); // wait for a second +} diff --git a/examples/arduino-blink-earlephilhower/test/README b/examples/arduino-blink-earlephilhower/test/README new file mode 100644 index 0000000..df5066e --- /dev/null +++ b/examples/arduino-blink-earlephilhower/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PIO 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 PIO Unit Testing: +- https://docs.platformio.org/page/plus/unit-testing.html