# crc16-python

**Repository Path**: kevinya/crc16-python

## Basic Information

- **Project Name**: crc16-python
- **Description**: 查表法实现crc16算法.参数模型是CRC-16/MODBUS 多项式是8005
- **Primary Language**: Python
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-05-09
- **Last Updated**: 2021-05-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# crc16

## 介绍
查表法实现crc16算法.参数模型是CRC-16/MODBUS 多项式是8005。

本软件包已上传到pypi，可输入命令直接安装。
```shell
pip install crcmodbus
```

## API
```python
"""
计算校验和.参数模型是CRC-16/MODBUS 多项式是8005,返回值是高字节在前的16位校验值
"""
def checksum(data: bytearray) -> int
```

## 示例
```python
class _UnitTest(unittest.TestCase):
    def test_case1(self):
        data = bytearray([1, 2, 3, 4, 5, 6, 7, 8, 9])
        self.assertEqual(crcmodbus.checksum(data), 0x0eb2)

    def test_case2(self):
        data = bytearray([3, 1, 4])
        self.assertEqual(crcmodbus.checksum(data), 0x8193)

    def test_case3(self):
        data = bytearray([0x19, 0x89, 0x56])
        self.assertEqual(crcmodbus.checksum(data), 0x47a9)


if __name__ == '__main__':
    suite = unittest.TestSuite()
    suite.addTest(_UnitTest('test_case1'))
    suite.addTest(_UnitTest('test_case2'))
    suite.addTest(_UnitTest('test_case3'))
    runner = unittest.TextTestRunner()
    runner.run(suite)
```