Skip to content

Commit 5eea46a

Browse files
committed
Add script to build the core
Python script used to build sketch(es) thanks to Arduino Builder Python requirement >= 3.2 (due to concurrent.futures usage) usage: arduino-builder.py [-h] [-l [{board,sketch}] | -a] [-b pattern] [-c] [--arch architecture] [--config <core configuration file>] [-v] [--bin | --travis] [-i <shetch filepath> | -f <sketches list filepath> | -s pattern | -e <excluded sketches list filepath>] Signed-off-by: Angela Randolph <[email protected]>
1 parent 3c66de7 commit 5eea46a

File tree

7 files changed

+1057
-0
lines changed

7 files changed

+1057
-0
lines changed

CI/build/.flake8

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[flake8]
2+
max-line-length = 88

CI/build/README.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# arduino-builder.py
2+
3+
This script manages _[arduino-builder](https://github.com/arduino/arduino-builder)_ command line tool for compiling Arduino sketch(es).
4+
5+
## Requirements
6+
- [Arduino IDE](https://www.arduino.cc/en/Main/Software) (_[arduino-builder](https://github.com/arduino/arduino-builder)_ is included)
7+
- Python version greater than or equal to 3.2 (due to `concurrent.futures` usage)
8+
9+
## Usage
10+
11+
```
12+
usage: arduino-builder.py [-h] [-l [{board,sketch}] | -a] [-b pattern] [-c]
13+
[--arch architecture]
14+
[--config <core configuration file>] [-v]
15+
[--bin | --travis]
16+
[-i <shetch filepath> | -f <sketches list filepath> | -s pattern | -e <excluded sketches list filepath>]
17+
18+
Manage arduino-builder command line tool for compiling Arduino sketch(es).
19+
20+
optional arguments:
21+
-h, --help show this help message and exit
22+
-l [{board,sketch}], --list [{board,sketch}]
23+
list available board(s) or sketch(es)
24+
-a, --all build all sketches found for all available boards
25+
-b pattern, --board pattern
26+
pattern to find one or more board(s) to build
27+
-c, --clean clean output directory
28+
<user patch config>/arduinoBuilderOutput
29+
--arch architecture core architecture to build. Default build architecture
30+
is stm32
31+
--config <core configuration file>
32+
JSON file containing the build configuration for one
33+
or more maintainer/architecture. Board options for
34+
build, applicability of sketches for boards or
35+
required options. If sketch is not listed then
36+
applicable to all board. Default core configuration is
37+
for 'stm32' architecture in: <user patch config>/arduino-
38+
builder/conf/cores_config.json
39+
-v, --verbose enable arduino-builder verbose mode
40+
--bin save binaries
41+
--travis Custom configuration for Travis CI build
42+
43+
Sketch(es) options:
44+
By default build <user patch config>/arduino/examples/01.Basics/Blink/Blink.ino
45+
46+
-i <shetch filepath>, --ino <shetch filepath>
47+
single ino file to build
48+
-f <sketches list filepath>, --file <sketches list filepath>
49+
file containing list of sketches to build
50+
-s pattern, --sketches pattern
51+
pattern to find one or more sketch to build
52+
-e <excluded sketches list filepath>, --exclude <excluded sketches list filepath>
53+
file containing pattern of sketches to ignore. Default
54+
path : <user patch config>/arduino-builder/conf/exclude_list.txt
55+
```
56+
57+
## Cores configuration files
58+
59+
ToDo
60+
61+
## Usage examples
62+
63+
ToDo
64+

0 commit comments

Comments
 (0)