RadioLib
Universal wireless communication library for Arduino
Loading...
Searching...
No Matches
STM32WLx.h
1/*
2Copyright (c) 2018 Jan Gromeš
3Copyright (c) 2022 STMicroelectronics
4
5This file is licensed under the MIT License: https://opensource.org/licenses/MIT
6*/
7
8#if !defined(_RADIOLIB_STM32WLx_H)
9#define _RADIOLIB_STM32WLx_H
10
11#include "../../TypeDef.h"
12
13#if !RADIOLIB_EXCLUDE_STM32WLX
14
15#include "../../Module.h"
16#include "SX1262.h"
17#include "STM32WLx_Module.h"
18
33class STM32WLx : public SX1262 {
34 // NOTE: This class could not be named STM32WL (or STM32WLxx), since
35 // those are macros defined by
36 // system/Drivers/CMSIS/Device/ST/STM32WLxxx/Include/stm32wlxx.h
37 public:
42 STM32WLx(STM32WLx_Module* mod); // cppcheck-suppress noExplicitConstructor
43
63
64 // basic methods
65
69 int16_t begin(float freq = 434.0, float bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power = 10, uint16_t preambleLength = 8, float tcxoVoltage = 1.6, bool useRegulatorLDO = false) override;
70
74 int16_t beginFSK(float freq = 434.0, float br = 4.8, float freqDev = 5.0, float rxBw = 156.2, int8_t power = 10, uint16_t preambleLength = 16, float tcxoVoltage = 1.6, bool useRegulatorLDO = false) override;
75
76 // configuration methods
77
92 virtual int16_t setOutputPower(int8_t power) override;
93
109 // Note: This explicitly inherits this method only to override docs
111
116 void setDio1Action(void (*func)(void)) override;
117
121 void clearDio1Action() override;
122
127 void setPacketReceivedAction(void (*func)(void)) override;
128
132 void clearPacketReceivedAction() override;
133
138 void setPacketSentAction(void (*func)(void)) override;
139
143 void clearPacketSentAction() override;
144
149 void setChannelScanAction(void (*func)(void)) override;
150
154 void clearChannelScanAction() override;
155
156#if !RADIOLIB_GODMODE
157 protected:
158#endif
159 virtual int16_t clearIrqStatus(uint16_t clearIrqParams) override;
160
161#if !RADIOLIB_GODMODE
162 private:
163#endif
164};
165
166#endif
167
168#endif
@ MODE_TX
Transmission mode.
Definition Module.h:119
@ MODE_IDLE
Idle mode.
Definition Module.h:113
@ MODE_RX
Receive mode.
Definition Module.h:116
@ MODE_END_OF_TABLE
End of table marker, use END_OF_MODE_TABLE constant instead. Value is zero to ensure zero-initialized...
Definition Module.h:110
Definition STM32WLx_Module.h:26
Derived class for STM32WL modules.
Definition STM32WLx.h:33
void setChannelScanAction(void(*func)(void)) override
Sets interrupt service routine to call when a channel scan is finished.
Definition STM32WLx.cpp:146
void clearChannelScanAction() override
Clears interrupt service routine to call when a channel scan is finished.
Definition STM32WLx.cpp:150
void clearDio1Action() override
Clears interrupt service routine to call when DIO1/2/3 activates.
Definition STM32WLx.cpp:126
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition STM32WLx.cpp:138
int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX126X_SYNC_WORD_PRIVATE, int8_t power=10, uint16_t preambleLength=8, float tcxoVoltage=1.6, bool useRegulatorLDO=false) override
Initialization method for LoRa modem.
Definition STM32WLx.cpp:13
virtual int16_t setOutputPower(int8_t power) override
Sets output power. Allowed values are in range from -17 to 22 dBm.
Definition STM32WLx.cpp:41
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition STM32WLx.cpp:134
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition STM32WLx.cpp:142
OpMode_t
Custom operation modes for STMWLx.
Definition STM32WLx.h:51
@ MODE_END_OF_TABLE
Definition STM32WLx.h:53
@ MODE_TX_LP
Definition STM32WLx.h:59
@ MODE_TX_HP
Definition STM32WLx.h:61
@ MODE_RX
Definition STM32WLx.h:57
@ MODE_IDLE
Definition STM32WLx.h:55
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition STM32WLx.cpp:130
void setDio1Action(void(*func)(void)) override
Sets interrupt service routine to call when DIO1/2/3 activates.
Definition STM32WLx.cpp:116
int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=156.2, int8_t power=10, uint16_t preambleLength=16, float tcxoVoltage=1.6, bool useRegulatorLDO=false) override
Initialization method for FSK modem.
Definition STM32WLx.cpp:27
Derived class for SX1262 modules.
Definition SX1262.h:22
void setRfSwitchTable(const uint32_t(&pins)[Module::RFSWITCH_MAX_PINS], const Module::RfSwitchMode_t table[])
Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...
Definition SX126x.cpp:1456