1
- # arduino-builder .py
1
+ # arduino-cli .py
2
2
3
- This script manages _ [ arduino-builder ] ( https://github.com/arduino/arduino-builder ) _ command line tool for compiling Arduino sketch(es).
3
+ This script manages _ [ arduino-cli ] ( https://github.com/arduino/arduino-cli ) _ command line tool for compiling Arduino sketch(es).
4
4
5
5
## Requirements
6
- - [ Arduino IDE ] ( https://www. arduino.cc/en/Main/Software ) ( _ [ arduino-builder ] ( https://github.com/arduino/arduino-builder ) _ is included)
6
+ - [ arduino-cli ] ( https://github.com/arduino/arduino-cli )
7
7
- Python version greater than or equal to 3.2 (due to ` concurrent.futures ` usage)
8
8
9
9
## Usage
10
10
11
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>]
12
+ usage: arduino-cli .py [-h] [-l [{board,sketch}] | -a] [-b pattern] [-c]
13
+ [--arch architecture]
14
+ [--config <core configuration file>] [-u <string >] [-v]
15
+ [--ci ]
16
+ [-i <shetch filepath> | -f <sketches list filepath> | -s pattern | -e <excluded sketches list filepath>]
17
17
18
- Manage arduino-builder command line tool for compiling Arduino sketch(es) .
18
+ Manage arduino-cli to build sketche(s) for STM32 boards .
19
19
20
20
optional arguments:
21
21
-h, --help show this help message and exit
22
22
-l [{board,sketch}], --list [{board,sketch}]
23
23
list available board(s) or sketch(es)
24
24
-a, --all build all sketches found for all available boards
25
25
-b pattern, --board pattern
26
- pattern to find one or more board(s) to build
27
- -c, --clean clean output directory
28
- <user path config>/arduinoBuilderOutput
26
+ pattern to build one or more board(s)
27
+ -c, --clean clean output directory.
29
28
--arch architecture core architecture to build. Default build architecture
30
- is stm32
29
+ is ' stm32'
31
30
--config <core configuration file>
32
31
JSON file containing the build configuration for one
33
32
or more maintainer/architecture. Board options for
34
33
build, applicability of sketches for boards or
35
34
required options. If sketch is not listed then
36
35
applicable to all board. Default core configuration is
37
- for 'stm32' architecture in: conf/cores_config.json
38
- -v, --verbose enable arduino-builder verbose mode
39
- --bin save binaries
40
- --travis Custom configuration for Travis CI build
36
+ for 'stm32 'architecture in:
37
+ <core path>\CI\build\conf\cores_config.json
38
+ -u <string>, --url <string>
39
+ additional URL for the board manager Default url : htt
40
+ ps://github.com/stm32duino/BoardManagerFiles/raw/maste
41
+ r/STM32/package_stm_index.json
42
+ -v, --verbose enable arduino-cli verbose mode
43
+ --ci custom configuration for CI build
41
44
42
45
Sketch(es) options:
43
- By default build <arduino path>/examples/01.Basics/BareMinimum/BareMinimum.ino
46
+ By default build C:\STM32\arduino\arduino-1.8.13\portable\packages\STM32\h
47
+ ardware\stm32\2.0.0-dev\CI\build\examples\BareMinimum
44
48
45
49
-i <shetch filepath>, --ino <shetch filepath>
46
- single ino file to build
50
+ single sketch file to build
47
51
-f <sketches list filepath>, --file <sketches list filepath>
48
52
file containing list of sketches to build
49
53
-s pattern, --sketches pattern
50
54
pattern to find one or more sketch to build
51
55
-e <excluded sketches list filepath>, --exclude <excluded sketches list filepath>
52
- file containing pattern of sketches to ignore. Default
53
- path : conf/ exclude_list.txt
56
+ file containing sketches pattern to ignore. Default
57
+ path : <core path>\\CI\build\ conf\ exclude_list.txt
54
58
```
55
59
56
60
## Cores configuration files
57
61
58
- Script is able to uses a JSON configuration file containing the build configuration for one or more maintainer/architecture.
62
+ Script is able to uses a JSON configuration file containing the build configuration for one or more maintainer/architecture.
59
63
A default configuration file is provided: [ cores_config.json] ( conf/cores_config.json )
60
64
61
65
@@ -144,7 +148,7 @@ Will build all sketches available in `09.USB/*` for the listed boards and add `
144
148
145
149
* List all boards containing ` F1 ` or ` L4 ` (not case sensitive):
146
150
147
- ` python3 arduino-builder .py -l -b "F1|l4" `
151
+ ` python3 arduino-cli .py -l -b "F1|l4" `
148
152
149
153
Will produce on the [ stm32] ( https://github.com/stm32duino/Arduino_Core_STM32 ) core:
150
154
```
@@ -164,7 +168,7 @@ NUCLEO_L496ZG-P
164
168
165
169
* List all sketch containing ` digital ` or ` analog ` (not case sensitive):
166
170
167
- ` python3 arduino-builder .py -l sketch -s "Digital|analog" `
171
+ ` python3 arduino-cli .py -l sketch -s "Digital|analog" `
168
172
169
173
Will produce on the [ stm32] ( https://github.com/stm32duino/Arduino_Core_STM32 ) core:
170
174
```
@@ -194,11 +198,11 @@ Build configuration for 'STM32' maintainer and 'stm32' architecture
194
198
195
199
* Build all sketches containing ` digital ` or ` analog ` for all boards containing ` F1 ` or ` L4 ` (not case sensitive):
196
200
197
- ` python3 arduino-builder .py -s "Digital|analog" -b "F1|l4" `
201
+ ` python3 arduino-cli .py -s "Digital|analog" -b "F1|l4" `
198
202
199
203
* List all boards for STM32F1 core:
200
204
201
- ` python3 arduino-builder .py -l --arch STM32F1 `
205
+ ` python3 arduino-cli .py -l --arch STM32F1 `
202
206
203
207
Will list:
204
208
```
0 commit comments