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"
 
#if defined(ARDUINO_ARCH_STM32) && defined(STM32WLxx)
#include "hal/Stm32duino/Stm32wlHal.h"
#endif
 
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(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(const ConfigLoRa_t& config) override;
 
    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;
    
    int16_t beginFSK(const ConfigFSK_t& config) override;
 
    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;
 
    // configuration methods
 
    int16_t setOutputPower(int8_t power) override;
 
    int16_t checkOutputPower(int8_t power, int8_t* clipped) override;
 
    // Note: This explicitly inherits this method only to override docs
    using SX126x::setRfSwitchTable;
 
  #if defined(ARDUINO_ARCH_STM32)
    void setDio1Action(void (*func)(void)) override;
 
    void clearDio1Action() override;
  #endif  // ARDUINO_ARCH_STM32
 
    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