A source xPack with µOS++ complementary STM32F4 files

This project includes files not available in the official STM32CubeMX packages, like the vectors_*.c, with the interrupt vectors.

The project is hosted on GitHub as micro-os-plus/devices-stm32f4-extras-xpack.

Maintainer info

This page is addressed to developers who plan to include this package into their own projects.

For maintainer infos, please see the README-MAINTAINER file.

Install

As a source xPacks, the easiest way to add it to a project is via xpm, but it can also be used as any Git project, for example as a submodule.

Prerequisites

A recent xpm, which is a portable Node.js command line application.

For details please follow the instructions in the install page.

xpm

Note: the package will be available from npmjs.com at a later date.

For now, it can be installed from GitHub:

cd my-project
xpm init # Unless a package.json is already present

xpm install github:micro-os-plus/devices-stm32f4-extras-xpack

When ready, this package will be available as @micro-os-plus/devices-stm32f4-extras from the npmjs.com registry:

cd my-project
xpm init # Unless a package.json is already present

xpm install @micro-os-plus/devices-stm32f4-extras@latest

Git submodule

If, for any reason, xpm is not available, the next recommended solution is to link it as a Git submodule below an xpacks folder.

cd my-project
git init # Unless already a Git project
mkdir -p xpacks

git submodule add https://github.com/micro-os-plus/devices-stm32f4-extras-xpack.git \
  xpacks/micro-os-plus-devices-stm32f4

Branches

Apart from the unused master branch, there are two active branches:

• xpack, with the latest stable version (default)
• xpack-develop, with the current development version

All development is done in the xpack-develop branch, and contributions via Pull Requests should be directed to this branch.

When new releases are published, the xpack-develop branch is merged into xpack.

User info

TBD

Status

The STM32F4 vectors definitions are fully functional.

Build & integration info

To include this package in a project, consider the following details.

Source folders

• src

Include folders

• include

TODO: list the available headeres

Preprocessor definitions

TBD

Compiler options

• -std=c++17 or higher for C++ sources
• -std=c11 for C sources

Namespaces

TBD

Classes

TBD

Examples

TBD

Known problems

• none

Tests

TBD

License

The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.