crc 0.4.3

Library and CLI tool for calculating and verifying CRC checksums.

Status

Overview

The crc package provides support for the most common functionality to handle and calculate various kinds of crc checksums. (e.g. Crc8, Crc16, Crc32)

Provided Default Configuration(s) of CRC Algorithms:

CRC 8

• CCITT
• SAJ1850
• AUTOSAR
• BLUETOOTH

CRC 16

• CCITT
• GSM
• PROFIBUS

CRC 32

• CRC32
• AUTOSAR
• BZIP2
• POSIX

CRC 64

• CRC64

Requirements

• Python 3.6 and newer

### Calculate crc using the CrcRegister class
```python
data = [0, 1, 2, 3, 4, 5 ]
expected_checksum = 0xff
crc_calculator = CrcCalculator(Crc8.CCITT)

Speed up calculation (TableBasedRegister)

data = [0, 1, 2, 3, 4, 5 ]

## Usage

### Calculate and verify crc checksum using provided crc algorithm
```python
data = [0, 1, 2, 3, 4, 5 ]
expected_checksum = 0xff
crc_calculator = CrcCalculator(Crc8.CCITT)

checksum = crc_calculator.calculate_checksum(data)

assert checksum == expected_checksum
assert crc_calculator.verify_checksum(data, expected_checksum)
expected_checksum = 0xff
crc_calculator = CrcCalculator(Crc8.CCITT)

How to create a custom crc configuration

data = [0, 1, 2, 3, 4, 5 ]
expected_checksum = 0xff
crc_calculator = CrcCalculator(Crc8.CCITT)

Write your own CrcRegister based on CrcRegisterBase

Based on CrcRegisterBase

data = [0, 1, 2, 3, 4, 5 ]
expected_checksum = 0xff
crc_calculator = CrcCalculator(Crc8.CCITT)

.. code-block::

Based on AbstractCrcRegister

data = [0, 1, 2, 3, 4, 5 ]
expected_checksum = 0xff
crc_calculator = CrcCalculator(Crc8.CCITT)

Command line tools

cli extension point

name: crc.cli.command

crc

A set of crc checksum related command line tools.

    usage:
        crc [--version][--help] <command> [<args>...]

    options:

        -h, --help      prints this help dialoge
        --version       version

    commands:
        table       creates a crc lookup table.
        verfiy      verfies a already calcualted crc for the specified data.
        calcualte   calculates the crc checksum for the specified data.

table

Command line tool to create crc lookup tables.

    usage:
        crc table [options] <width> <polynom>

    arguments:
        <polynom>       hex value of the polynom used for calculating the crc table.

    options:
        -h, --help
        --version

Tips & Tricks

Info: Main code -> crc.py works without any dependencies -> copy and paste into project but gererally highly recommend -> install using pip -> tests etc

References & Resources

• A Painless guide to crc error detection algorithms
• Project on Github
• CRC-Catalouge