Skip to main content

Python script to calculate LPC firmware checksums

Project description

# 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.

[![Build Status](https://travis-ci.org/basilfx/lpc_checksum.svg?branch=master)](https://travis-ci.org/basilfx/lpc_checksum)

## Requirements
The only requirement is Python 2.7 or Python 3.5+.

## 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 <firmware.bin|hex> [--format=bin] [--readonly]`

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

### As a module
```
import lpc_checksum

checksum = lpc_checksum.checksum(input_file, [readonly=True])
```

On error, an exception will be raised.

## License
See the `LICENSE` file (MIT license).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lpc_checksum-2.1.0.tar.gz (22.1 kB view hashes)

Uploaded Source

Built Distribution

lpc_checksum-2.1.0-py3-none-any.whl (3.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page