https://github.com/endail/radiopacket
A packet format for sending/receiving data using the Arduino Manchester library
https://github.com/endail/radiopacket
arduino arduino-library manchester-encoding radio rf
Last synced: about 2 months ago
JSON representation
A packet format for sending/receiving data using the Arduino Manchester library
- Host: GitHub
- URL: https://github.com/endail/radiopacket
- Owner: endail
- License: mit
- Created: 2021-01-09T15:08:47.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-16T08:39:09.000Z (over 5 years ago)
- Last Synced: 2024-12-28T01:40:11.466Z (over 1 year ago)
- Topics: arduino, arduino-library, manchester-encoding, radio, rf
- Language: C++
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RadioPacket
A packet format for sending/receiving data using the [Arduino Manchester library](https://github.com/mchr3k/arduino-libs-manchester).
[](https://github.com/endail/RadioPacket/actions?query=workflow%3Aarduino-lint)
## [Transmitter Code](https://github.com/endail/RadioPacket/blob/main/examples/tx/tx.ino)
```cpp
using RadioPacket;
Message m(arr, sizeof(arr));
m.setRawAction(UPDATE_DB_CMD);
RadioPacket p(&m);
p.setRawTransmitterId(TRANSMITTER_ID);
p.setRawReceiverId(RECEIVER_ID);
p.setRawCrc8(p.generateChecksum());
man.transmitArray(
p.getRawPacketLength(),
const_cast(p.getData()));
```
## [Receiver Code](https://github.com/endail/RadioPacket/blob/main/examples/rx/rx.ino)
```cpp
RadioPacket* p;
Message* m;
if(RadioPacket::parse(&p, buffer, BUFFER_SIZE) == RadioPacket::PARSE_OK) {
if(Message::parse(&m, p->getBodyData(), p->getRawBodyLength()) == Message::PARSE_OK) {
Serial.println(m->getBodyData());
}
}
delete p;
delete m;
```
## Packet Format
0 1 2 4 6
[PACKET LENGTH][VERSION][TRANSMITTER ID][RECEIVER ID]
6 7 8 9
[FRAGMENT][BODY LENGTH][CRC8]
9
[BODY DATA]
## Message Format
0 2 4
[BODY LENGTH][ACTION]
4
[BODY DATA]
## Extending Messages
```cpp
// MeasurementMessage.h
#include
/**
* MeasurementMessage holds a single 16 bit integer
*/
class MeasurementMessage : public RadioPacket::Message {
protected:
static const uint8_t _MEASUREMENT_OFFSET = 0;
static const uint8_t _ACTION_VALUE = 1;
public:
MeasurementMessage() : Message() {
this->setRawAction(_ACTION_VALUE);
this->resizeBody(sizeof(uint16_t));
}
uint16_t getMeasurement() const noexcept {
return this->_data.getUInt16(this->fromBaseBodyOffset(
_MEASUREMENT_OFFSET));
}
void setMeasurement(const uint16_t m) noexcept {
this->_data.setUInt16(m, this->fromBaseBodyOffset(
_MEASUREMENT_OFFSET));
}
};
```
```cpp
// example use of MeasurementMessage
// read analog value of A1 into message object
MeasurementMessage mm;
mm.setMeasurement(::analogRead(A1));
// then encapsulate the message into a RadioPacket as
// in the example transmitter code above
// when receiving, cast Message to a MeasurementMessage,
// where m is a Message* as in the example receiver code above
MeasurementMessage* mm = static_cast(m);
mm->getMeasurement();
```