Metadata-Version: 2.4
Name: pyfwimagebuilder
Version: 1.3.0.16
Summary: Firmware image builder for Microchip mdfu bootloaders
Author-email: Microchip Technology <support@microchip.com>
License: MIT
Project-URL: Homepage, https://www.microchip.com
Keywords: Microchip,bootloader,PIC,AVR,pymdfu
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: toml
Requires-Dist: pyyaml
Requires-Dist: appdirs
Requires-Dist: hexdump2
Requires-Dist: intelhex
Requires-Dist: packaging
Provides-Extra: dev
Requires-Dist: pylint>=2.15; extra == "dev"
Provides-Extra: test
Requires-Dist: mock; extra == "test"
Requires-Dist: pytest; extra == "test"
Provides-Extra: doc
Requires-Dist: mock; extra == "doc"
Requires-Dist: sphinx; extra == "doc"
Dynamic: license-file

# pyfwimagebuilder - Firmware Image Builder
This utility is used to produce image files which can be used with the pymdfu tool: https://pypi.org/project/pymdfu/

![PyPI - Format](https://img.shields.io/pypi/format/pyfwimagebuilder)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyfwimagebuilder)
![PyPI - License](https://img.shields.io/pypi/l/pyfwimagebuilder)

## Overview

* install using pip from pypi: https://pypi.org/project/pyfwimagebuilder

## Usage
pyfwimagebuilder can be used as a command-line interface or a library

### Building an image from the command-line
for help, use:
```bash
pyfwimagebuilder --help
```

Example usage:

Building an image:
```bash
pyfwimagebuilder build -i myapp.hex -c myconfig.toml -o myimage.img
```

Decoding an image:
```bash
pyfwimagebuilder decode -i myapp.img -c myconfig.toml -o myimage.txt
```

### Additional command-line switches
* -v LEVEL for selecting logging verbosity ('debug', 'info', 'warning', 'error', 'critical')
# Changelog

## [1.3.0] - July 2025

- PYTOOLS-158, PYTOOLS-162, PYTOOLS-481: Added image binary decoding
- PYTOOLS-479: Added file format support for Cortex-M0+
- PYTOOLS-163: Added warning for data that is not within the device memory range
- PYTOOLS-492: Fixed segment inclusion to not skip data that is in the valid range when there is data that is outside

## [1.0.0] - December 2023

- Public beta release

## [0.0.1] - October 2023
- Package planning
