Embedded_Console

Features:

• Control Arduino, STM32 or any other C++ microcontroller via Sting-Based Commands
• Send Messages via printf()
• Flash Firmware via dfu
• Portable/customisable

Overview

Getting Started

Details

Adding Microcontroller Firmware

• Copy or include ./firmware-mcu/ in your project.
• Choose with what hardware y wanna acess the console. UART? USB? Serial?
• Choose an exisitng Stream object or create your own by inheriting from <> IStream.h.
• create a console object with given stream.

#include "Console.h"
#include "StreamStmUSB.h"
StreamStmUSB streamUSB;
Console console(streamUSB);

• rework bool Console::recieveCommands() in /src/Console.cpp to fit your needs.
• call console.recieveCommands() periodicly in your code (as quick as feasable).

while(1){
console.recieveCommands();
HAL_delay(10):
}

First bootup

• Flash the microcontroller with console (s. Setup)
• Connect microcontroller via USB Cable to Computer
• Run Console ./Python Console (PC)/console.py. Should autoconnect. If not: check errors. use /l for list of connected Devices, if y found yours, use /s number to connect
• use /t string to send strings to your microcontroller

Complete Project Setup for STM32

Details

1. CubeMX

• Enable USB
• Configure USB_DEVICE as VCP
• Compile as CMake Project

2. Change CMake projet form C to Cpp

• rename main.c to main.cpp,
• in cmake\stm32cubemx\CMakeLists.txt change the file name main.c to main.cpp

3. CMakeList.txt

in .\CMakeLists.txt add/change:

• add C++ as a language to CMakeLists.txt:

enable_language(C CXX ASM)

• add header and sources to your project

# Add sources to executable
target_sources(${CMAKE_PROJECT_NAME} PRIVATE
    # Add user sources here
    ./wherever y like it/Console.cpp
	# for STM32 usualy:
    ./Core/Src/console.cpp
)

# Add include paths
target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE
    # Add user defined include paths
    ./Embedded_Console/firmware-mcu/include
	# for STM32 usualy:
    ./Core/Inc/ #included here to have acess to STM HAL in the console
)

• to enable floats in printf add:

# Enable hardware floating-point support in the compiler (if applicable)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mfpu=fpv4-sp-d16 -mfloat-abi=hard")

# Add the linker flag to enable floating-point support in printf
set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -u _printf_float -u _scanf_float")

# Link the math library to support floating-point operations
target_link_libraries(${PROJECT_NAME} m)

# Allow GCC extensions (binary literals, etc.)
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=gnu11")

• to export to .bin for dfu:

# to export to .bin for dfu:
add_custom_command(TARGET ${CMAKE_PROJECT_NAME} POST_BUILD
    COMMAND ${CMAKE_OBJCOPY} -O binary $<TARGET_FILE:${CMAKE_PROJECT_NAME}> ${CMAKE_PROJECT_NAME}.bin
)
# post-build automatic upload
add_custom_command(TARGET ${CMAKE_PROJECT_NAME} POST_BUILD
    COMMAND ${CMAKE_COMMAND} -E echo "Flashing via DFU..."
    COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/dfu-util-static.exe
            -a 0 -i 0 -s 0x08000000:leave
            -D ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}.bin
    COMMENT "Uploading firmware using dfu-util (live output)"
    VERBATIM
)

ARM toolchain

Insructions for linux Download from (ARM Website)[https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads] the version you need. Plattform: Linux target: bare mettal evtl. hard float when hardware floating point support

unzio
mkdir /opt/arm
mv ./arm /opt/arm
export PATH=/opt/arm/arm-gnu-toolchain-15.2.rel1-x86_64-arm-none-eabi/bin:$PATH
exec zsh
which arm-none-eabi-gcc
arm-none-eabi-gcc --version

Compiling with CMake

cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=cmake/gcc-arm-none-eabi.cmake # Compiling
cmake --build build # --verbose

or all in one:

rm -r ./build&&cmake -S . -B build -DCMAKE_TOOLCHAIN_FILE=cmake/gcc-arm-none-eabi.cmake&&cmake --build build

Searching for Devices (linux only)

 ls /dev/ttyACM**
screen /dev/ttyACMyournnumebr

4. Device Firmware Update via dfu-ut``install/download dfu-util from https://dfu-util.sourceforge.net/

• Windows only: install required Driver (s. dfu-util website)
• flash with

.\dfu-util-static.exe -a 0 -i 0 -s 0x08000000:leave -D .\build\Debug\ProjekName.bin

• optional: change suffix(validate firmware)

.\dfu-suffix.exe -v 0x0483 -p 0xdf11 -d 0x2200 -a .\build\Debug\stm32f401ConsoleTest.bin 

Python Console

• Install Python
• Install packages struct, threading, pyserial, subprocess