forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[PHY] Use compact Doxygen and stop using reserved format

Browse source
This commit is contained in:
jgromes 2023-04-23 09:12:47 +02:00
parent 767a2b006a
commit 78a576df12
2 changed files with 49 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
src/protocols/PhysicalLayer/PhysicalLayer.cpp
View file

@ -1,12 +1,12 @@
#include "PhysicalLayer.h"
#include <string.h>
PhysicalLayer::PhysicalLayer(float freqStep, size_t maxPacketLength) {
_freqStep = freqStep;
_maxPacketLength = maxPacketLength;
PhysicalLayer::PhysicalLayer(float step, size_t maxLen) {
this->freqStep = step;
this->maxPacketLength = maxLen;
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
_bufferBitPos = 0;
_bufferWritePos = 0;
this->bufferBitPos = 0;
this->bufferWritePos = 0;
#endif
}
@ -73,7 +73,7 @@ int16_t PhysicalLayer::receive(String& str, size_t len) {
#else
uint8_t* data = NULL;
if(length == 0) {
data = new uint8_t[_maxPacketLength + 1];
data = new uint8_t[this->maxPacketLength + 1];
} else {
data = new uint8_t[length + 1];
}
@ -243,7 +243,7 @@ int16_t PhysicalLayer::setEncoding(uint8_t encoding) {
}
float PhysicalLayer::getFreqStep() const {
return(_freqStep);
return(this->freqStep);
}
size_t PhysicalLayer::getPacketLength(bool update) {
@ -307,13 +307,13 @@ int16_t PhysicalLayer::startDirect() {
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
int16_t PhysicalLayer::available() {
return(_bufferWritePos);
return(this->bufferWritePos);
}
void PhysicalLayer::dropSync() {
if(_directSyncWordLen > 0) {
_gotSync = false;
_syncBuffer = 0;
if(this->directSyncWordLen > 0) {
this->gotSync = false;
this->syncBuffer = 0;
}
}
@ -321,21 +321,21 @@ uint8_t PhysicalLayer::read(bool drop) {
if(drop) {
dropSync();
}
_bufferWritePos--;
return(_buffer[_bufferReadPos++]);
this->bufferWritePos--;
return(this->buffer[this->bufferReadPos++]);
}
int16_t PhysicalLayer::setDirectSyncWord(uint32_t syncWord, uint8_t len) {
if(len > 32) {
return(RADIOLIB_ERR_INVALID_SYNC_WORD);
}
_directSyncWordMask = 0xFFFFFFFF >> (32 - len);
_directSyncWordLen = len;
_directSyncWord = syncWord;
this->directSyncWordMask = 0xFFFFFFFF >> (32 - len);
this->directSyncWordLen = len;
this->directSyncWord = syncWord;
// override sync word matching when length is set to 0
if(_directSyncWordLen == 0) {
_gotSync = true;
if(this->directSyncWordLen == 0) {
this->gotSync = true;
}
return(RADIOLIB_ERR_NONE);
@ -343,35 +343,35 @@ int16_t PhysicalLayer::setDirectSyncWord(uint32_t syncWord, uint8_t len) {
void PhysicalLayer::updateDirectBuffer(uint8_t bit) {
// check sync word
if(!_gotSync) {
_syncBuffer <<= 1;
_syncBuffer |= bit;
if(!this->gotSync) {
this->syncBuffer <<= 1;
this->syncBuffer |= bit;
RADIOLIB_VERBOSE_PRINTLN("S\t%X", _syncBuffer);
RADIOLIB_VERBOSE_PRINTLN("S\t%X", this->syncBuffer);
if((_syncBuffer & _directSyncWordMask) == _directSyncWord) {
_gotSync = true;
_bufferWritePos = 0;
_bufferReadPos = 0;
_bufferBitPos = 0;
if((this->syncBuffer & this->directSyncWordMask) == this->directSyncWord) {
this->gotSync = true;
this->bufferWritePos = 0;
this->bufferReadPos = 0;
this->bufferBitPos = 0;
}
} else {
// save the bit
if(bit) {
_buffer[_bufferWritePos] |= 0x01 << _bufferBitPos;
this->buffer[this->bufferWritePos] |= 0x01 << this->bufferBitPos;
} else {
_buffer[_bufferWritePos] &= ~(0x01 << _bufferBitPos);
this->buffer[this->bufferWritePos] &= ~(0x01 << this->bufferBitPos);
}
_bufferBitPos++;
this->bufferBitPos++;
// check complete byte
if(_bufferBitPos == 8) {
_buffer[_bufferWritePos] = Module::flipBits(_buffer[_bufferWritePos]);
RADIOLIB_VERBOSE_PRINTLN("R\t%X", _buffer[_bufferWritePos]);
if(this->bufferBitPos == 8) {
this->buffer[this->bufferWritePos] = Module::flipBits(this->buffer[this->bufferWritePos]);
RADIOLIB_VERBOSE_PRINTLN("R\t%X", this->buffer[this->bufferWritePos]);
_bufferWritePos++;
_bufferBitPos = 0;
this->bufferWritePos++;
this->bufferBitPos = 0;
}
}
}

28
src/protocols/PhysicalLayer/PhysicalLayer.h
View file

@ -19,10 +19,10 @@ class PhysicalLayer {
/*!
\brief Default constructor.
\param freqStep Frequency step of the synthesizer in Hz.
\param maxPacketLength Maximum length of packet that can be received by the module.
\param step Frequency step of the synthesizer in Hz.
\param maxLen Maximum length of packet that can be received by the module.
*/
PhysicalLayer(float freqStep, size_t maxPacketLength);
PhysicalLayer(float step, size_t maxLen);
// basic methods
@ -356,19 +356,19 @@ class PhysicalLayer {
#if !defined(RADIOLIB_GODMODE)
private:
#endif
float _freqStep;
size_t _maxPacketLength;
float freqStep;
size_t maxPacketLength;
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
uint8_t _bufferBitPos;
uint8_t _bufferWritePos;
uint8_t _bufferReadPos;
uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];
uint32_t _syncBuffer;
uint32_t _directSyncWord;
uint8_t _directSyncWordLen;
uint32_t _directSyncWordMask;
bool _gotSync;
uint8_t bufferBitPos;
uint8_t bufferWritePos;
uint8_t bufferReadPos;
uint8_t buffer[RADIOLIB_STATIC_ARRAY_SIZE];
uint32_t syncBuffer;
uint32_t directSyncWord;
uint8_t directSyncWordLen;
uint32_t directSyncWordMask;
bool gotSync;
#endif
virtual Module* getMod() = 0;