RadioLib
Universal wireless communication library for Arduino
PhysicalLayer.h
1 #ifndef _RADIOLIB_PHYSICAL_LAYER_H
2 #define _RADIOLIB_PHYSICAL_LAYER_H
3 
4 #include "../../TypeDef.h"
5 #include "../../Module.h"
6 
15  public:
16 
17  // constructor
18 
26  PhysicalLayer(float freqStep, size_t maxPacketLength);
27 
28  // basic methods
29 
39  int16_t transmit(__FlashStringHelper* fstr, uint8_t addr = 0);
40 
50  int16_t transmit(String& str, uint8_t addr = 0);
51 
61  int16_t transmit(const char* str, uint8_t addr = 0);
62 
74  virtual int16_t transmit(uint8_t* data, size_t len, uint8_t addr = 0) = 0;
75 
85  int16_t receive(String& str, size_t len = 0);
86 
92  virtual int16_t standby() = 0;
93 
103  virtual int16_t receive(uint8_t* data, size_t len) = 0;
104 
115  int16_t startTransmit(String& str, uint8_t addr = 0);
116 
127  int16_t startTransmit(const char* str, uint8_t addr = 0);
128 
140  virtual int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) = 0;
141 
151  int16_t readData(String& str, size_t len = 0);
152 
162  virtual int16_t readData(uint8_t* data, size_t len) = 0;
163 
172  virtual int16_t transmitDirect(uint32_t frf = 0) = 0;
173 
180  virtual int16_t receiveDirect() = 0;
181 
182  // configuration methods
183 
192  virtual int16_t setFrequencyDeviation(float freqDev) = 0;
193 
201  virtual int16_t setDataShaping(uint8_t sh) = 0;
202 
210  virtual int16_t setEncoding(uint8_t encoding) = 0;
211 
217  float getFreqStep() const;
218 
226  virtual size_t getPacketLength(bool update = true) = 0;
227 
235  int32_t random(int32_t max);
236 
246  int32_t random(int32_t min, int32_t max);
247 
253  virtual uint8_t random() = 0;
254 
260  int16_t startDirect();
261 
271  int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len);
272 
278  virtual void setDirectAction(void (*func)(void)) = 0;
279 
285  virtual void readBit(RADIOLIB_PIN_TYPE pin) = 0;
286 
292  int16_t available();
293 
299  uint8_t read();
300 
301  protected:
302  void updateDirectBuffer(uint8_t bit);
303 
304 #ifndef RADIOLIB_GODMODE
305  private:
306 #endif
307  float _freqStep;
308  size_t _maxPacketLength;
309 
310  uint8_t _bufferBitPos;
311  uint8_t _bufferWritePos;
312  uint8_t _bufferReadPos;
313  uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];
314  uint32_t _syncBuffer;
315  uint32_t _directSyncWord;
316  uint32_t _directSyncWordMask;
317  bool _gotSync;
318 };
319 
320 #endif
PhysicalLayer::transmit
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
PhysicalLayer::standby
virtual int16_t standby()=0
Sets module to standby.
PhysicalLayer::setFrequencyDeviation
virtual int16_t setFrequencyDeviation(float freqDev)=0
Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...
PhysicalLayer::setEncoding
virtual int16_t setEncoding(uint8_t encoding)=0
Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.
PhysicalLayer::transmitDirect
virtual int16_t transmitDirect(uint32_t frf=0)=0
Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...
PhysicalLayer::available
int16_t available()
Get the number of direct mode bytes currently available in buffer.
Definition: PhysicalLayer.cpp:187
PhysicalLayer::setDirectAction
virtual void setDirectAction(void(*func)(void))=0
Set interrupt service routine function to call when data bit is receveid in direct mode....
PhysicalLayer::readBit
virtual void readBit(RADIOLIB_PIN_TYPE pin)=0
Function to read and process data bit in direct reception mode. Must be implemented in module class.
PhysicalLayer::readData
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
PhysicalLayer::receiveDirect
virtual int16_t receiveDirect()=0
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...
PhysicalLayer::read
uint8_t read()
Get data from direct mode buffer.
Definition: PhysicalLayer.cpp:191
PhysicalLayer::PhysicalLayer
PhysicalLayer(float freqStep, size_t maxPacketLength)
Default constructor.
Definition: PhysicalLayer.cpp:3
PhysicalLayer::startDirect
int16_t startDirect()
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....
Definition: PhysicalLayer.cpp:173
PhysicalLayer::random
virtual uint8_t random()=0
Get one truly random byte from RSSI noise. Must be implemented in module class.
PhysicalLayer
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
PhysicalLayer::receive
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
PhysicalLayer::getPacketLength
virtual size_t getPacketLength(bool update=true)=0
Query modem for the packet length of received payload. Must be implemented in module class.
PhysicalLayer::setDirectSyncWord
int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)
Set sync word to be used to determine start of packet in direct reception mode.
Definition: PhysicalLayer.cpp:198
PhysicalLayer::getFreqStep
float getFreqStep() const
Gets the module frequency step size that was set in constructor.
Definition: PhysicalLayer.cpp:145
PhysicalLayer::setDataShaping
virtual int16_t setDataShaping(uint8_t sh)=0
Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.
PhysicalLayer::startTransmit
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51