Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
sx1276/sx1276-arduino-hal.h
- Committer:
- Helmut Tschemernjak
- Date:
- 2017-05-31
- Revision:
- 61:08b50780eb91
- Parent:
- 52:4d304485eda0
File content as of revision 61:08b50780eb91:
/*
* This file contains a copy of the master content sx1276-mbed-hal.h
* with adaption for the Arduino environment
* (c) 2017 Helmut Tschemernjak
* 30826 Garbsen (Hannover) Germany
*/
#ifdef ARDUINO
/*
(C) 2014 Semtech
Description: -
License: Revised BSD License, see LICENSE.TXT file include in the project
Maintainers: Miguel Luis, Gregory Cristian and Nicolas Huguenin
*/
/*
* additional development to make it more generic across multiple OS versions
* (c) 2017 Helmut Tschemernjak
* 30826 Garbsen (Hannover) Germany
*/
#ifndef __SX1276_ARDUINO_HAL_H__
#define __SX1276_ARDUINO_HAL_H__
#include "sx1276.h"
/*!
* Actual implementation of a SX1276 radio, includes some modifications to make it compatible with the MB1 LAS board
*/
class SX1276Generic : public SX1276
{
protected:
/*!
* Antenna switch GPIO pins objects
*/
DigitalOut *_antSwitch;
DigitalOut *_antSwitchTX;
DigitalOut *_antSwitchTXBoost;
/*!
* SX1276 Reset pin
*/
DigitalInOut *_reset;
/*!
* TCXO being used with the Murata Module
*/
DigitalOut *_tcxo;
/*!
* SPI Interface
*/
SPI *_spi; // mosi, miso, sclk
DigitalOut *_nss;
/*!
* SX1276 DIO pins
*/
InterruptIn *_dio0;
InterruptIn *_dio1;
InterruptIn *_dio2;
InterruptIn *_dio3;
InterruptIn *_dio4;
DigitalIn *_dio5;
/*!
* Tx and Rx timers
*/
Timeout txTimeoutTimer;
Timeout rxTimeoutTimer;
Timeout rxTimeoutSyncWord;
private:
/*!
* triggers definition
*/
typedef void (SX1276Generic::*Trigger)(void);
public:
SX1276Generic( RadioEvents_t *events, BoardType_t board,
PinName mosi, PinName miso, PinName sclk, PinName nss, PinName reset,
PinName dio0, PinName dio1, PinName dio2, PinName dio3, PinName dio4, PinName dio5,
PinName antSwitch = NC, PinName antSwitchTX= NC, PinName antSwitchTXBoost = NC, PinName tcxo = NC);
SX1276Generic( RadioEvents_t *events );
virtual ~SX1276Generic();
protected:
/*!
* @brief Initializes the radio I/Os pins interface
*/
virtual void IoInit( void );
/*!
* @brief Initializes the radio SPI
*/
virtual void SpiInit( void );
/*!
* @brief Initializes DIO IRQ handlers
*
* @param [IN] irqHandlers Array containing the IRQ callback functions
*/
virtual void IoIrqInit( DioIrqHandler *irqHandlers );
/*!
* @brief De-initializes the radio I/Os pins interface.
*
* \remark Useful when going in MCU lowpower modes
*/
virtual void IoDeInit( void );
/*!
* @brief Gets the board PA selection configuration
*
* @param [IN] channel Channel frequency in Hz
* @retval PaSelect RegPaConfig PaSelect value
*/
virtual uint8_t GetPaSelect( uint32_t channel );
/*!
* @brief Set the RF Switch I/Os pins in Low Power mode
*
* @param [IN] status enable or disable
*/
virtual void SetAntSwLowPower( bool status );
/*!
* @brief Initializes the RF Switch I/Os pins interface
*/
virtual void AntSwInit( void );
/*!
* @brief De-initializes the RF Switch I/Os pins interface
*
* @remark Needed to decrease the power consumption in MCU lowpower modes
*/
virtual void AntSwDeInit( void );
/*!
* @brief Controls the antena switch if necessary.
*
* @remark see errata note
*
* @param [IN] opMode Current radio operating mode
*/
virtual void SetAntSw( uint8_t opMode );
/*
* The the Timeout for a given Timer.
*/
virtual void SetTimeout(TimeoutTimer_t timer, timeoutFuncPtr, int timeout_ms = 0);
public:
/*!
* @brief Detect the board connected by reading the value of the antenna switch pin
*/
virtual uint8_t DetectBoardType( void );
/*!
* @brief Checks if the given RF frequency is supported by the hardware
*
* @param [IN] frequency RF frequency to be checked
* @retval isSupported [true: supported, false: unsupported]
*/
virtual bool CheckRfFrequency( uint32_t frequency );
/*!
* @brief Writes the radio register at the specified address
*
* @param [IN]: addr Register address
* @param [IN]: data New register value
*/
virtual void Write ( uint8_t addr, uint8_t data ) ;
/*!
* @brief Reads the radio register at the specified address
*
* @param [IN]: addr Register address
* @retval data Register value
*/
virtual uint8_t Read ( uint8_t addr ) ;
/*!
* @brief Writes multiple radio registers starting at address
*
* @param [IN] addr First Radio register address
* @param [IN] buffer Buffer containing the new register's values
* @param [IN] size Number of registers to be written
*/
virtual void Write( uint8_t addr, void *buffer, uint8_t size ) ;
/*!
* @brief Reads multiple radio registers starting at address
*
* @param [IN] addr First Radio register address
* @param [OUT] buffer Buffer where to copy the registers data
* @param [IN] size Number of registers to be read
*/
virtual void Read ( uint8_t addr, void *buffer, uint8_t size ) ;
/*!
* @brief Writes the buffer contents to the SX1276 FIFO
*
* @param [IN] buffer Buffer containing data to be put on the FIFO.
* @param [IN] size Number of bytes to be written to the FIFO
*/
virtual void WriteFifo( void *buffer, uint8_t size ) ;
/*!
* @brief Reads the contents of the SX1276 FIFO
*
* @param [OUT] buffer Buffer where to copy the FIFO read data.
* @param [IN] size Number of bytes to be read from the FIFO
*/
virtual void ReadFifo( void *buffer, uint8_t size ) ;
/*!
* @brief Reset the SX1276
*/
virtual void Reset( void );
/*!
* \brief Sets the radio output power.
*
* @param [IN] power Sets the RF output power
*/
virtual void SetRfTxPower( int8_t power );
};
#endif // __SX1276_ARDUINO_HAL_H__
#endif // ARDUINO