Skip to main content

Command line interface for Mbed OS.

Project description

Mbed Tools

Package Documentation PyPI PyPI - Status PyPI - Python Version

License

Build Status Test Coverage Maintainability

Overview

This is the future command line tool for Mbed OS. It provides the ability to detect Mbed Enabled devices connected by USB, checkout Mbed projects and perform builds amongst other operations.

:warning: While this package is generally available it is not complete. The available functionality can be viewed with the --help option once installed. Please note that the current tools for Mbed OS 5.x and above can be found at https://github.com/ARMmbed/mbed-cli.

Releases

For release notes and a history of changes of all production releases, please see the following:

For a the list of all available versions please, please see the:

Versioning

The version scheme used follows PEP440 and Semantic Versioning. For production quality releases the version will look as follows:

  • <major>.<minor>.<patch>

Pre releases are used to give early access to new functionality, for testing and to get feedback on experimental features. As such these releases may not be stable and should not be used for production. Additionally any interfaces introduced in a pre release may be removed or changed without notice. For pre releases the version will look as follows:

  • <major>.<minor>.<patch>.dev<pre-release-number>

Installation

mbed-tools relies on the Ninja build system and CMake.

We recommend installing mbed-tools in a Python virtual environment to avoid dependency conflicts.

To install the most recent production quality release use:

pip install mbed-tools

To install a specific release:

pip install mbed-tools==<version>

Usage

Interface definition and usage documentation (for developers of Mbed OS tooling) is available for the most recent production release here:

Project Structure

The follow described the major aspects of the project structure:

  • azure-pipelines/ - CI configuration files for Azure Pipelines.
  • src/mbed_tools/ - Python source files.
  • news/ - Collection of news files for unreleased changes.
  • tests/ - Unit and integration tests.

Getting Help

  • For interface definition and usage documentation, please see GitHub Pages.
  • For a list of known issues and possible work arounds, please see Known Issues.
  • To raise a defect or enhancement please use GitHub Issues.
  • To ask a question please use the Mbed Forum.

Contributing

  • Mbed OS is an open source project and we are committed to fostering a welcoming community, please see our Code of Conduct for more information.
  • For how to contribute to the project, including how to develop the project, please see the Contributions Guidelines

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mbed-tools-7.54.0.tar.gz (152.4 kB view hashes)

Uploaded source

Built Distribution

mbed_tools-7.54.0-py3-none-any.whl (127.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page