RadioLib
Universal wireless communication library for Arduino
|
1 #if !defined(_RADIOLIB_PHYSICAL_LAYER_H)
2 #define _RADIOLIB_PHYSICAL_LAYER_H
4 #include "../../TypeDef.h"
5 #include "../../Module.h"
39 int16_t
transmit(__FlashStringHelper* fstr, uint8_t addr = 0);
50 int16_t
transmit(String& str, uint8_t addr = 0);
61 int16_t
transmit(
const char* str, uint8_t addr = 0);
74 virtual int16_t
transmit(uint8_t* data,
size_t len, uint8_t addr = 0) = 0;
85 int16_t
receive(String& str,
size_t len = 0);
103 virtual int16_t
receive(uint8_t* data,
size_t len) = 0;
140 virtual int16_t
startTransmit(uint8_t* data,
size_t len, uint8_t addr = 0) = 0;
152 int16_t
readData(String& str,
size_t len = 0);
164 virtual int16_t
readData(uint8_t* data,
size_t len) = 0;
237 int32_t
random(int32_t max);
248 int32_t
random(int32_t min, int32_t max);
287 virtual void readBit(RADIOLIB_PIN_TYPE pin) = 0;
303 virtual Module* getMod() = 0;
306 void updateDirectBuffer(uint8_t bit);
308 #if !defined(RADIOLIB_GODMODE)
312 size_t _maxPacketLength;
314 uint8_t _bufferBitPos;
315 uint8_t _bufferWritePos;
316 uint8_t _bufferReadPos;
317 uint8_t _buffer[RADIOLIB_STATIC_ARRAY_SIZE];
318 uint32_t _syncBuffer;
319 uint32_t _directSyncWord;
320 uint8_t _directSyncWordLen;
321 uint32_t _directSyncWordMask;
int16_t transmit(__FlashStringHelper *fstr, uint8_t addr=0)
Arduino Flash String transmit method.
Definition: PhysicalLayer.cpp:10
virtual int16_t standby()=0
Sets module to standby.
virtual int16_t setFrequencyDeviation(float freqDev)=0
Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...
virtual int16_t setEncoding(uint8_t encoding)=0
Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.
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 ...
int16_t available()
Get the number of direct mode bytes currently available in buffer.
Definition: PhysicalLayer.cpp:191
virtual void setDirectAction(void(*func)(void))=0
Set interrupt service routine function to call when data bit is receveid in direct mode....
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.
int16_t readData(String &str, size_t len=0)
Reads data that was received after calling startReceive method.
Definition: PhysicalLayer.cpp:59
virtual int16_t receiveDirect()=0
Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...
uint8_t read()
Get data from direct mode buffer.
Definition: PhysicalLayer.cpp:195
PhysicalLayer(float freqStep, size_t maxPacketLength)
Default constructor.
Definition: PhysicalLayer.cpp:3
int16_t startDirect()
Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....
Definition: PhysicalLayer.cpp:177
virtual uint8_t randomByte()=0
Get one truly random byte from RSSI noise. Must be implemented in module class.
int32_t random(int32_t max)
Get truly random number in range 0 - max.
Definition: PhysicalLayer.cpp:149
Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....
Definition: PhysicalLayer.h:14
int16_t receive(String &str, size_t len=0)
Arduino String receive method.
Definition: PhysicalLayer.cpp:100
virtual size_t getPacketLength(bool update=true)=0
Query modem for the packet length of received payload. Must be implemented in module class.
Implements all common low-level methods to control the wireless module. Every module class contains o...
Definition: Module.h:16
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:204
float getFreqStep() const
Gets the module frequency step size that was set in constructor.
Definition: PhysicalLayer.cpp:145
virtual int16_t setDataShaping(uint8_t sh)=0
Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.
int16_t startTransmit(String &str, uint8_t addr=0)
Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...
Definition: PhysicalLayer.cpp:51