https://github.com/richhaar/autosar-crc
JavaScript NPM package for 8 bit, 16bit, 32bit and 64 bit CRC functions as specified by the AUTOSAR standard, written with C++
https://github.com/richhaar/autosar-crc
autosar cpp cpp17 crc crc16 crc32 crc64 crc8 javascript node-addon node-addon-api nodejs
Last synced: about 2 months ago
JSON representation
JavaScript NPM package for 8 bit, 16bit, 32bit and 64 bit CRC functions as specified by the AUTOSAR standard, written with C++
- Host: GitHub
- URL: https://github.com/richhaar/autosar-crc
- Owner: richhaar
- License: isc
- Created: 2021-10-23T14:53:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-27T21:16:46.000Z (3 months ago)
- Last Synced: 2025-03-27T10:21:12.959Z (2 months ago)
- Topics: autosar, cpp, cpp17, crc, crc16, crc32, crc64, crc8, javascript, node-addon, node-addon-api, nodejs
- Language: C++
- Homepage: https://www.npmjs.com/package/autosar-crc
- Size: 794 KB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AUTOSAR-CRC
A C++ implemented set of 8,16,32,64 bit cyclic redundancy check (CRC) functions conforming to the CRC spec given by [AUTOSAR](https://www.autosar.org/). Written in C++ and compiled as a 'C++ addon' for use in JavaScript. Available on [NPM](https://www.npmjs.com/package/autosar-crc).
## Getting Started
These instructions will get you up and running using the autosar-crc node module on your local machine.
### Prerequisites
To get going you need the following installed:
* NodeJS
* npm
* c++17 compiler
### Installing
Autosar-crc is available on the npm registry, so within your console you can install `autosar-crc`.
```
npm install autosar-crc
```
### Different types of CRC
Autosar-crc provides the following:
```js example.js
const autocrc = require('autosar-crc');
console.log(autocrc.crc8('123456789'));
console.log(autocrc.crc8_h2f('123456789'));
console.log(autocrc.crc16('123456789'));
console.log(autocrc.crc32('123456789'));
console.log(autocrc.crc32_p4('123456789'));
console.log(autocrc.crc64('123456789'));
```
```
node example.js
```
You should get the following result:
```
75
223
10673
3421780262
379048042
11051210869376104000
```
The polynomials of the CRC match the spec given in the AUTOSAR standard, see `crc_tables.h` for specifics on the polynomials.
Each CRC accepts the following types:
* `String`
* `TypedArray`
* `ArrayBuffer`
```js
const autocrc = require('autosar-crc');
const arr = new Uint8Array([0x31,0x32,0x33,0x34,0x35,0x36,0x37,0x38,0x39]);
console.log(autocrc.crc8(arr));
console.log(autocrc.crc8(arr.buffer));
console.log(autocrc.crc8('123456789'))
```
Should give you the following result (note: 0x31 is hex for 1):
```
75
75
75
```
## Benchmarks
Running crc32 over the entire works of Shakespeare 100x on a MacBook Air gives the following:
```
autosar-crc: 2.442s
crc: 3.293s
crc32: 56.973s
```
## Running the tests
The tests are found in the `main.test.js` file and are run with `Jest`.
### Break down into end to end tests
The test script is defined in `package.json` so you can run:
```
npm test
```
## Built With
* [Node Addon API](https://github.com/nodejs/node-addon-api) - Module to use the Node-API from C++
* [Jest](https://jestjs.io/) - Testing framework
## Authors
* **Richard Haar** - *Initial work* - [richhaar](https://github.com/richhaar)
## License
This project is licensed under the ISC License - see the [LICENSE](https://github.com/richhaar/autosar-crc/blob/main/LICENSE) file for details
## Acknowledgments
* Bastian Molkenthin for the table generation [here](http://www.sunshine2k.de/coding/javascript/crc/crc_js.html)