# RadioLib: src/modules/SX126x/STM32WLx.h Source File

STM32WLx.h
/*
Copyright (c) 2018 Jan Gromeš
Copyright (c) 2022 STMicroelectronics
This file is licensed under the MIT License: https://opensource.org/licenses/MIT
*/
#if !defined(_RADIOLIB_STM32WLx_H)
#define _RADIOLIB_STM32WLx_H
#include "../../TypeDef.h"
#if !RADIOLIB_EXCLUDE_STM32WLX
#include "../../Module.h"
#include "SX1262.h"
#include "STM32WLx_Module.h"
class STM32WLx : public SX1262 {
// NOTE: This class could not be named STM32WL (or STM32WLxx), since
// those are macros defined by
// system/Drivers/CMSIS/Device/ST/STM32WLxxx/Include/stm32wlxx.h
public:
STM32WLx(STM32WLx_Module* mod); // cppcheck-suppress noExplicitConstructor
enum OpMode_t {
MODE_END_OF_TABLE = Module::MODE_END_OF_TABLE,
MODE_IDLE = Module::MODE_IDLE,
MODE_RX = Module::MODE_RX,
MODE_TX_LP = Module::MODE_TX,
MODE_TX_HP,
};
// basic methods
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);
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);
// configuration methods
virtual int16_t setOutputPower(int8_t power) override;
// Note: This explicitly inherits this method only to override docs
using SX126x::setRfSwitchTable;
void setDio1Action(void (*func)(void));
void clearDio1Action();
void setPacketReceivedAction(void (*func)(void)) override;
void clearPacketReceivedAction() override;
void setPacketSentAction(void (*func)(void)) override;
void clearPacketSentAction() override;
void setChannelScanAction(void (*func)(void)) override;
void clearChannelScanAction() override;
#if !RADIOLIB_GODMODE
protected:
#endif
virtual int16_t clearIrqStatus(uint16_t clearIrqParams) override;
#if !RADIOLIB_GODMODE
private:
#endif
};
#endif
#endif
Module::MODE_TX
@ MODE_TX
Transmission mode.
Definition: Module.h:111
Module::MODE_IDLE
@ MODE_IDLE
Idle mode.
Definition: Module.h:105
Module::MODE_RX
@ MODE_RX
Receive mode.
Definition: Module.h:108
Module::MODE_END_OF_TABLE
@ 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:102
STM32WLx_Module
Definition: STM32WLx_Module.h:26
STM32WLx
Derived class for STM32WL modules.
Definition: STM32WLx.h:33
STM32WLx::setChannelScanAction
void setChannelScanAction(void(*func)(void)) override
Sets interrupt service routine to call when a channel scan is finished.
Definition: STM32WLx.cpp:146
STM32WLx::clearChannelScanAction
void clearChannelScanAction() override
Clears interrupt service routine to call when a channel scan is finished.
Definition: STM32WLx.cpp:150
STM32WLx::begin
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)
Initialization method for LoRa modem.
Definition: STM32WLx.cpp:13
STM32WLx::clearDio1Action
void clearDio1Action()
Clears interrupt service routine to call when DIO1/2/3 activates.
Definition: STM32WLx.cpp:126
STM32WLx::setDio1Action
void setDio1Action(void(*func)(void))
Sets interrupt service routine to call when DIO1/2/3 activates.
Definition: STM32WLx.cpp:116
STM32WLx::setPacketSentAction
void setPacketSentAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is sent.
Definition: STM32WLx.cpp:138
STM32WLx::setOutputPower
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
STM32WLx::clearPacketReceivedAction
void clearPacketReceivedAction() override
Clears interrupt service routine to call when a packet is received.
Definition: STM32WLx.cpp:134
STM32WLx::STM32WLx
STM32WLx(STM32WLx_Module *mod)
Default constructor.
Definition: STM32WLx.cpp:11
STM32WLx::clearPacketSentAction
void clearPacketSentAction() override
Clears interrupt service routine to call when a packet is sent.
Definition: STM32WLx.cpp:142
STM32WLx::OpMode_t
OpMode_t
Custom operation modes for STMWLx.
Definition: STM32WLx.h:51
STM32WLx::MODE_END_OF_TABLE
@ MODE_END_OF_TABLE
Definition: STM32WLx.h:53
STM32WLx::MODE_TX_LP
@ MODE_TX_LP
Definition: STM32WLx.h:59
STM32WLx::MODE_TX_HP
@ MODE_TX_HP
Definition: STM32WLx.h:61
STM32WLx::MODE_RX
@ MODE_RX
Definition: STM32WLx.h:57
STM32WLx::MODE_IDLE
@ MODE_IDLE
Definition: STM32WLx.h:55
STM32WLx::setPacketReceivedAction
void setPacketReceivedAction(void(*func)(void)) override
Sets interrupt service routine to call when a packet is received.
Definition: STM32WLx.cpp:130
STM32WLx::beginFSK
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)
Initialization method for FSK modem.
Definition: STM32WLx.cpp:27
SX1262
Derived class for SX1262 modules.
Definition: SX1262.h:22
SX126x::setRfSwitchTable
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:1426