https://github.com/armmbed/mbed-flasher
mbed device flasher application
https://github.com/armmbed/mbed-flasher
Last synced: 7 months ago
JSON representation
mbed device flasher application
- Host: GitHub
- URL: https://github.com/armmbed/mbed-flasher
- Owner: ARMmbed
- License: other
- Created: 2015-11-16T09:33:06.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-11-02T10:40:12.000Z (about 5 years ago)
- Last Synced: 2025-06-22T04:02:48.668Z (7 months ago)
- Language: Python
- Size: 1.02 MB
- Stars: 10
- Watchers: 49
- Forks: 10
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mbed-flasher
## Description
mbed-flasher is a simple Python-based tool for flashing boards.
It provides a simple Command Line Interface and Python API for flashing.
The purpose is to provide a clean and simple library that is easy to integrate to other tools.
It can be easily developed further to support flashing in mbed OS and other platforms.
Developers can also use it as a standalone tool for flashing their development boards.
## Installation
To install the flasher, use:
`pip install .`
To install the flasher in development mode:
`pip install --editable .`
## Usage
This tool has been tested and verified to work with Windows 10 and Ubuntu (16.04 LTS) Linux.
Devices used in verification: NXP K64F.
See the actual usage documentation [here](doc/usage.md).
## Help
**Main help**
```
/> mbedflash --help
usage: mbedflash [-h] [-v] [-s] ...
For specific command help, run: mbedflash --help
optional arguments:
-h, --help show this help message and exit
-v, --verbose Verbose level... repeat up to three times.
-s, --silent Silent - only errors will be printed.
--version show program's version number and exit
command:
command help
flash Flash given resource
reset Reset given resource
erase Erase given resource
```
**Flash help**
```
/>mbedflash flash --help
usage: mbedflash flash [-h] [-i INPUT] [--tid TARGET_ID] [--no-reset] [method]
positional arguments:
method , used for flashing
optional arguments:
-h, --help show this help message and exit
-i INPUT, --input INPUT
Binary input to be flashed.
--tid TARGET_ID, --target_id TARGET_ID
Target to be flashed.
--no-reset Do not reset device before or after flashing
```
**Erase help**
```
c:\>mbedflash erase --help
usage: mbedflash erase [-h] [--tid TARGET_ID] [--no-reset] [method]
positional arguments:
method , used for erase
optional arguments:
-h, --help show this help message and exit
--tid TARGET_ID, --target_id TARGET_ID
Target to be erased.
--no-reset Do not reset device after erase
```
**Reset help**
```
c:\>mbedflash reset --help
usage: mbedflash reset [-h] [--tid TARGET_ID] [method]
positional arguments:
method , used for reset
optional arguments:
-h, --help show this help message and exit
--tid TARGET_ID, --target_id TARGET_ID
Target to be reset.
```
## Running unit tests
Required pre-installed packages: coverage, mock
```
sudo pip install coverage mock
```
Execute all tests:
```
coverage run -m unittest discover -s test
```
Execute hardware tests:
```
coverage run -m unittest discover -s test.hardware
```
Execute non-hardware tests:
```
coverage run -m unittest discover -s test.non_hardware
```
Generate a coverage report:
```
coverage html
```