https://github.com/basilfx/lpc_checksum

Python script to calculate LPC firmware checksums.
https://github.com/basilfx/lpc_checksum

embedded lpc microcontroller nxp python

Last synced: 3 months ago
JSON representation

Python script to calculate LPC firmware checksums.

• Host: GitHub
• URL: https://github.com/basilfx/lpc_checksum
• Owner: basilfx
• License: mit
• Created: 2013-10-28T10:37:49.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-06-26T10:01:03.000Z (over 1 year ago)
• Last Synced: 2024-10-31T06:49:35.030Z (3 months ago)
• Topics: embedded, lpc, microcontroller, nxp, python
• Language: Python
• Homepage:
• Size: 98.6 KB
• Stars: 8
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# lpc_checksum

Python script to calculate LPC firmware checksums, based on the C version by

Roel Verdult. It can be used as a standalone application, or as a Python module

that integrates directly in a build environment (e.g. SCons). It does not need

to be compiled.

[![Linting](https://github.com/basilfx/lpc_checksum/actions/workflows/lint.yml/badge.svg)](https://github.com/basilfx/lpc_checksum/actions/workflows/lint.yml)

[![Testing](https://github.com/basilfx/lpc_checksum/actions/workflows/test.yml/badge.svg)](https://github.com/basilfx/lpc_checksum/actions/workflows/test.yml)

[![PyPI version](https://badge.fury.io/py/lpc-checksum.svg)](https://badge.fury.io/py/lpc-checksum)

## Requirements

The only requirement is Python 3.9 or newer.

## Installation

This module can be installed from Pypi via `pip install lpc_checksum`.

Alternatively, you can install the latest version by cloning this repository

and run `python setup.py install`.

## Usage

There are two ways of using `lpc_checksum`.

### Standalone

When installed via Pip or from source, the command `lpc_checksum` should be

available on your PATH. By default, it assumes the input file is a binary file.

`lpc_checksum  [--format=bin] [--read-only]`

Program exits with a non-zero error code when it failed.

### As a module

```

import lpc_checksum

checksum = lpc_checksum.checksum(input_file, [read_only=True])

```

On error, an exception will be raised.

## Tests

To run the tests, please clone this repository and run `poetry run pytest`.

## Contributing

See the [`CONTRIBUTING.md`](CONTRIBUTING.md) file.

## License

See the [`LICENSE.md`](LICENSE.md) file (MIT license).