Merge branch 'stm32duino-master'

Author: davidangerls

CI/build/README.md

@@ -25,7 +25,7 @@ optional arguments:
   -b pattern, --board pattern
                         pattern to find one or more board(s) to build
   -c, --clean           clean output directory
-                        <user patch config>/arduinoBuilderOutput
+                        <user path config>/arduinoBuilderOutput
   --arch architecture   core architecture to build. Default build architecture
                         is stm32
   --config <core configuration file>
@@ -34,14 +34,13 @@ optional arguments:
                         build, applicability of sketches for boards or
                         required options. If sketch is not listed then
                         applicable to all board. Default core configuration is
-                        for 'stm32' architecture in: <user patch config>/arduino-
-                        builder/conf/cores_config.json
+                        for 'stm32' architecture in: conf/cores_config.json
   -v, --verbose         enable arduino-builder verbose mode
   --bin                 save binaries
   --travis              Custom configuration for Travis CI build
 
 Sketch(es) options:
-  By default build <user patch config>/arduino/examples/01.Basics/Blink/Blink.ino
+  By default build <arduino path>/examples/01.Basics/BareMinimum/BareMinimum.ino
 
   -i <shetch filepath>, --ino <shetch filepath>
                         single ino file to build
@@ -51,14 +50,182 @@ Sketch(es) options:
                         pattern to find one or more sketch to build
   -e <excluded sketches list filepath>, --exclude <excluded sketches list filepath>
                         file containing pattern of sketches to ignore. Default
