Build and upload the project¶

emCode includes ten targets, called tasks by Visual Studio Code.

Build cleans the files from a previous compilation, compiles and links.
Fast compiles only the main sketch and the local libraries, links, uploads and opens a serial window in Terminal.
Upload uploads the resulting HEX or BIN executable file to the board.
Serial open the serial console in a Terminal window.
Clean erases the files generated from a previous compilation.
Make compiles only the main sketch and the local libraries, and links.
Archive prepares archives for the local libraries.
Unarchive erases the archives for the local libraries.
Core generates the pre-compiled board core archive.
Document builds the documentation.

Compare the targets¶

The following table shows the scope of each target:

Target…	Cleans	Compiles	Uploads	Opens Terminal	Debugs
Build
Upload
Serial
Clean
Fast
Make
Debug

The Build target is recommended for a clean compilation, for example when a user’s library has been changed.

Select a target¶

To select a target,

Press a short-key.

Key	Target
`Ctrl`+`Shift`+`B`	Build
`Ctrl`+`Shift`+`U`	Upload
`Ctrl`+`Shift`+`T`	Fast
`Ctrl`+`Shift`+`D`	Debug

Call the prompt with Ctrl+Shift+P and enter Tasks: Run Task;
Then select the target you want.

Build¶

To build,

Press Ctrl+Shift+B, or
Call the prompt with Ctrl+Shift+P, enter Tasks: Run Task and select Build.

Define parallel build¶

By default, emCode use parallel build to speed-up the process. The parallel build uses as many threads as cores available.

The impact of parallel build on speed depends on the number of cores of the microprocessor.

If parallel build is unstable, return to the standard build with one thread.

To reverse to standard build with one thread,

