RadioLib
Universal wireless communication library for Arduino
Loading...
Searching...
No Matches
Hal.h
1#if !defined(_RADIOLIB_HAL_H)
2#define _RADIOLIB_HAL_H
3
4#include <stdint.h>
5#include <stddef.h>
6
7#include "BuildOpt.h"
8
10RadioLibTime_t rlb_time_us();
11
17 public:
18
19 // values for pin modes, levels and change directions
20 // these tell RadioLib how are different logic states represented on a given platform
21
25 const uint32_t GpioModeInput;
26
30 const uint32_t GpioModeOutput;
31
35 const uint32_t GpioLevelLow;
36
40 const uint32_t GpioLevelHigh;
41
45 const uint32_t GpioInterruptRising;
46
50 const uint32_t GpioInterruptFalling;
51
61 RadioLibHal(const uint32_t input, const uint32_t output, const uint32_t low, const uint32_t high, const uint32_t rising, const uint32_t falling);
62
63 // pure virtual methods - these must be implemented by the hardware abstraction for RadioLib to function
64
71 virtual void pinMode(uint32_t pin, uint32_t mode) = 0;
72
79 virtual void digitalWrite(uint32_t pin, uint32_t value) = 0;
80
87 virtual uint32_t digitalRead(uint32_t pin) = 0;
88
96 virtual void attachInterrupt(uint32_t interruptNum, void (*interruptCb)(void), uint32_t mode) = 0;
97
103 virtual void detachInterrupt(uint32_t interruptNum) = 0;
104
110 virtual void delay(RadioLibTime_t ms) = 0;
111
117 virtual void delayMicroseconds(RadioLibTime_t us) = 0;
118
124 virtual RadioLibTime_t millis() = 0;
125
131 virtual RadioLibTime_t micros() = 0;
132
141 virtual long pulseIn(uint32_t pin, uint32_t state, RadioLibTime_t timeout) = 0;
142
146 virtual void spiBegin() = 0;
147
151 virtual void spiBeginTransaction() = 0;
152
159 virtual void spiTransfer(uint8_t* out, size_t len, uint8_t* in) = 0;
160
164 virtual void spiEndTransaction() = 0;
165
169 virtual void spiEnd() = 0;
170
171 // virtual methods - these may or may not exists on a given platform
172 // they exist in this implementation, but do nothing
173
179 virtual void init();
180
186 virtual void term();
187
194 virtual void tone(uint32_t pin, unsigned int frequency, RadioLibTime_t duration = 0);
195
200 virtual void noTone(uint32_t pin);
201
205 virtual void yield();
206
212 virtual uint32_t pinToInterrupt(uint32_t pin);
213};
214
215#endif
Hardware abstraction library base interface.
Definition Hal.h:16
const uint32_t GpioInterruptFalling
Value to be used as the "falling" GPIO level change direction.
Definition Hal.h:50
virtual uint32_t digitalRead(uint32_t pin)=0
Digital read method. Must be implemented by the platform-specific hardware abstraction!
const uint32_t GpioModeOutput
Value to be used as the "output" GPIO direction.
Definition Hal.h:30
virtual void yield()
Yield method, called from long loops in multi-threaded environment (to prevent blocking other threads...
Definition Hal.cpp:35
const uint32_t GpioModeInput
Value to be used as the "input" GPIO direction.
Definition Hal.h:25
virtual void detachInterrupt(uint32_t interruptNum)=0
Method to detach function from an external interrupt. Must be implemented by the platform-specific ha...
virtual uint32_t pinToInterrupt(uint32_t pin)
Function to convert from pin number to interrupt number.
Definition Hal.cpp:39
const uint32_t GpioLevelLow
Value to be used as the "low" GPIO level.
Definition Hal.h:35
virtual long pulseIn(uint32_t pin, uint32_t state, RadioLibTime_t timeout)=0
Measure the length of incoming digital pulse in microseconds. Must be implemented by the platform-spe...
const uint32_t GpioLevelHigh
Value to be used as the "high" GPIO level.
Definition Hal.h:40
virtual void spiEnd()=0
SPI termination method.
virtual void init()
Module initialization method. This will be called by all radio modules at the beginning of startup....
Definition Hal.cpp:17
virtual RadioLibTime_t millis()=0
Get number of milliseconds since start. Must be implemented by the platform-specific hardware abstrac...
virtual void digitalWrite(uint32_t pin, uint32_t value)=0
Digital write method. Must be implemented by the platform-specific hardware abstraction!
virtual void tone(uint32_t pin, unsigned int frequency, RadioLibTime_t duration=0)
Method to produce a square-wave with 50% duty cycle ("tone") of a given frequency at some pin.
Definition Hal.cpp:25
virtual RadioLibTime_t micros()=0
Get number of microseconds since start. Must be implemented by the platform-specific hardware abstrac...
virtual void spiEndTransaction()=0
Method to end SPI transaction.
virtual void noTone(uint32_t pin)
Method to stop producing a tone.
Definition Hal.cpp:31
const uint32_t GpioInterruptRising
Value to be used as the "rising" GPIO level change direction.
Definition Hal.h:45
virtual void spiBegin()=0
SPI initialization method.
virtual void delay(RadioLibTime_t ms)=0
Blocking wait function. Must be implemented by the platform-specific hardware abstraction!
virtual void term()
Module termination method. This will be called by all radio modules when the destructor is called....
Definition Hal.cpp:21
virtual void delayMicroseconds(RadioLibTime_t us)=0
Blocking microsecond wait function. Must be implemented by the platform-specific hardware abstraction...
virtual void spiBeginTransaction()=0
Method to start SPI transaction.
virtual void spiTransfer(uint8_t *out, size_t len, uint8_t *in)=0
Method to transfer buffer over SPI.
virtual void pinMode(uint32_t pin, uint32_t mode)=0
GPIO pin mode (input/output/...) configuration method. Must be implemented by the platform-specific h...
virtual void attachInterrupt(uint32_t interruptNum, void(*interruptCb)(void), uint32_t mode)=0
Method to attach function to an external interrupt. Must be implemented by the platform-specific hard...
unsigned long RadioLibTime_t
Type used for durations in RadioLib.
Definition TypeDef.h:642