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

[Pager] Use compact Doxygen and stop using reserved format

Browse source
This commit is contained in:
jgromes 2023-04-22 19:35:14 +02:00
parent 8722231ace
commit 6bbd237fb3
2 changed files with 83 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

118
src/protocols/Pager/Pager.cpp
View file

@ -6,48 +6,48 @@
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE) #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
// this is a massive hack, but we need a global-scope ISR to manage the bit reading // this is a massive hack, but we need a global-scope ISR to manage the bit reading
// let's hope nobody ever tries running two POCSAG receivers at the same time // let's hope nobody ever tries running two POCSAG receivers at the same time
static PhysicalLayer* _readBitInstance = NULL; static PhysicalLayer* readBitInstance = NULL;
static uint32_t _readBitPin = RADIOLIB_NC; static uint32_t readBitPin = RADIOLIB_NC;
#if defined(ESP8266) || defined(ESP32) #if defined(ESP8266) || defined(ESP32)
ICACHE_RAM_ATTR ICACHE_RAM_ATTR
#endif #endif
static void PagerClientReadBit(void) { static void PagerClientReadBit(void) {
if(_readBitInstance) { if(readBitInstance) {
_readBitInstance->readBit(_readBitPin); readBitInstance->readBit(readBitPin);
} }
} }
#endif #endif
PagerClient::PagerClient(PhysicalLayer* phy) { PagerClient::PagerClient(PhysicalLayer* phy) {
_phy = phy; phyLayer = phy;
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE) #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
_readBitInstance = _phy; readBitInstance = phyLayer;
#endif #endif
} }
int16_t PagerClient::begin(float base, uint16_t speed, bool invert, uint16_t shift) { int16_t PagerClient::begin(float base, uint16_t speed, bool invert, uint16_t shift) {
// calculate duration of 1 bit in us // calculate duration of 1 bit in us
_speed = (float)speed/1000.0f; dataRate = (float)speed/1000.0f;
_bitDuration = (uint32_t)1000000/speed; bitDuration = (uint32_t)1000000/speed;
// calculate 24-bit frequency // calculate 24-bit frequency
_base = base; baseFreq = base;
_baseRaw = (_base * 1000000.0) / _phy->getFreqStep(); baseFreqRaw = (baseFreq * 1000000.0) / phyLayer->getFreqStep();
// calculate module carrier frequency resolution // calculate module carrier frequency resolution
uint16_t step = round(_phy->getFreqStep()); uint16_t step = round(phyLayer->getFreqStep());
// calculate raw frequency shift // calculate raw frequency shift
_shiftHz = shift; shiftFreqHz = shift;
_shift = _shiftHz/step; shiftFreq = shiftFreqHz/step;
inv = invert; inv = invert;
// initialize BCH encoder // initialize BCH encoder
encoderInit(); encoderInit();
// configure for direct mode // configure for direct mode
return(_phy->startDirect()); return(phyLayer->startDirect());
} }
int16_t PagerClient::sendTone(uint32_t addr) { int16_t PagerClient::sendTone(uint32_t addr) {
@ -217,7 +217,7 @@ int16_t PagerClient::transmit(uint8_t* data, size_t len, uint32_t addr, uint8_t
#endif #endif
// turn transmitter off // turn transmitter off
_phy->standby(); phyLayer->standby();
return(RADIOLIB_ERR_NONE); return(RADIOLIB_ERR_NONE);
} }
@ -225,43 +225,43 @@ int16_t PagerClient::transmit(uint8_t* data, size_t len, uint32_t addr, uint8_t
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE) #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
int16_t PagerClient::startReceive(uint32_t pin, uint32_t addr, uint32_t mask) { int16_t PagerClient::startReceive(uint32_t pin, uint32_t addr, uint32_t mask) {
// save the variables // save the variables
_readBitPin = pin; readBitPin = pin;
_filterAddr = addr; filterAddr = addr;
_filterMask = mask; filterMask = mask;
// set the carrier frequency // set the carrier frequency
int16_t state = _phy->setFrequency(_base); int16_t state = phyLayer->setFrequency(baseFreq);
RADIOLIB_ASSERT(state); RADIOLIB_ASSERT(state);
// set bitrate // set bitrate
state = _phy->setBitRate(_speed); state = phyLayer->setBitRate(dataRate);
RADIOLIB_ASSERT(state); RADIOLIB_ASSERT(state);
// set frequency deviation to 4.5 khz // set frequency deviation to 4.5 khz
state = _phy->setFrequencyDeviation((float)_shiftHz / 1000.0f); state = phyLayer->setFrequencyDeviation((float)shiftFreqHz / 1000.0f);
RADIOLIB_ASSERT(state); RADIOLIB_ASSERT(state);
// now set up the direct mode reception // now set up the direct mode reception
Module* mod = _phy->getMod(); Module* mod = phyLayer->getMod();
mod->hal->pinMode(pin, mod->hal->GpioModeInput); mod->hal->pinMode(pin, mod->hal->GpioModeInput);
// set direct sync word to the frame sync word // set direct sync word to the frame sync word
// the logic here is inverted, because modules like SX1278 // the logic here is inverted, because modules like SX1278
// assume high frequency to be logic 1, which is opposite to POCSAG // assume high frequency to be logic 1, which is opposite to POCSAG
if(!inv) { if(!inv) {
_phy->setDirectSyncWord(~RADIOLIB_PAGER_FRAME_SYNC_CODE_WORD, 32); phyLayer->setDirectSyncWord(~RADIOLIB_PAGER_FRAME_SYNC_CODE_WORD, 32);
} else { } else {
_phy->setDirectSyncWord(RADIOLIB_PAGER_FRAME_SYNC_CODE_WORD, 32); phyLayer->setDirectSyncWord(RADIOLIB_PAGER_FRAME_SYNC_CODE_WORD, 32);
} }
_phy->setDirectAction(PagerClientReadBit); phyLayer->setDirectAction(PagerClientReadBit);
_phy->receiveDirect(); phyLayer->receiveDirect();
return(state); return(state);
} }
size_t PagerClient::available() { size_t PagerClient::available() {
return(_phy->available() + sizeof(uint32_t))/(sizeof(uint32_t) * (RADIOLIB_PAGER_BATCH_LEN + 1)); return(phyLayer->available() + sizeof(uint32_t))/(sizeof(uint32_t) * (RADIOLIB_PAGER_BATCH_LEN + 1));
} }
#if defined(RADIOLIB_BUILD_ARDUINO) #if defined(RADIOLIB_BUILD_ARDUINO)
@ -316,7 +316,7 @@ int16_t PagerClient::readData(uint8_t* data, size_t* len, uint32_t* addr) {
bool match = false; bool match = false;
uint8_t framePos = 0; uint8_t framePos = 0;
uint8_t symbolLength = 0; uint8_t symbolLength = 0;
while(!match && _phy->available()) { while(!match && phyLayer->available()) {
uint32_t cw = read(); uint32_t cw = read();
framePos++; framePos++;
@ -339,7 +339,7 @@ int16_t PagerClient::readData(uint8_t* data, size_t* len, uint32_t* addr) {
// should be an address code word, extract the address // should be an address code word, extract the address
uint32_t addr_found = ((cw & RADIOLIB_PAGER_ADDRESS_BITS_MASK) >> (RADIOLIB_PAGER_ADDRESS_POS - 3)) | (framePos/2); uint32_t addr_found = ((cw & RADIOLIB_PAGER_ADDRESS_BITS_MASK) >> (RADIOLIB_PAGER_ADDRESS_POS - 3)) | (framePos/2);
if((addr_found & _filterMask) == (_filterAddr & _filterMask)) { if((addr_found & filterMask) == (filterAddr & filterMask)) {
// we have a match! // we have a match!
match = true; match = true;
if(addr) { if(addr) {
@ -366,7 +366,7 @@ int16_t PagerClient::readData(uint8_t* data, size_t* len, uint32_t* addr) {
uint32_t prevCw = 0; uint32_t prevCw = 0;
bool overflow = false; bool overflow = false;
int8_t ovfBits = 0; int8_t ovfBits = 0;
while(!complete && _phy->available()) { while(!complete && phyLayer->available()) {
uint32_t cw = read(); uint32_t cw = read();
// check if it's the idle code word // check if it's the idle code word
@ -452,17 +452,17 @@ void PagerClient::write(uint32_t* data, size_t len) {
void PagerClient::write(uint32_t codeWord) { void PagerClient::write(uint32_t codeWord) {
// write single code word // write single code word
Module* mod = _phy->getMod(); Module* mod = phyLayer->getMod();
for(int8_t i = 31; i >= 0; i--) { for(int8_t i = 31; i >= 0; i--) {
uint32_t mask = (uint32_t)0x01 << i; uint32_t mask = (uint32_t)0x01 << i;
uint32_t start = mod->hal->micros(); uint32_t start = mod->hal->micros();
// figure out the shift direction - start by assuming the bit is 0 // figure out the shift direction - start by assuming the bit is 0
int16_t change = _shift; int16_t change = shiftFreq;
// now check if it's actually 1 // now check if it's actually 1
if(codeWord & mask) { if(codeWord & mask) {
change = -_shift; change = -shiftFreq;
} }
// finally, check if inversion is enabled // finally, check if inversion is enabled
@ -471,13 +471,13 @@ void PagerClient::write(uint32_t codeWord) {
} }
// now transmit the shifted frequency // now transmit the shifted frequency
_phy->transmitDirect(_baseRaw + change); phyLayer->transmitDirect(baseFreqRaw + change);
// this is pretty silly, while(mod->hal->micros() ... ) would be enough // this is pretty silly, while(mod->hal->micros() ... ) would be enough
// but for some reason, MegaCore throws a linker error on it // but for some reason, MegaCore throws a linker error on it
// "relocation truncated to fit: R_AVR_7_PCREL against `no symbol'" // "relocation truncated to fit: R_AVR_7_PCREL against `no symbol'"
uint32_t now = mod->hal->micros(); uint32_t now = mod->hal->micros();
while(now - start < _bitDuration) { while(now - start < bitDuration) {
now = mod->hal->micros(); now = mod->hal->micros();
} }
} }
@ -486,10 +486,10 @@ void PagerClient::write(uint32_t codeWord) {
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE) #if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
uint32_t PagerClient::read() { uint32_t PagerClient::read() {
uint32_t codeWord = 0; uint32_t codeWord = 0;
codeWord |= (uint32_t)_phy->read() << 24; codeWord |= (uint32_t)phyLayer->read() << 24;
codeWord |= (uint32_t)_phy->read() << 16; codeWord |= (uint32_t)phyLayer->read() << 16;
codeWord |= (uint32_t)_phy->read() << 8; codeWord |= (uint32_t)phyLayer->read() << 8;
codeWord |= (uint32_t)_phy->read(); codeWord |= (uint32_t)phyLayer->read();
// check if we need to invert bits // check if we need to invert bits
// the logic here is inverted, because modules like SX1278 // the logic here is inverted, because modules like SX1278
@ -548,40 +548,40 @@ char PagerClient::decodeBCD(uint8_t b) {
void PagerClient::encoderInit() { void PagerClient::encoderInit() {
/* /*
* generate GF(2**m) from the irreducible polynomial p(X) in p[0]..p[m] * generate GF(2**m) from the irreducible polynomial p(X) in p[0]..p[m]
* lookup tables: index->polynomial form _bchAlphaTo[] contains j=alpha**i; * lookup tables: index->polynomial form bchAlphaTo[] contains j=alpha**i;
* polynomial form -> index form _bchIndexOf[j=alpha**i] = i alpha=2 is the * polynomial form -> index form bchIndexOf[j=alpha**i] = i alpha=2 is the
* primitive element of GF(2**m) * primitive element of GF(2**m)
*/ */
int32_t mask = 1; int32_t mask = 1;
_bchAlphaTo[RADIOLIB_PAGER_BCH_M] = 0; bchAlphaTo[RADIOLIB_PAGER_BCH_M] = 0;
for(uint8_t i = 0; i < RADIOLIB_PAGER_BCH_M; i++) { for(uint8_t i = 0; i < RADIOLIB_PAGER_BCH_M; i++) {
_bchAlphaTo[i] = mask; bchAlphaTo[i] = mask;
_bchIndexOf[_bchAlphaTo[i]] = i; bchIndexOf[bchAlphaTo[i]] = i;
if(RADIOLIB_PAGER_BCH_PRIMITIVE_POLY & ((uint32_t)0x01 << i)) { if(RADIOLIB_PAGER_BCH_PRIMITIVE_POLY & ((uint32_t)0x01 << i)) {
_bchAlphaTo[RADIOLIB_PAGER_BCH_M] ^= mask; bchAlphaTo[RADIOLIB_PAGER_BCH_M] ^= mask;
} }
mask <<= 1; mask <<= 1;
} }
_bchIndexOf[_bchAlphaTo[RADIOLIB_PAGER_BCH_M]] = RADIOLIB_PAGER_BCH_M; bchIndexOf[bchAlphaTo[RADIOLIB_PAGER_BCH_M]] = RADIOLIB_PAGER_BCH_M;
mask >>= 1; mask >>= 1;
for(uint8_t i = RADIOLIB_PAGER_BCH_M + 1; i < RADIOLIB_PAGER_BCH_N; i++) { for(uint8_t i = RADIOLIB_PAGER_BCH_M + 1; i < RADIOLIB_PAGER_BCH_N; i++) {
if(_bchAlphaTo[i - 1] >= mask) { if(bchAlphaTo[i - 1] >= mask) {
_bchAlphaTo[i] = _bchAlphaTo[RADIOLIB_PAGER_BCH_M] ^ ((_bchAlphaTo[i - 1] ^ mask) << 1); bchAlphaTo[i] = bchAlphaTo[RADIOLIB_PAGER_BCH_M] ^ ((bchAlphaTo[i - 1] ^ mask) << 1);
} else { } else {
_bchAlphaTo[i] = _bchAlphaTo[i - 1] << 1; bchAlphaTo[i] = bchAlphaTo[i - 1] << 1;
} }
_bchIndexOf[_bchAlphaTo[i]] = i; bchIndexOf[bchAlphaTo[i]] = i;
} }
_bchIndexOf[0] = -1; bchIndexOf[0] = -1;
/* /*
* Compute generator polynomial of BCH code of length = 31, redundancy = 10 * Compute generator polynomial of BCH code of length = 31, redundancy = 10
@ -665,19 +665,19 @@ void PagerClient::encoderInit() {
} }
// Compute generator polynomial // Compute generator polynomial
_bchG[0] = _bchAlphaTo[zeros[1]]; bchG[0] = bchAlphaTo[zeros[1]];
_bchG[1] = 1; // g(x) = (X + zeros[1]) initially bchG[1] = 1; // g(x) = (X + zeros[1]) initially
for(ii = 2; ii <= rdncy; ii++) { for(ii = 2; ii <= rdncy; ii++) {
_bchG[ii] = 1; bchG[ii] = 1;
for(jj = ii - 1; jj > 0; jj--) { for(jj = ii - 1; jj > 0; jj--) {
if(_bchG[jj] != 0) { if(bchG[jj] != 0) {
_bchG[jj] = _bchG[jj - 1] ^ _bchAlphaTo[(_bchIndexOf[_bchG[jj]] + zeros[ii]) % RADIOLIB_PAGER_BCH_N]; bchG[jj] = bchG[jj - 1] ^ bchAlphaTo[(bchIndexOf[bchG[jj]] + zeros[ii]) % RADIOLIB_PAGER_BCH_N];
} else { } else {
_bchG[jj] = _bchG[jj - 1]; bchG[jj] = bchG[jj - 1];
} }
} }
_bchG[0] = _bchAlphaTo[(_bchIndexOf[_bchG[0]] + zeros[ii]) % RADIOLIB_PAGER_BCH_N]; bchG[0] = bchAlphaTo[(bchIndexOf[bchG[0]] + zeros[ii]) % RADIOLIB_PAGER_BCH_N];
} }
} }
@ -711,7 +711,7 @@ uint32_t PagerClient::encodeBCH(uint32_t dat) {
while(end < RADIOLIB_PAGER_BCH_N) { while(end < RADIOLIB_PAGER_BCH_N) {
for(int32_t i = end; i > start-2; --i) { for(int32_t i = end; i > start-2; --i) {
if(Mr[start]) { if(Mr[start]) {
Mr[i] ^= _bchG[j]; Mr[i] ^= bchG[j];
++j; ++j;
} else { } else {
++start; ++start;

81
src/protocols/Pager/Pager.h
View file

@ -63,14 +63,12 @@
/*! /*!
\class PagerClient \class PagerClient
\brief Client for Pager communication. \brief Client for Pager communication.
*/ */
class PagerClient { class PagerClient {
public: public:
/*! /*!
\brief Default constructor. \brief Default constructor.
\param phy Pointer to the wireless module providing PhysicalLayer communication. \param phy Pointer to the wireless module providing PhysicalLayer communication.
*/ */
explicit PagerClient(PhysicalLayer* phy); explicit PagerClient(PhysicalLayer* phy);
@ -79,24 +77,17 @@ class PagerClient {
/*! /*!
\brief Initialization method. \brief Initialization method.
\param base Base (center) frequency to be used in MHz. \param base Base (center) frequency to be used in MHz.
\param speed Bit rate to use in bps. Common POCSAG decoders can receive 512, 1200 and 2400 bps. \param speed Bit rate to use in bps. Common POCSAG decoders can receive 512, 1200 and 2400 bps.
\param invert Enable frequency inversion. Disabled by default (high frequency is digital 0). \param invert Enable frequency inversion. Disabled by default (high frequency is digital 0).
\param shift Set custom frequency shift, defaults to 4500 Hz. \param shift Set custom frequency shift, defaults to 4500 Hz.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t begin(float base, uint16_t speed, bool invert = false, uint16_t shift = RADIOLIB_PAGER_FREQ_SHIFT_HZ); int16_t begin(float base, uint16_t speed, bool invert = false, uint16_t shift = RADIOLIB_PAGER_FREQ_SHIFT_HZ);
/*! /*!
\brief Method to send a tone-only alert to a destination pager. \brief Method to send a tone-only alert to a destination pager.
\param addr Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved. \param addr Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t sendTone(uint32_t addr); int16_t sendTone(uint32_t addr);
@ -104,13 +95,9 @@ class PagerClient {
#if defined(RADIOLIB_BUILD_ARDUINO) #if defined(RADIOLIB_BUILD_ARDUINO)
/*! /*!
\brief Arduino String transmit method. \brief Arduino String transmit method.
\param str Address of Arduino string that will be transmitted. \param str Address of Arduino string that will be transmitted.
\param addr Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved. \param addr Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved.
\param encoding Encoding to be used (BCD or ASCII). Defaults to RADIOLIB_PAGER_BCD. \param encoding Encoding to be used (BCD or ASCII). Defaults to RADIOLIB_PAGER_BCD.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t transmit(String& str, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD); int16_t transmit(String& str, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD);
@ -118,50 +105,36 @@ class PagerClient {
/*! /*!
\brief C-string transmit method. \brief C-string transmit method.
\param str C-string that will be transmitted. \param str C-string that will be transmitted.
\param addr Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved. \param addr Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved.
\param encoding Encoding to be used (BCD or ASCII). Defaults to RADIOLIB_PAGER_BCD. \param encoding Encoding to be used (BCD or ASCII). Defaults to RADIOLIB_PAGER_BCD.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t transmit(const char* str, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD); int16_t transmit(const char* str, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD);
/*! /*!
\brief Binary transmit method. Will transmit arbitrary binary data. \brief Binary transmit method. Will transmit arbitrary binary data.
\param data Binary data that will be transmitted. \param data Binary data that will be transmitted.
\param len Length of binary data to transmit (in bytes). \param len Length of binary data to transmit (in bytes).
\param addr Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved. \param addr Address of the destination pager. Allowed values are 0 to 2097151 - values above 2000000 are reserved.
\param encoding Encoding to be used (BCD or ASCII). Defaults to RADIOLIB_PAGER_BCD. \param encoding Encoding to be used (BCD or ASCII). Defaults to RADIOLIB_PAGER_BCD.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t transmit(uint8_t* data, size_t len, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD); int16_t transmit(uint8_t* data, size_t len, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD);
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)
/*! /*!
\brief Start reception of POCSAG packets. \brief Start reception of POCSAG packets.
\param pin Pin to receive digital data on (e.g., DIO2 for SX127x). \param pin Pin to receive digital data on (e.g., DIO2 for SX127x).
\param addr Address of this "pager". Allowed values are 0 to 2097151 - values above 2000000 are reserved. \param addr Address of this "pager". Allowed values are 0 to 2097151 - values above 2000000 are reserved.
\param mask Address filter mask - set individual bits to enable or disable match on that bit of the address.
\param mask Address filter mask - set individual bits to enable or disable match on that bit of the address.¨Set to 0xFFFFF (all bits checked) by default. Set to 0xFFFFF (all bits checked) by default.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t startReceive(uint32_t pin, uint32_t addr, uint32_t mask = 0xFFFFF); int16_t startReceive(uint32_t pin, uint32_t addr, uint32_t mask = 0xFFFFF);
/*! /*!
\brief Get the number of POCSAG batches available in buffer. Limited by the size of direct mode buffer! \brief Get the number of POCSAG batches available in buffer. Limited by the size of direct mode buffer!
\returns Number of available batches. \returns Number of available batches.
*/ */
size_t available(); size_t available();
@ -169,14 +142,11 @@ class PagerClient {
#if defined(RADIOLIB_BUILD_ARDUINO) #if defined(RADIOLIB_BUILD_ARDUINO)
/*! /*!
\brief Reads data that was received after calling startReceive method. \brief Reads data that was received after calling startReceive method.
\param str Address of Arduino String to save the received data. \param str Address of Arduino String to save the received data.
\param len Expected number of characters in the message. When set to 0, the message lengthwill be retreived
\param len Expected number of characters in the message. When set to 0, the message length will be retreived automatically. automatically. When more bytes than received are requested, only the number of bytes requested will be returned.
When more bytes than received are requested, only the number of bytes requested will be returned. \param addr Pointer to variable holding the address of the received pager message.
Set to NULL to not retrieve address.
\param addr Pointer to variable holding the address of the received pager message. Set to NULL to not retrieve address.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t readData(String& str, size_t len = 0, uint32_t* addr = NULL); int16_t readData(String& str, size_t len = 0, uint32_t* addr = NULL);
@ -184,15 +154,12 @@ class PagerClient {
/*! /*!
\brief Reads data that was received after calling startReceive method. \brief Reads data that was received after calling startReceive method.
\param data Pointer to array to save the received message. \param data Pointer to array to save the received message.
\param len Pointer to variable holding the number of bytes that will be read. When set to 0, the packet length
\param len Pointer to variable holding the number of bytes that will be read. When set to 0, the packet length will be retreived automatically. will be retreived automatically. When more bytes than received are requested, only the number of bytes
When more bytes than received are requested, only the number of bytes requested will be returned. requested will be returned. Upon completion, the number of bytes received will be written to this variable.
Upon completion, the number of bytes received will be written to this variable. \param addr Pointer to variable holding the address of the received pager message.
Set to NULL to not retrieve address.
\param addr Pointer to variable holding the address of the received pager message. Set to NULL to not retrieve address.
\returns \ref status_codes \returns \ref status_codes
*/ */
int16_t readData(uint8_t* data, size_t* len, uint32_t* addr = NULL); int16_t readData(uint8_t* data, size_t* len, uint32_t* addr = NULL);
@ -201,22 +168,22 @@ class PagerClient {
#if !defined(RADIOLIB_GODMODE) #if !defined(RADIOLIB_GODMODE)
private: private:
#endif #endif
PhysicalLayer* _phy; PhysicalLayer* phyLayer;
float _base; float baseFreq;
float _speed; float dataRate;
uint32_t _baseRaw; uint32_t baseFreqRaw;
uint16_t _shift; uint16_t shiftFreq;
uint16_t _shiftHz; uint16_t shiftFreqHz;
uint16_t _bitDuration; uint16_t bitDuration;
uint32_t _filterAddr; uint32_t filterAddr;
uint32_t _filterMask; uint32_t filterMask;
bool inv = false; bool inv = false;
// BCH encoder // BCH encoder
int32_t _bchAlphaTo[RADIOLIB_PAGER_BCH_N + 1]; int32_t bchAlphaTo[RADIOLIB_PAGER_BCH_N + 1];
int32_t _bchIndexOf[RADIOLIB_PAGER_BCH_N + 1]; int32_t bchIndexOf[RADIOLIB_PAGER_BCH_N + 1];
int32_t _bchG[RADIOLIB_PAGER_BCH_N - RADIOLIB_PAGER_BCH_K + 1]; int32_t bchG[RADIOLIB_PAGER_BCH_N - RADIOLIB_PAGER_BCH_K + 1];
void write(uint32_t* data, size_t len); void write(uint32_t* data, size_t len);
void write(uint32_t codeWord); void write(uint32_t codeWord);