hexformat 0.4.0

Library for popular HEX-formats like IntelHex and SRecord

The hexformat Python package allows the processing of several HEX data formats. Supported formats are the Intel-Hex format, the Motorola S-Record format as well as the hex dump and Tektronix hex format. The first two are often used for programming microcontrollers while the last is often used to display binary data in a user readable way.

Files in the mentioned format can be created, modified (e.g. set, delete and fill data) and read from or written to files. A base class MultiPartBuffer is provided which implements the handling of multiple data parts where every part is identified by its corresponding start address. This base class allows for the basic operations like reading and writing binary files as well as modifing the binary data. The specific classes IntelHex, SRecord, HexDump and `` are derivated from it which implement the parsing and generating of the corresponding HEX formats as well as implementing file format specific features.

Motivation

This package was mainly created to replace the srecord command line tool and its complicated interface with a clean python interface for use with handling microcontroller HEX files. The existing Python library intelhex was used for a while, but then the need for the S-Record format appeared. Also intelhex.IntelHex did not provide a suitable interface for the most often used operations.

License:

MIT License

Copyright (c) 2015-2022 by Martin Scharrer <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.