-                        path : <user patch config>/arduino-builder/conf/exclude_list.txt
+                        path : conf/exclude_list.txt
 ```
 
 ## Cores configuration files
 
-ToDo
+Script is able to uses a JSON configuration file containing the build configuration for one or more maintainer/architecture. 
+A default configuration file is provided: [cores_config.json](conf/cores_config.json)
+
+
+#### Template
+```json
+{
+  "cores": [
+    {
+      "maintainer": "maintainer/vendor name",
+      "architecture": "architecture name",
+      "boards": [
+        {
+          "name": "board1",
+          "options": "specific options for board1 to concatenate with the fqbn"
+        },
+        {
+          "name": "board2",
+          "fqbn": "Fully Qualified Board Name and options, used instead of generated one"
+        }
+      ],
+      "sketches": [
+        {
+          "pattern": "sketche(s) pattern",
+          "applicable": true,
+          "boards": [ "List of boards (comma separated) which can be built for the sketche(s) pattern. Only those listed board will be built." ],
+          "options": "specific options to build the matched sketch pattern to concatenate with the fqbn (optional)"
+        },
+        {
+          "pattern": "sketche(s) pattern",
+          "applicable": false,
+          "boards": [ "List of boards (comma separated) which cannot be built for the sketche(s) pattern. All others available boards will be built." ]
+        }
+      ]
+    },
+    {
+      "maintainer": "Other maintainer/vendor name",
+      "architecture": "Other architecture name",
+      "boards": [
+        {
+          "name": "boardx",
+          "options": "specific options for board1 to concatenate with the fqbn"
+        }
+      ],
+      "sketches": [
+        {
+          "pattern": "sketchbook",
+          "applicable": true,
+          "boards": [ "" ]
+        }
+      ]
+    }
+  ]
+}
+```
+
+#### Examples
+
+Will add `flash=C8` option to the fqbn of the BLUEPILL_F103C8 board
+```json
+  {
+    "name": "BLUEPILL_F103C8",
+    "options": "flash=C8"
+  }
+```
+
+Will ignore `04.Communication/MultiSerial.ino` and `04.Communication/SerialPassthrough.ino`
+```json
+  {
+    "pattern": "04.Communication/(Multi)?Serial(Passthrough)?",
+    "applicable": true,
+    "boards": [ "" ]
+  }
+```
+
+Will build all sketches available in  `09.USB/*` for the listed boards and add `usb=HID` option to the fqbn
+```json
+  {
+    "pattern": "09.USB",
+    "applicable": true,
+    "boards": [ "NUCLEO_F429ZI", "DISCO_L475VG_IOT", "DISCO_F407VG" ],
+    "options": "usb=HID"
+  }
+```
 
 ## Usage examples
 
-ToDo
+* List all boards containing `F1` or `L4` (not case sensitive):
 
+`python3 arduino-builder.py -l -b "F1|l4"`
+
+Will produce on the [stm32](https://github.com/stm32duino/Arduino_Core_STM32) core:
+```
+Cores configuration JSON file that will be used: conf/cores_config.json
+Build configuration for 'STM32' maintainer and 'stm32' architecture
+9 board(s) available
+BLUEPILL_F103C8
+DISCO_F100RB
+DISCO_L475VG_IOT
+MAPLEMINI_F103CB
+NUCLEO_F103RB
+NUCLEO_L432KC
+NUCLEO_L476RG
+NUCLEO_L496ZG
+NUCLEO_L496ZG-P
+```
+
+* List all sketch containing `digital` or `analog` (not case sensitive):
+
+`python3 arduino-builder.py -l sketch -s "Digital|analog"`
+
+Will produce on the [stm32](https://github.com/stm32duino/Arduino_Core_STM32) core:
+```
+Cores configuration JSON file that will be used: conf/cores_config.json
+Build configuration for 'STM32' maintainer and 'stm32' architecture
+<Arduino path>/examples/01.Basics/AnalogReadSerial/AnalogReadSerial.ino
+<Arduino path>/examples/01.Basics/DigitalReadSerial/DigitalReadSerial.ino
+<Arduino path>/examples/01.Basics/ReadAnalogVoltage/ReadAnalogVoltage.ino
+<Arduino path>/examples/02.Digital/BlinkWithoutDelay/BlinkWithoutDelay.ino
+<Arduino path>/examples/02.Digital/Button/Button.ino
+<Arduino path>/examples/02.Digital/Debounce/Debounce.ino
+<Arduino path>/examples/02.Digital/DigitalInputPullup/DigitalInputPullup.ino
+<Arduino path>/examples/02.Digital/StateChangeDetection/StateChangeDetection.ino
+<Arduino path>/examples/02.Digital/toneKeyboard/toneKeyboard.ino
+<Arduino path>/examples/02.Digital/toneMelody/toneMelody.ino
+<Arduino path>/examples/02.Digital/toneMultiple/toneMultiple.ino
+<Arduino path>/examples/02.Digital/tonePitchFollower/tonePitchFollower.ino
+<Arduino path>/examples/03.Analog/AnalogInOutSerial/AnalogInOutSerial.ino
+<Arduino path>/examples/03.Analog/AnalogInput/AnalogInput.ino
+<Arduino path>/examples/03.Analog/AnalogWriteMega/AnalogWriteMega.ino
+<Arduino path>/examples/03.Analog/Calibration/Calibration.ino
+<Arduino path>/examples/03.Analog/Fading/Fading.ino
+<Arduino path>/examples/03.Analog/Smoothing/Smoothing.ino
+<Arduino path>/examples/10.StarterKit_BasicKit/p08_DigitalHourglass/p08_DigitalHourglass.ino
+19 sketches found
+```
+
+* Build all sketches containing `digital` or `analog` for all boards containing `F1` or `L4` (not case sensitive):
+
+`python3 arduino-builder.py -s "Digital|analog" -b "F1|l4"` 
+
+* List all boards for STM32F1 core:
+
+`python3 arduino-builder.py -l --arch STM32F1`
+
+Will list:
+```
+Cores configuration JSON file that will be used: conf/cores_config.json
+Build configuration for 'Arduino_STM32' maintainer and 'STM32F1' architecture
+23 board(s) available
+NucleoF103_HSE
+NucleoF103_HSI
+STM32F103C8
+STM32F103CB
+STM32F103R8
+STM32F103RB
+STM32F103RC
+STM32F103RE
+STM32F103T8
+STM32F103TB
+STM32F103VB
+STM32F103VC
+STM32F103VD
+STM32F103VE
+STM32F103ZC
+STM32F103ZD
+STM32F103ZE
+STM32VLD
+hytiny-stm32f103t
+maple
+mapleMini
+mapleRET6
+microduino32_flash
+```

CI/build/arduino-builder.py

@@ -122,7 +122,7 @@
 
 # Default
 sketch_default = os.path.join(
-    arduino_sketchbook_path, "01.Basics", "Blink", "Blink.ino"
+    arduino_sketchbook_path, "01.Basics", "BareMinimum", "BareMinimum.ino"
 )
 exclude_file_default = os.path.join("conf", "exclude_list.txt")
 cores_config_file_default = os.path.join("conf", "cores_config.json")

README.md

@@ -1,5 +1,7 @@
 # Arduino core support for STM32 based boards
-### Latest release [![GitHub release](https://img.shields.io/github/release/stm32duino/Arduino_Core_STM32.svg)](https://github.com/stm32duino/Arduino_Core_STM32/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/stm32duino/Arduino_Core_STM32/1.3.0.svg)](https://github.com/stm32duino/Arduino_Core_STM32/compare/1.3.0...master)
+[![GitHub release](https://img.shields.io/github/release/stm32duino/Arduino_Core_STM32.svg)](https://github.com/stm32duino/Arduino_Core_STM32/releases/latest)
+[![GitHub commits](https://img.shields.io/github/commits-since/stm32duino/Arduino_Core_STM32/1.3.0.svg)](https://github.com/stm32duino/Arduino_Core_STM32/compare/1.3.0...master)
+[![Build Status](https://travis-ci.com/stm32duino/Arduino_Core_STM32.svg?branch=master)](https://travis-ci.com/stm32duino/Arduino_Core_STM32)
 
 **Warning**: release versioning has been changed from date versioning to semantic one. See [Release Versioning change](https://github.com/stm32duino/wiki/wiki/Release-Versioning-change)
 
@@ -63,11 +65,15 @@ For advanced user, you can use the repository: see the [Using git repository](ht
   * STM32L4
     * [Nucleo L432KC](http://www.st.com/en/evaluation-tools/nucleo-l432kc.html)
     * [Nucleo L476RG](http://www.st.com/en/evaluation-tools/nucleo-l476rg.html)
-    * [NUCLEO-L496ZG](http://www.st.com/en/evaluation-tools/nucleo-l496zg.html)
-    * [NUCLEO-L496ZG-P](http://www.st.com/en/evaluation-tools/nucleo-l496zg-p.html)
+    * [Nucleo L496ZG](http://www.st.com/en/evaluation-tools/nucleo-l496zg.html)
+    * [Nucleo L496ZG-P](http://www.st.com/en/evaluation-tools/nucleo-l496zg-p.html)
     * [B-L475E-IOT01A](http://www.st.com/en/evaluation-tools/b-l475e-iot01a.html)
 
 ### Next release
+  * STM32L4
+    * [Nucleo L4R5ZI](http://www.st.com/en/evaluation-tools/nucleo-l4r5zi.html)
+    * [Nucleo L4R5ZI-P](http://www.st.com/en/evaluation-tools/nucleo-l4r5zi-p.html)
+
 
 
 ## Troubleshooting

boards.txt

@@ -85,6 +85,30 @@ Nucleo_144.menu.pnum.NUCLEO_L496ZG-P.build.product_line=STM32F767xx
 Nucleo_144.menu.pnum.NUCLEO_L496ZG-P.build.variant=NUCLEO_F767ZI
 Nucleo_144.menu.pnum.NUCLEO_L496ZG-P.build.cmsis_lib_gcc=arm_cortexM7l_math
 
+# NUCLEO_L4R5ZI board
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI=Nucleo L4R5ZI
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.node=NODE_L4R5ZI
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.upload.maximum_size=2097152
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.upload.maximum_data_size=655360
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.build.mcu=cortex-m4 -mfpu=fpv4-sp-d16 -mfloat-abi=hard
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.build.board=NUCLEO_L4R5ZI
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.build.series=STM32L4xx
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.build.product_line=STM32L4R5xx
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.build.variant=NUCLEO_L4R5ZI
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI.build.cmsis_lib_gcc=arm_cortexM4l_math
+
+# NUCLEO_L4R5ZI-P board
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P=Nucleo L4R5ZI-P
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.node=NODE_L4R5ZI
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.upload.maximum_size=2097152
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.upload.maximum_data_size=655360
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.build.mcu=cortex-m4 -mfpu=fpv4-sp-d16 -mfloat-abi=hard
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.build.board=NUCLEO_L4R5ZI_P
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.build.series=STM32L4xx
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.build.product_line=STM32L4R5xx
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.build.variant=NUCLEO_L4R5ZI
+Nucleo_144.menu.pnum.NUCLEO_L4R5ZI-P.build.cmsis_lib_gcc=arm_cortexM4l_math
+
 # Upload menu
 Nucleo_144.menu.upload_method.MassStorage=Mass Storage
 Nucleo_144.menu.upload_method.MassStorage.upload.protocol=

cores/arduino/stm32/HAL/stm32yyxx_hal.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_adc.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_adc.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_adc_ex.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_adc_ex.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_can.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_can.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_cec.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_cec.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_comp.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_comp.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_comp_ex.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32L0xx
 #include "stm32l0xx_hal_comp_ex.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_cortex.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_cortex.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_crc.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_crc.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_crc_ex.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_crc_ex.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_cryp.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F2xx
 #include "stm32f2xx_hal_cryp.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_cryp_ex.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F4xx
 #include "stm32f4xx_hal_cryp_ex.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_dac.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_dac.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_dac_ex.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_dac_ex.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_dcmi.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F2xx
 #include "stm32f2xx_hal_dcmi.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_dcmi_ex.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F4xx
 #include "stm32f4xx_hal_dcmi_ex.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_dfsdm.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F4xx
 #include "stm32f4xx_hal_dfsdm.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_dfsdm_ex.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32L4xx
 #include "stm32l4xx_hal_dfsdm_ex.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_dma.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F0xx
 #include "stm32f0xx_hal_dma.c"
 #endif

cores/arduino/stm32/HAL/stm32yyxx_hal_dma2d.c

@@ -1,5 +1,3 @@
-#include "stm32_def_build.h"
-
 #ifdef STM32F4xx
 #include "stm32f4xx_hal_dma2d.c"
 #endif