Add ability for receiver to check if CRC is present in payload #333
Conversation
src/LoRa.h
Outdated
| @@ -73,6 +73,7 @@ class LoRaClass : public Stream { | |||
| void setSyncWord(int sw); | |||
| void enableCrc(); | |||
| void disableCrc(); | |||
| uint8_t crcOnPayload(); | |||
There was a problem hiding this comment.
I'm thinking this could be renamed to something more consistent with: https://github.com/sandeepmistry/arduino-LoRa/blob/master/src/LoRa.h#L43-L46
Maybe: packetHasCrc()?
Also, for the return type type is bool a better option?
Thoughts?
There was a problem hiding this comment.
isCrcPresent?
Normally a bool variable may start with is...?
There was a problem hiding this comment.
As far as I know, in Arduino IDE bool is same than uint8_t (unsigned 8bit integer). I have habit to use uint8_t, but I have nothing against bool. bool is just little bit more abstract.
I think too that crcOnPayload is little problematic function name. It is accurate, but it doesn't indicate what it means to reader. Both your suggestions are better than "crcOnPayload".
There was a problem hiding this comment.
Hi @mcgurk, if you can address these minor changes I'll merge this PR and include in the next release I'd like to get out this week. Thanks for this contribution and keen eyed reading of the datasheet.
There was a problem hiding this comment.
Hmm.. This is my first pull request ever :D. What I have to do? Edit my branch? I try.
There was a problem hiding this comment.
Yeah you just push additional commits to your branch and they will show up here.
enableCrc() doesn't affect when used with receiver in explicit header mode (datasheet page 30). This modification adds crcOnPayload()-function, which can be used to detect if CRC is present in payload. With this it is possible to verify that CRC is really used between sender and receiver.
SX1276/77/78/79 datasheet page 112:
RegHopChannel (0x1C), bit 6: CrcOnPayload (read)
CRC Information extracted from the received packet header (Explicit header mode only)
0 = Header indicates CRC off
1 = Header indicates CRC on