Skip to content

A source xPack with the µOS++ RTOS

License

Notifications You must be signed in to change notification settings

micro-os-plus/rtos-xpack

Repository files navigation

license CI on Push

A source xPack with the µOS++ RTOS files

A source xPack with the µOS++ RTOS, a POSIX inspired open source framework, written in C++.

The project is hosted on GitHub as micro-os-plus/rtos-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 <project>
$ xpm init # Unless a package.json is already present

$ xpm install github:micro-os-plus/rtos-xpack

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

$ cd <project>
$ xpm init # Unless a package.json is already present

$ xpm install @micro-os-plus/rtos@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 <project>
$ git init # Unless already a Git project
$ mkdir -p xpacks

$ git submodule add https://github.com/micro-os-plus/rtos-xpack.git \
  xpacks/micro-os-plus-rtos

Branches

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

  • xpack, with the latest stable version
  • 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

The µOS++ (micro oh ɛs plus plus) project is the third iteration of µOS++, a POSIX-like, portable, open source, royalty-free, multi-tasking real-time framework written in C++, intended for 32/64-bits embedded applications.

The APIs are documented in the µOS++ reference.

Status

The µOS++ project is fully functional for Cortex-M devices and also runs on synthetic POSIX platforms (like macOS and GNU/Linux).

Related projects

The current µOS++ code tries to be as portable as possible.

Specific implementations are available from separate projects:

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

See µOS++ Application Config.

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

Documentation

Demo projects

TODO

License

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