Add new examples for mbed-based Arduino core

Author: valeros

.github/workflows/examples.yml

@@ -13,6 +13,8 @@ jobs:
           - "examples/arduino-blink"
           - "examples/arduino-external-libs"
           - "examples/arduino-internal-libs"
+          - "examples/arduino-mbed-doom"
+          - "examples/arduino-mbed-rpc"
           - "examples/arduino-mxchip-azureiot"
           - "examples/arduino-mxchip-filesystem"
           - "examples/arduino-mxchip-sensors"

examples/arduino-mbed-doom/.gitignore

@@ -0,0 +1 @@
+.pio

examples/arduino-mbed-doom/.travis.yml

@@ -0,0 +1,67 @@
+# Continuous Integration (CI) is the practice, in software
+# engineering, of merging all developer working copies with a shared mainline
+# several times a day < https://docs.platformio.org/page/ci/index.html >
+#
+# Documentation:
+#
+# * Travis CI Embedded Builds with PlatformIO
+#   < https://docs.travis-ci.com/user/integration/platformio/ >
+#
+# * PlatformIO integration with Travis CI
+#   < https://docs.platformio.org/page/ci/travis.html >
+#
+# * User Guide for `platformio ci` command
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
+#
+#
+# Please choose one of the following templates (proposed below) and uncomment
+# it (remove "# " before each line) or use own configuration according to the
+# Travis CI documentation (see above).
+#
+
+
+#
+# Template #1: General project. Test it using existing `platformio.ini`.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio run
+
+
+#
+# Template #2: The project is intended to be used as a library with examples.
+#
+
+# language: python
+# python:
+#     - "2.7"
+#
+# sudo: false
+# cache:
+#     directories:
+#         - "~/.platformio"
+#
+# env:
+#     - PLATFORMIO_CI_SRC=path/to/test/file.c
+#     - PLATFORMIO_CI_SRC=examples/file.ino
+#     - PLATFORMIO_CI_SRC=path/to/test/directory
+#
+# install:
+#     - pip install -U platformio
+#     - platformio update
+#
+# script:
+#     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N

examples/arduino-mbed-doom/README.rst

@@ -0,0 +1,32 @@
+..  Copyright 2014-present PlatformIO <[email protected]>
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+       http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+How to build PlatformIO based project
+=====================================
+
+1. `Install PlatformIO Core <http://docs.platformio.org/page/core.html>`_
+2. Download `development platform with examples <https://github.com/platformio/platform-nordicnrf52/archive/develop.zip>`_
+3. Extract ZIP archive
+4. Run these commands:
+
+.. code-block:: bash
+
+    # Change directory to example
+    > cd platform-nordicnrf52/examples/arduino-mbed-doom
+
+    # Build project
+    > platformio run
+
+    # Upload firmware
+    > platformio run --target upload
+
+    # Clean build files
+    > platformio run --target clean

examples/arduino-mbed-doom/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

examples/arduino-mbed-doom/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 <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

examples/arduino-mbed-doom/platformio.ini

@@ -0,0 +1,15 @@
+; 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
+; http://docs.platformio.org/page/projectconf.html
+
+[env:portenta_h7_m7]
+platform = ststm32
+framework = arduino
+board = portenta_h7_m7
+lib_deps = 
+    Portenta_Video

examples/arduino-mbed-doom/src/Doom.cpp

@@ -0,0 +1,57 @@
+/*  Arduino wrapper for DoomGeneric
+ *  Mouse and keyboard controls are not implemented at the moment; 
+ *  to use the internal QSPI flash as storage, force the board in bootloader mode 
+ *  by double clicking the reset button and upload doom.fat.dump (from doom/utils folder)
+ *  with this command
+ *  
+ *  dfu-util -a1 --device 0x2341:0x035b -D doom.fat.dump --dfuse-address=0x90000000
+ */
+
+#include <Arduino.h>
+
+#include "QSPIFBlockDevice.h"
+#include "FATFileSystem.h"
+#include "doomgeneric.h"
+
+QSPIFBlockDevice block_device(PD_11, PD_12, PF_7, PD_13,  PF_10, PG_6, QSPIF_POLARITY_MODE_1, 40000000);
+// Comment previous line and uncomment these two if you want to store DOOM.WAD in an external SD card (FAT32 formatted)
+// #include "SDMMCBlockDevice.h"
+// SDMMCBlockDevice block_device;
+
+mbed::FATFileSystem fs("fs");
+
+extern "C" int main_wrapper(int argc, char **argv);
+char*argv[] = {"/fs/doom", "-iwad", "/fs/DOOM1.WAD"};
+
+void setup() {
+  // put your setup code here, to run once:
+  delay(2000);
+  int err =  fs.mount(&block_device);
+
+  if (err) {
+    // Reformat if we can't mount the filesystem
+    // this should only happen on the first boot
+    printf("No filesystem found, formatting... ");
+    fflush(stdout);
+    err = fs.reformat(&block_device);
+  }
+  DIR *dir;
+  struct dirent *ent;
+  printf("try to open dir\n");
+  if ((dir = opendir("/fs")) != NULL) {
+    /* print all the files and directories within directory */
+    while ((ent = readdir (dir)) != NULL) {
+      printf ("%s\n", ent->d_name);
+    }
+    closedir (dir);
+  } else {
+    /* could not open directory */
+    printf ("error\n");
+  }
+  main_wrapper(3, argv);
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+
+}

examples/arduino-mbed-doom/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

examples/arduino-mbed-rpc/.gitignore

@@ -0,0 +1 @@
+.pio