Open the tasks.json file under the .vscode folder of the project;
Remove the "-j", line from the task arguments.

    "tasks": [
        {
            "label": "Build",
            "type": "shell",
            "command": "make",
            "args": [
                "build",
                "-j",
                "SELECTED_BOARD=${command:cpptools.activeConfigName}"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "detail": "Build with makefile"
        },
    ]

Define compiler options¶

Some project may require additional options.

Open the main Makefile and
Add the parameters to the variable COMPILER_OPTIONS in the main Makefile.

# Compiler options
# ----------------------------------
# If 0 or empty, no additional options
#
COMPILER_OPTIONS = -fpermissive

In this example, -fpermissive has been added.

# Compiler options
# ----------------------------------
# If 0 or empty, no additional options
#
COMPILER_OPTIONS = -Wl,-u,_printf_float,-u,-_scanf_float

In this example, formatting float numbers has been added.

COMPILER_OPTIONS = -flto

In this example, the -flto implements link time optimisation on GCC to optimise the executable size.

For more information on the authorised parameters,

Please refer to the compiler documentation.

Define linker options¶

Some project may require additional options.

Open the main Makefile and
Add the parameters to the variable LINKER_OPTIONS in the main Makefile.

# Compiler and linker options
# ----------------------------------
# If 0 or empty, no additional options
#
COMPILER_OPTIONS =
LINKER_OPTIONS = -Wl,--check-sections

In this example, -Wl,--check-sections has been added.

For more information on the authorised parameters,

Please refer to the compiler documentation.

Define warning messages¶

Contrary to errors, warnings don’t stop compilation but they point at possible cause of errors.

The variable WARNING_OPTIONS on the main Makefile selects the scope of the warning messages.

By default, the variable WARNING_OPTIONS is set to 0: no warning messages are reported.

# Warning options
# ----------------------------------
# For example, unused variables with unused-variable.
#
# If 0, no warnings
# If empty, all warnings, same as WARNING_OPTIONS = all
# WARNING_OPTIONS = all no-missing-braces no-conversion-null no-pointer-arith
# WARNING_OPTIONS = unused-variable unused-function unused-label unused-value no-conversion-null no-pointer-arith
#
WARNING_OPTIONS = 0

If WARNING_OPTIONS is left empty, all warnings are displayed. This is the same as WARNING_OPTIONS = all.

# Warning options
#
WARNING_OPTIONS = all

The all option corresponds to the -Wall parameter and usually generates a very long list of warning messages, making the analysis difficult if not impossible.

The solution consists on selecting a scope and targeting specific warnings.

Define the selected warnings by listing the options after the variable WARNING_OPTIONS.

Here are two examples:

To check all the unused elements and save precious SRAM and Flash memory, define the following warning options.

# Warning options
#
WARNING_OPTIONS = unused-variable unused-function unused-label unused-value

To check all the use of NULL, define the following warning options.

# Warning options
#
WARNING_OPTIONS = conversion-null pointer-arith

For more information on the many other warning messages options,

Please refer to the Using the GNU Compiler Collection Manual .

Define a binary specific name¶

Some project may setting a specific name for the binary. Default names of the binaries are based on embeddedcomputing: embeddedcomputing.bin, embeddedcomputing.hex, embeddedcomputing.elf and alike.

To define a specific binary name,

Open the main Makefile;
Add or edit the line BINARY_SPECIFIC_NAME; and
Define a binary specific name.

# C-compliant project name and extension
PROJECT_NAME_AS_IDENTIFIER = embed1

# Binary name, default=embeddedcomputing
BINARY_SPECIFIC_NAME = $(PROJECT_NAME_AS_IDENTIFIER)

In the example, the binary specific name is set to embed1, the C-compliant name of the project through the variable $(PROJECT_NAME_AS_IDENTIFIER).

Just enter whatever value after BINARY_SPECIFIC_NAME to set another name,

# Binary name, default=embeddedcomputing
BINARY_SPECIFIC_NAME = myBinarySpecificName

Define other options¶

If the main Makefile doesn’t define or doesn’t set a value to a parameter, the following default values are used.

All those parameters and default values are listed on the emCode/Tools/Makefiles/Step0.mk file.

Parameter	Default value	Comment
`SKETCH_EXTENSION`	`ino`	Official extension
`HIDE_NUMBER`	`false`	Display the summary
`HIDE_COMMAND`	`true`	Hide the command line
`KEEP_MAIN`	`false`	Update `main.cpp`
`KEEP_TASKS`	`false`	Update the list of tasks
`USE_ARCHIVES`	`true`	Use available pre-compile archives for local libraries
`OPTIMISATION`	`-Os -g3`	Set optimisation and debugging
`BINARY_SPECIFIC_NAME`	`emcode`	Name of the generated executable
`USER_LIB_PATH`	Sketchbook	Full path to the user’s libraries
`APPLICATIONS_PATH`	`$(HOME)/Applications`	Location of the Arduino IDE
`SEGGER_PATH`	`/opt/SEGGER`	Location of the Segger tools
`STM32_CUBE_PATH`	`~/Applications/STM32CubeProgrammer`	Location of the STM32CubeProgrammer tools
`SERIAL_BAUDRATE`	`115200`	Serial speed
`NO_SERIAL_CONSOLE`	`true`	Do not launch the serial console

The terminal window of visual Studio Code reports the progress of the task with two lines: the first line is the summary and mentions the number of the task and the file; the second line provides the full command.

HIDE_NUMBER and HIDE_COMMAND can hide the first line or second line. It is recommended to keep at least one.

4.3-LOCAL CPP     main.cpp.o
~/.arduino15/packages/rp2040/tools/pqt-gcc/4.0.1-8ec9d6f/bin/arm-none-eabi-g++ -c -Werror=return-type -Wno-psabi -Os -g3 -w -march=armv6-m -mcpu=cortex-m0plus -mthumb -ffunction-sections -fdata-sections -fno-exceptions -lstdc++ -pipe -DARDUINO=20302 -DARDUINO_ARCH_RP2040 -DEMCODE=140506 -DARDUINO_VARIANT='"rpipico"' -DF_CPU=125000000L -DARDUINO_RASPBERRY_PI_PICO -BOARD_NAME='"Raspberry Pi Pico"' -MMD -DLWIP_IPV6=0 -DLWIP_IPV4=1 -DLWIP_IGMP=1 -DLWIP_CHECKSUM_CTRL_PER_NETIF=1 -I./LocalLibrary/src -I. -DUSB_MANUFACTURER='"Raspberry Pi"' -DUSB_PRODUCT='"Pico"' -DUSBD_PID=0x000a -DUSBD_VID=0x2e8a -DUSBD_MAX_POWER_MA=250 -DPICO_FLASH_SIZE_BYTES=2097152 @~/.arduino15/packages/rp2040/hardware/rp2040/4.1.1/lib/rp2040/platform_def.txt -DLWIP_IPV6=0 -DLWIP_IPV4=1 -DLWIP_IGMP=1 -DLWIP_CHECKSUM_CTRL_PER_NETIF=1 -c -fno-rtti -std=gnu++17 -iprefix~/.arduino15/packages/rp2040/hardware/rp2040/4.1.1/ @~/.arduino15/packages/rp2040/hardware/rp2040/4.1.1/lib/rp2040/platform_inc.txt @~/.arduino15/packages/rp2040/hardware/rp2040/4.1.1/lib/core_inc.txt -I~/.arduino15/packages/rp2040/hardware/rp2040/4.1.1/cores/rp2040 -I~/.arduino15/packages/rp2040/hardware/rp2040/4.1.1/variants/rpipico -I~/.arduino15/packages/rp2040/hardware/rp2040/4.1.1/include "main.cpp" -o "~/Projets/emCode/embed1/.builds/main.cpp.o"

By default, USER_LIB_PATH refer to the library sub-folder of the sketchbook folder Arduino defined by Arduino.

Define a final command¶

Some project may require to run a final command once compilation is successful.

To define a final command,

Open the main Makefile,
Add or edit the line COMMAND_FINAL and
Define the bash command.

# Final command after make,
COMMAND_FINAL = cp $(TARGET_HEX) $(CURRENT_DIR)/

In the example, the final command copies the binary .hex to the folder of the project.

The Report Navigator displays the final command.

---- Final ----
cp ./.builds/embeddedcomputing.hex .
==== Make done ====

Upload¶

To upload,

Press Ctrl+Shift+U, or
Call the prompt with Ctrl+Shift+P, enter Tasks: Run Task and select Upload.

Some boards require specific procedures.

Please refer to Manage boards.

Customise the serial port¶

The serial port is used for the upload of the sketches and for the console.

Each platform has a different implementation of the USB port naming.

To change the serial port,

Open the main Makefile.
Uncomment the line BOARD_PORT by removing the leading # and define the serial port.

BOARD_PORT = /dev/tty.usbACM1

To know the USB port name of the active board, proceed as follow:

Launch a Terminal window
Plug the board on the USB port.
Run the following command and note the name of the port.

ls /dev/ttyACM*
/dev/tty.usbACM1

By default, the speed of the serial port is set to 1152000. To change it,

Open the main Makefile.
Uncomment the line SERIAL_BAUDRATE and set the desired speed.

# SERIAL_BAUDRATE for the serial console, 115200 by default
# Uncomment and specify another speed
#
SERIAL_BAUDRATE = 230400

Manage specific boards¶

Some boards require a specific procedure.

Please refer to the Upload section for the board under Manage the boards.