Flash firmware to devices running Microchip's 16-bit bootloader.
Project description
mcbootflash
What
Mcbootflash is a Python tool for flashing firmware to 16-bit Microchip MCUs and DSCs from the PIC24 and dsPIC33 families of devices, which are running a bootloader generated by the MPLAB Code Configurator tool.
Mcbootflash is intended to be a drop-in replacement for Microchip's official tool, the Unified Bootloader Host Application (UBHA).
Why
Mcbootflash is:
Scriptable
As a command-line application, mcbootflash is easily scriptable.
Extensible
In addition to its command-line interface, mcbootflash can be used as a library by applications wanting to implement firmware flashing as part of a larger suite of features.
Free and Open Source
Mcbootflash is distributed under the MIT license.
Installation
pip install mcbootflash
Usage
Mcbootflash can be used as both a command-line application and a library.
Command-line
$ mcbootflash --help
usage: mcbootflash [-h] -p PORT -b BAUDRATE [-t TIMEOUT] [-c] [-r] [-v] [-q] [--version] hexfile
Flash firmware over serial connection to a device running Microchip's 16-bit bootloader.
positional arguments:
hexfile a HEX file containing application firmware
options:
-h, --help show this help message and exit
-p PORT, --port PORT serial port connected to the device you want to flash
-b BAUDRATE, --baudrate BAUDRATE
symbol rate of device's serial bus
-t TIMEOUT, --timeout TIMEOUT
try to read data from the bus for this many seconds before giving up
-c, --checksum verify flashed data by checksumming after write
-r, --reset reset device after flashing is complete
-v, --verbose print debug messages
-q, --quiet suppress output
--version show program's version number and exit
Example
$ mcbootflash --port /dev/ttyUSB0 --baudrate 460800 firmware.hex
Connecting to bootloader...
Erasing program area...
Flashing firmware.hex...
100% 88.7 KiB |########################################| Elapsed Time: 0:00:05
Self verify OK
Library
When using mcbootflash as a library, typical workflow looks something like this:
import mcbootflash as bf
import serial
# Connect to a device in bootloader mode.
connection = serial.Serial(port=<PORT>, baudrate=<BAUDRATE>, timeout=<TIMEOUT>)
# Query its attributes.
bootattrs = bf.get_boot_attrs(connection)
# Load the firmware image and split it into chunks.
total_bytes, chunks = bf.chunked(hexfile=<HEXFILE_PATH_STRING>, bootattrs)
# Erase the device's program memory area.
bf.erase_flash(connection, bootattrs.memory_range, bootattrs.erase_size)
# Write the firmware chunks to the bootloader in a loop.
for chunk in chunks:
bf.write_flash(connection, chunk)
# Optionally, check that the write is OK by checksumming.
bf.checksum(connection, chunk)
# At this point, you may want to give an indication of the flashing progress,
# like updating a progress bar.
# Verify that the new application is detected.
bf.self_verify(connection)
See also the API Reference.
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
Built Distribution
File details
Details for the file mcbootflash-9.0.1.tar.gz
.
File metadata
- Download URL: mcbootflash-9.0.1.tar.gz
- Upload date:
- Size: 26.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18572627d3c334d80e9752e8579e267ba0bf96fcb357441223a7d3080da1acfc |
|
MD5 | 975fc16d9b5da2d799031ca5c4cbff4c |
|
BLAKE2b-256 | 0450612c80239e8f35c95689c773c2ea870b9d19675b2716ff074b622c13002a |
File details
Details for the file mcbootflash-9.0.1-py3-none-any.whl
.
File metadata
- Download URL: mcbootflash-9.0.1-py3-none-any.whl
- Upload date:
- Size: 14.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6299028a32f2c7489b80399f768de400302cdab54ee9de58456aebd10445877 |
|
MD5 | e019d78c5df1dab58fcee7f75035f48f |
|
BLAKE2b-256 | 0dd5f52c3791f69251438641a0c4017e16476a6d50f5b873cc97dd812cfcdc50 |