https://github.com/naguissa/ucrc16xmodemlib
Tiny and cross-device compatible CRC16 XModem calculator library. Compatible with UKHAS - uCRC16XModemLib
https://github.com/naguissa/ucrc16xmodemlib
arduino arduino-library crc crc16 naguissa ukhas xmodem xmodem-crc
Last synced: 8 months ago
JSON representation
Tiny and cross-device compatible CRC16 XModem calculator library. Compatible with UKHAS - uCRC16XModemLib
- Host: GitHub
- URL: https://github.com/naguissa/ucrc16xmodemlib
- Owner: Naguissa
- License: lgpl-3.0
- Created: 2019-11-05T14:09:31.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-11T07:10:35.000Z (over 5 years ago)
- Last Synced: 2025-01-01T22:11:38.834Z (10 months ago)
- Topics: arduino, arduino-library, crc, crc16, naguissa, ukhas, xmodem, xmodem-crc
- Language: C++
- Homepage: https://www.foroelectro.net/librerias-arduino-ide-f29/ucrc16xmodemlib-pequena-libreria-para-calcular-el--t321.html
- Size: 168 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Tiny and cross-device compatible CRC16 XModem calculator library UKHAS.org.uk compatible - uCRC16XModemLib #
Master status: [](https://travis-ci.org/Naguissa/uCRC16XModemLib)
## What is this repository for? ##
Tiny and cross-device compatible CRC16 XModem calculator library
Compatible with UKHAS.org.uk message signing, use offset 2 on full message to skip leading "$".
Supports any microcontroller.
## Usage ##
This library is used with only static methods, you don't need to (and can't) initialize any class object.
You have these methods:
- *uCRC16XModemLibObject.reset()* : Resets internal state
- *uCRC16XModemLibObject.feedBit(bool)* : Feeds a bit
- *uCRC16XModemLibObject.feedByte(char)* : Feeds a byte
- *uCRC16XModemLibObject.getResult()* : Gets CRC16 in a uint16_t
Library provides also two shorthand methods:
- uint16_t CRC = *uCRC16XModemLibObject.calculate(MessageCharArray)* : Calculates CRC for a message
- uint16_t CRC = *uCRC16XModemLibObject.calculate(MessageCharArray, 2)* : Calculates CRC for a message starting from offset 2 (recommended use for UKHAS.org.uk)
## How do I get set up? ##
You can get it from Arduino libraries directly, searching by uCRC16XModemLib.
For manual installation:
* Get the ZIP from releases link: https://github.com/Naguissa/uCRC16XModemLib/releases
* Rename to uCRC16XModemLib.zip
* Install library on Arduino
## Examples ##
Included on example folder, available on Arduino IDE.
## Who do I talk to? ##
* [Naguissa](https://github.com/Naguissa)
* https://www.foroelectro.net/librerias-arduino-ide-f29/ucrc16xmodemlib-pequena-libreria-para-calcular-el--t321.html
## Contribute ##
Any code contribution, report or comment are always welcome. Don't hesitate to use GitHub for that.
* You can sponsor this project using GitHub's Sponsor button: https://github.com/Naguissa/uCRC16XModemLib
* You can make a donation via PayPal: https://paypal.me/foroelectro
Thanks for your support.
Contributors hall of fame: https://www.foroelectro.net/hall-of-fame-f32/contributors-contribuyentes-t271.html