Driver for Semtech SX1272 and SX1276 radios. More...

Detailed Description

Driver for Semtech SX1272 and SX1276 radios.

This module contains the driver for radio devices of the Semtech SX127x series (SX1272 and SX1276). Only LoRa long range modem is supported at the moment.

SX127x modules are designed to be used in the ISM radio frequency (RF) band. This RF band depends on different regional regulations worldwide. Be careful to configure the device to use a RF frequency allowed in your region. Here is the list of allowed frequencies for your region (see LoRaWAN regional parameters document available online):

Europe has 2 allowed bands (ETSI):
- EU863-870
- EU433 (from 433.175MHZ to 434.665MHZ exactly)
US is US902-928
China has 2 allowed bands:
- CN779-787 (from 779.5MHz to 786.5MHz exactly)
- CN470-510 (from 470.3MHz to 509.7MHz exactly)
Australia is AU915-928
South asia, AS923:
- Bruneï [923-925 MHz]
- Cambodia [923-925 MHz]
- Hong Kong [920-925 MHz]
- Indonesia [923-925 MHz]
- Japan [920-928 MHz]
- Laos [923-925 MHz]
- New Zealand [915-928 MHz]
- Singapore [920-925 MHz]
- Taiwan [922-928 MHz]
- Thailand [920-925 MHz]
- Vietnam [920-925 MHz]
South Korea: KR920-923 (from 920.9MHz to 923.3MHz exactly)

For more information on Semtech SX1272 and SX1276 modules see:

Modules
	Semtech SX1272 and SX1276 driver compile configuration

Files
file	sx127x.h
	Public interface for SX127X driver.

file	sx127x_internal.h
	Semtech SX127X internal functions.

file	sx127x_netdev.h
	Netdev driver definitions for SX127X driver.

file	sx127x_params.h
	Default configuration for SX127X driver.

file	sx127x_registers.h
	SX127X registers.

Data Structures
struct	sx127x_lora_settings_t
	LoRa configuration structure. More...

struct	sx127x_radio_settings_t
	Radio settings. More...

struct	sx127x_internal_t
	SX127X internal data. More...

struct	sx127x_params_t
	SX127X hardware and global parameters. More...

struct	sx127x_t
	SX127X device descriptor. More...

Typedefs
typedef uint8_t	sx127x_flags_t
	SX127X IRQ flags.

typedef void()	sx127x_dio_irq_handler_t(sx127x_t *dev)
	Hardware IO IRQ callback function definition.

Enumerations
enum	{ SX127X_INIT_OK = 0 , SX127X_ERR_SPI , SX127X_ERR_GPIOS , SX127X_ERR_NODEV }
	SX127X initialization result. More...

enum	{ SX127X_MODEM_FSK = 0 , SX127X_MODEM_LORA }
	Radio driver supported modems. More...

enum	{ SX127X_RF_IDLE = 0 , SX127X_RF_RX_RUNNING , SX127X_RF_TX_RUNNING , SX127X_RF_CAD }
	Radio driver internal state machine states definition. More...

enum	{ SX127X_RX_DONE = 0 , SX127X_TX_DONE , SX127X_RX_TIMEOUT , SX127X_TX_TIMEOUT , SX127X_RX_ERROR_CRC , SX127X_FHSS_CHANGE_CHANNEL , SX127X_CAD_DONE }
	Event types. More...

enum	{ SX127X_PA_RFO = 0 , SX127X_PA_BOOST }
	Power amplifier modes. More...

Functions
void	sx127x_setup (sx127x_t dev, const sx127x_params_t params, uint8_t index)
	Setup the SX127X.

int	sx127x_reset (const sx127x_t *dev)
	Resets the SX127X.

int	sx127x_init (sx127x_t *dev)
	Initializes the transceiver.

void	sx127x_init_radio_settings (sx127x_t *dev)
	Initialize radio settings with default values.

uint32_t	sx127x_random (sx127x_t *dev)
	Generates 32 bits random value based on the RSSI readings.

void	sx127x_start_cad (sx127x_t *dev)
	Start a channel activity detection.

bool	sx127x_is_channel_free (sx127x_t *dev, uint32_t freq, int16_t rssi_threshold)
	Checks that channel is free with specified RSSI threshold.

int16_t	sx127x_read_rssi (const sx127x_t *dev)
	Reads the current RSSI value.

uint8_t	sx127x_get_state (const sx127x_t *dev)
	Gets current state of transceiver.

void	sx127x_set_state (sx127x_t *dev, uint8_t state)
	Sets current state of transceiver.

void	sx127x_set_modem (sx127x_t *dev, uint8_t modem)
	Configures the radio with the given modem.

uint8_t	sx127x_get_syncword (const sx127x_t *dev)
	Gets the synchronization word.

void	sx127x_set_syncword (sx127x_t *dev, uint8_t syncword)
	Sets the synchronization word.

uint32_t	sx127x_get_channel (const sx127x_t *dev)
	Gets the channel RF frequency.

void	sx127x_set_channel (sx127x_t *dev, uint32_t freq)
	Sets the channel RF frequency.

uint32_t	sx127x_get_time_on_air (const sx127x_t *dev, uint8_t pkt_len)
	Computes the packet time on air in milliseconds.

void	sx127x_set_sleep (sx127x_t *dev)
	Sets the radio in sleep mode.

void	sx127x_set_standby (sx127x_t *dev)
	Sets the radio in stand-by mode.

void	sx127x_set_rx (sx127x_t *dev)
	Sets the radio in reception mode.

void	sx127x_set_tx (sx127x_t *dev)
	Sets the radio in transmission mode.

uint8_t	sx127x_get_max_payload_len (const sx127x_t *dev)
	Gets the maximum payload length.

void	sx127x_set_max_payload_len (const sx127x_t *dev, uint8_t maxlen)
	Sets the maximum payload length.

uint8_t	sx127x_get_op_mode (const sx127x_t *dev)
	Gets the SX127X operating mode.

void	sx127x_set_op_mode (const sx127x_t *dev, uint8_t op_mode)
	Sets the SX127X operating mode.

uint8_t	sx127x_get_bandwidth (const sx127x_t *dev)
	Gets the SX127X bandwidth.

void	sx127x_set_bandwidth (sx127x_t *dev, uint8_t bandwidth)
	Sets the SX127X bandwidth.

uint8_t	sx127x_get_spreading_factor (const sx127x_t *dev)
	Gets the SX127X LoRa spreading factor.

void	sx127x_set_spreading_factor (sx127x_t *dev, uint8_t sf)
	Sets the SX127X LoRa spreading factor.

uint8_t	sx127x_get_coding_rate (const sx127x_t *dev)
	Gets the SX127X LoRa coding rate.

void	sx127x_set_coding_rate (sx127x_t *dev, uint8_t coderate)
	Sets the SX127X LoRa coding rate.

bool	sx127x_get_rx_single (const sx127x_t *dev)
	Checks if the SX127X LoRa RX single mode is enabled/disabled.

void	sx127x_set_rx_single (sx127x_t *dev, bool single)
	Enable/disable the SX127X LoRa RX single mode.

bool	sx127x_get_crc (const sx127x_t *dev)
	Checks if the SX127X CRC verification mode is enabled.

void	sx127x_set_crc (sx127x_t *dev, bool crc)
	Enable/Disable the SX127X CRC verification mode.

uint8_t	sx127x_get_hop_period (const sx127x_t *dev)
	Gets the SX127X frequency hopping period.

void	sx127x_set_hop_period (sx127x_t *dev, uint8_t hop_period)
	Sets the SX127X frequency hopping period.

bool	sx127x_get_fixed_header_len_mode (const sx127x_t *dev)
	Gets the SX127X LoRa fixed header length mode.

void	sx127x_set_fixed_header_len_mode (sx127x_t *dev, bool mode)
	Sets the SX127X to fixed header length mode (explicit mode)

uint8_t	sx127x_get_payload_length (const sx127x_t *dev)
	Gets the SX127X payload length.

void	sx127x_set_payload_length (sx127x_t *dev, uint8_t len)
	Sets the SX127X payload length.

uint8_t	sx127x_get_tx_power (const sx127x_t *dev)
	Gets the SX127X TX radio power.

void	sx127x_set_tx_power (sx127x_t *dev, int8_t power)
	Sets the SX127X transmission power.

uint16_t	sx127x_get_preamble_length (const sx127x_t *dev)
	Gets the SX127X preamble length.

void	sx127x_set_preamble_length (sx127x_t *dev, uint16_t preamble)
	Sets the SX127X LoRa preamble length.

void	sx127x_set_symbol_timeout (sx127x_t *dev, uint16_t timeout)
	Sets the SX127X LoRa symbol timeout.

void	sx127x_set_rx_timeout (sx127x_t *dev, uint32_t timeout)
	Sets the SX127X RX timeout.

void	sx127x_set_tx_timeout (sx127x_t *dev, uint32_t timeout)
	Sets the SX127X TX timeout.

bool	sx127x_get_iq_invert (const sx127x_t *dev)
	Checks if the SX127X LoRa inverted IQ mode is enabled/disabled.

void	sx127x_set_iq_invert (sx127x_t *dev, bool iq_invert)
	Enable/disable the SX127X LoRa IQ inverted mode.

void	sx127x_set_freq_hop (sx127x_t *dev, bool freq_hop_on)
	Sets the SX127X LoRa frequency hopping mode.

SX127X device default configuration
#define	SX127X_MODEM_DEFAULT (SX127X_MODEM_LORA)
	Use LoRa as default modem.

#define	SX127X_CHANNEL_DEFAULT (868300000UL)
	Default channel frequency, 868.3MHz (Europe)

#define	SX127X_HF_CHANNEL_DEFAULT (868000000UL)
	Use to calibrate RX chain for LF and HF bands.

#define	SX127X_RF_MID_BAND_THRESH (525000000UL)
	Mid-band threshold.

#define	SX127X_XTAL_FREQ (32000000UL)
	Internal oscillator frequency, 32MHz.

#define	SX127X_RADIO_WAKEUP_TIME (1U)
	In milliseconds [ms].

#define	SX127X_TX_TIMEOUT_DEFAULT (30 * MS_PER_SEC)
	TX timeout, 30s.

#define	SX127X_RX_SINGLE (false)
	Single byte receive mode => continuous by default.

#define	SX127X_RX_BUFFER_SIZE (256)
	RX buffer size.

#define	SX127X_RADIO_TX_POWER (14U)
	Radio power in dBm.

#define	SX127X_EVENT_HANDLER_STACK_SIZE (2048U)
	Stack size event handler.

#define	SX127X_IRQ_DIO0 (1 << 0)
	DIO0 IRQ.

#define	SX127X_IRQ_DIO1 (1 << 1)
	DIO1 IRQ.

#define	SX127X_IRQ_DIO2 (1 << 2)
	DIO2 IRQ.

#define	SX127X_IRQ_DIO3 (1 << 3)
	DIO3 IRQ.

#define	SX127X_IRQ_DIO4 (1 << 4)
	DIO4 IRQ.

#define	SX127X_IRQ_DIO5 (1 << 5)
	DIO5 IRQ.

SX127X device descriptor boolean flags
#define	SX127X_LOW_DATARATE_OPTIMIZE_FLAG (1 << 0)

#define	SX127X_ENABLE_FIXED_HEADER_LENGTH_FLAG (1 << 1)

#define	SX127X_ENABLE_CRC_FLAG (1 << 2)

#define	SX127X_CHANNEL_HOPPING_FLAG (1 << 3)

#define	SX127X_IQ_INVERTED_FLAG (1 << 4)

#define	SX127X_RX_CONTINUOUS_FLAG (1 << 5)

Macro Definition Documentation

◆ SX127X_CHANNEL_DEFAULT

#define SX127X_CHANNEL_DEFAULT (868300000UL)

Default channel frequency, 868.3MHz (Europe)

Definition at line 77 of file sx127x.h.

◆ SX127X_CHANNEL_HOPPING_FLAG

#define SX127X_CHANNEL_HOPPING_FLAG (1 << 3)

Definition at line 170 of file sx127x.h.

◆ SX127X_ENABLE_CRC_FLAG

#define SX127X_ENABLE_CRC_FLAG (1 << 2)

Definition at line 169 of file sx127x.h.

◆ SX127X_ENABLE_FIXED_HEADER_LENGTH_FLAG

#define SX127X_ENABLE_FIXED_HEADER_LENGTH_FLAG (1 << 1)

Definition at line 168 of file sx127x.h.

◆ SX127X_EVENT_HANDLER_STACK_SIZE

#define SX127X_EVENT_HANDLER_STACK_SIZE (2048U)

Stack size event handler.

Definition at line 88 of file sx127x.h.

◆ SX127X_HF_CHANNEL_DEFAULT

#define SX127X_HF_CHANNEL_DEFAULT (868000000UL)

Use to calibrate RX chain for LF and HF bands.

Definition at line 78 of file sx127x.h.

◆ SX127X_IQ_INVERTED_FLAG

#define SX127X_IQ_INVERTED_FLAG (1 << 4)

Definition at line 171 of file sx127x.h.

◆ SX127X_IRQ_DIO0

#define SX127X_IRQ_DIO0 (1 << 0)

DIO0 IRQ.

Definition at line 89 of file sx127x.h.

◆ SX127X_IRQ_DIO1

#define SX127X_IRQ_DIO1 (1 << 1)

DIO1 IRQ.

Definition at line 90 of file sx127x.h.

◆ SX127X_IRQ_DIO2

#define SX127X_IRQ_DIO2 (1 << 2)

DIO2 IRQ.

Definition at line 91 of file sx127x.h.

◆ SX127X_IRQ_DIO3

#define SX127X_IRQ_DIO3 (1 << 3)

DIO3 IRQ.

Definition at line 92 of file sx127x.h.

◆ SX127X_IRQ_DIO4

#define SX127X_IRQ_DIO4 (1 << 4)

DIO4 IRQ.

Definition at line 93 of file sx127x.h.

◆ SX127X_IRQ_DIO5

#define SX127X_IRQ_DIO5 (1 << 5)

DIO5 IRQ.

Definition at line 94 of file sx127x.h.

◆ SX127X_LOW_DATARATE_OPTIMIZE_FLAG

#define SX127X_LOW_DATARATE_OPTIMIZE_FLAG (1 << 0)

Definition at line 167 of file sx127x.h.

◆ SX127X_MODEM_DEFAULT

#define SX127X_MODEM_DEFAULT (SX127X_MODEM_LORA)

Use LoRa as default modem.

Definition at line 76 of file sx127x.h.

◆ SX127X_RADIO_TX_POWER

#define SX127X_RADIO_TX_POWER (14U)

Radio power in dBm.

Definition at line 86 of file sx127x.h.

◆ SX127X_RADIO_WAKEUP_TIME

#define SX127X_RADIO_WAKEUP_TIME (1U)

In milliseconds [ms].

Definition at line 81 of file sx127x.h.

◆ SX127X_RF_MID_BAND_THRESH

#define SX127X_RF_MID_BAND_THRESH (525000000UL)

Mid-band threshold.

Definition at line 79 of file sx127x.h.

◆ SX127X_RX_BUFFER_SIZE

#define SX127X_RX_BUFFER_SIZE (256)

RX buffer size.

Definition at line 85 of file sx127x.h.

◆ SX127X_RX_CONTINUOUS_FLAG

#define SX127X_RX_CONTINUOUS_FLAG (1 << 5)

Definition at line 172 of file sx127x.h.

◆ SX127X_RX_SINGLE

#define SX127X_RX_SINGLE (false)

Single byte receive mode => continuous by default.

Definition at line 84 of file sx127x.h.

◆ SX127X_TX_TIMEOUT_DEFAULT

#define SX127X_TX_TIMEOUT_DEFAULT (30 * MS_PER_SEC)

TX timeout, 30s.

Definition at line 83 of file sx127x.h.

◆ SX127X_XTAL_FREQ

#define SX127X_XTAL_FREQ (32000000UL)

Internal oscillator frequency, 32MHz.

Definition at line 80 of file sx127x.h.

Typedef Documentation

◆ sx127x_dio_irq_handler_t

typedef void() sx127x_dio_irq_handler_t(sx127x_t *dev)

Hardware IO IRQ callback function definition.

Definition at line 251 of file sx127x.h.

◆ sx127x_flags_t

typedef uint8_t sx127x_flags_t

SX127X IRQ flags.

Definition at line 234 of file sx127x.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

SX127X initialization result.

Enumerator
SX127X_INIT_OK	Initialization was successful.
SX127X_ERR_SPI	Failed to initialize SPI bus or CS line.
SX127X_ERR_GPIOS	Failed to initialize GPIOs.
SX127X_ERR_NODEV	No valid device version found.

Definition at line 113 of file sx127x.h.

◆ anonymous enum

anonymous enum

Radio driver supported modems.

Enumerator
SX127X_MODEM_FSK	FSK modem driver.
SX127X_MODEM_LORA	LoRa modem driver.

Definition at line 123 of file sx127x.h.

◆ anonymous enum

anonymous enum

Radio driver internal state machine states definition.

Enumerator
SX127X_RF_IDLE	Idle state.
SX127X_RF_RX_RUNNING	Sending state.
SX127X_RF_TX_RUNNING	Receiving state.
SX127X_RF_CAD	Channel activity detection state.

Definition at line 131 of file sx127x.h.

◆ anonymous enum

anonymous enum

Event types.

Enumerator
SX127X_RX_DONE	Receiving complete.
SX127X_TX_DONE	Sending complete.
SX127X_RX_TIMEOUT	Receiving timeout.
SX127X_TX_TIMEOUT	Sending timeout.
SX127X_RX_ERROR_CRC	Receiving CRC error.
SX127X_FHSS_CHANGE_CHANNEL	Channel change.
SX127X_CAD_DONE	Channel activity detection complete.

Definition at line 141 of file sx127x.h.

◆ anonymous enum

anonymous enum

Power amplifier modes.

Default value is SX127X_PA_RFO.

The power amplifier mode depends on the module hardware configuration.

Enumerator
SX127X_PA_RFO	RFO HF or RFO LF.
SX127X_PA_BOOST	Power amplifier boost (high power)

Definition at line 158 of file sx127x.h.

Function Documentation

◆ sx127x_get_bandwidth()

uint8_t sx127x_get_bandwidth ( const sx127x_t * dev )

Gets the SX127X bandwidth.

Parameters

[in] dev The sx127x device descriptor

Returns: the bandwidth

◆ sx127x_get_channel()

uint32_t sx127x_get_channel ( const sx127x_t * dev )

Gets the channel RF frequency.

Parameters

[in] dev The sx127x device descriptor

Returns: The channel frequency

◆ sx127x_get_coding_rate()

uint8_t sx127x_get_coding_rate ( const sx127x_t * dev )

Gets the SX127X LoRa coding rate.

Parameters

[in] dev The sx127x device descriptor

Returns: the current LoRa coding rate

◆ sx127x_get_crc()

bool sx127x_get_crc ( const sx127x_t * dev )

Checks if the SX127X CRC verification mode is enabled.

Parameters

[in] dev The sx127x device descriptor

Returns: the LoRa single mode

◆ sx127x_get_fixed_header_len_mode()

bool sx127x_get_fixed_header_len_mode ( const sx127x_t * dev )

Gets the SX127X LoRa fixed header length mode.

Parameters

[in] dev The sx127x device descriptor

Returns: the LoRa implicit mode

◆ sx127x_get_hop_period()

uint8_t sx127x_get_hop_period ( const sx127x_t * dev )

Gets the SX127X frequency hopping period.

Parameters

[in] dev The sx127x device descriptor

Returns: the frequency hopping period

◆ sx127x_get_iq_invert()

bool sx127x_get_iq_invert ( const sx127x_t * dev )

Checks if the SX127X LoRa inverted IQ mode is enabled/disabled.

Parameters

[in] dev The sx127x device descriptor

Returns: the LoRa IQ inverted mode

◆ sx127x_get_max_payload_len()

uint8_t sx127x_get_max_payload_len ( const sx127x_t * dev )

Gets the maximum payload length.

Parameters

[in] dev The sx127x device descriptor

Returns: The maximum payload length

◆ sx127x_get_op_mode()

uint8_t sx127x_get_op_mode ( const sx127x_t * dev )

Gets the SX127X operating mode.

Parameters

[in] dev The sx127x device descriptor

Returns: The actual operating mode

◆ sx127x_get_payload_length()

uint8_t sx127x_get_payload_length ( const sx127x_t * dev )

Gets the SX127X payload length.

Parameters

[in] dev The sx127x device descriptor

Returns: the payload length

◆ sx127x_get_preamble_length()

uint16_t sx127x_get_preamble_length ( const sx127x_t * dev )

Gets the SX127X preamble length.

Parameters

[in] dev The sx127x device descriptor

Returns: the preamble length

◆ sx127x_get_rx_single()

bool sx127x_get_rx_single ( const sx127x_t * dev )

Checks if the SX127X LoRa RX single mode is enabled/disabled.

Parameters

[in] dev The sx127x device descriptor

Returns: the LoRa single mode

◆ sx127x_get_spreading_factor()

uint8_t sx127x_get_spreading_factor ( const sx127x_t * dev )

Gets the SX127X LoRa spreading factor.

Parameters

[in] dev The sx127x device descriptor

Returns: the spreading factor

◆ sx127x_get_state()

uint8_t sx127x_get_state ( const sx127x_t * dev )

Gets current state of transceiver.

Parameters

[in] dev The sx127x device descriptor

Returns: radio state [RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]

◆ sx127x_get_syncword()

uint8_t sx127x_get_syncword ( const sx127x_t * dev )

Gets the synchronization word.

Parameters

[in] dev The sx127x device descriptor

Returns: The synchronization word

◆ sx127x_get_time_on_air()

uint32_t sx127x_get_time_on_air	(	const sx127x_t *	dev,
		uint8_t	pkt_len
	)

Computes the packet time on air in milliseconds.

Precondition: Can only be called if sx127x_init_radio_settings has already been called.

Parameters

[in]	dev	The sx127x device descriptor
[in]	pkt_len	The received packet payload length

Returns: computed air time (ms) for the given packet payload length

◆ sx127x_get_tx_power()

uint8_t sx127x_get_tx_power ( const sx127x_t * dev )

Gets the SX127X TX radio power.

Parameters

[in] dev The sx127x device descriptor

Returns: the radio power

◆ sx127x_init()

int sx127x_init ( sx127x_t * dev )

Initializes the transceiver.

Parameters

[in] dev The sx127x device descriptor

Returns: result of initialization

◆ sx127x_init_radio_settings()

void sx127x_init_radio_settings ( sx127x_t * dev )

Initialize radio settings with default values.

Parameters

[in] dev The sx127x device pointer

◆ sx127x_is_channel_free()

bool sx127x_is_channel_free	(	sx127x_t *	dev,
		uint32_t	freq,
		int16_t	rssi_threshold
	)

Checks that channel is free with specified RSSI threshold.

Parameters

[in]	dev	The sx127x device structure pointer
[in]	freq	channel RF frequency
[in]	rssi_threshold	RSSI threshold

Returns: true if channel is free, false otherwise

◆ sx127x_random()

uint32_t sx127x_random ( sx127x_t * dev )

Generates 32 bits random value based on the RSSI readings.

Attention: This function sets the radio in LoRa mode and disables all interrupts from it. After calling this function either sx127x_set_rx_config or sx127x_set_tx_config functions must be called.

Parameters

[in] dev The sx127x device structure pointer

Returns: random 32 bits value

◆ sx127x_read_rssi()

int16_t sx127x_read_rssi ( const sx127x_t * dev )

Reads the current RSSI value.

Parameters

[in] dev The sx127x device structure pointer

Returns: the current value of RSSI (in dBm)

◆ sx127x_reset()

int sx127x_reset ( const sx127x_t * dev )

Resets the SX127X.

Parameters

[in] dev The sx127x device descriptor

◆ sx127x_set_bandwidth()

void sx127x_set_bandwidth	(	sx127x_t *	dev,
		uint8_t	bandwidth
	)

Sets the SX127X bandwidth.

Parameters

[in]	dev	The sx127x device descriptor
[in]	bandwidth	The new bandwidth

◆ sx127x_set_channel()

void sx127x_set_channel	(	sx127x_t *	dev,
		uint32_t	freq
	)

Sets the channel RF frequency.

Parameters

[in]	dev	The sx127x device descriptor
[in]	freq	Channel RF frequency

◆ sx127x_set_coding_rate()

void sx127x_set_coding_rate	(	sx127x_t *	dev,
		uint8_t	coderate
	)

Sets the SX127X LoRa coding rate.

Parameters

[in]	dev	The sx127x device descriptor
[in]	coderate	The LoRa coding rate

◆ sx127x_set_crc()

void sx127x_set_crc	(	sx127x_t *	dev,
		bool	crc
	)

Enable/Disable the SX127X CRC verification mode.

Parameters

[in]	dev	The sx127x device descriptor
[in]	crc	The CRC check mode

◆ sx127x_set_fixed_header_len_mode()

void sx127x_set_fixed_header_len_mode	(	sx127x_t *	dev,
		bool	mode
	)

Sets the SX127X to fixed header length mode (explicit mode)

Parameters

[in]	dev	The sx127x device descriptor
[in]	mode	The header mode

◆ sx127x_set_freq_hop()

void sx127x_set_freq_hop	(	sx127x_t *	dev,
		bool	freq_hop_on
	)

Sets the SX127X LoRa frequency hopping mode.

Parameters

[in]	dev	The sx127x device descriptor
[in]	freq_hop_on	The LoRa frequency hopping mode

◆ sx127x_set_hop_period()

void sx127x_set_hop_period	(	sx127x_t *	dev,
		uint8_t	hop_period
	)

Sets the SX127X frequency hopping period.

Parameters

[in]	dev	The sx127x device descriptor
[in]	hop_period	The frequency hopping period

◆ sx127x_set_iq_invert()

void sx127x_set_iq_invert	(	sx127x_t *	dev,
		bool	iq_invert
	)

Enable/disable the SX127X LoRa IQ inverted mode.

Parameters

[in]	dev	The sx127x device descriptor
[in]	iq_invert	The LoRa IQ inverted mode

◆ sx127x_set_max_payload_len()

void sx127x_set_max_payload_len	(	const sx127x_t *	dev,
		uint8_t	maxlen
	)

Sets the maximum payload length.

Parameters

[in]	dev	The sx127x device descriptor
[in]	maxlen	Maximum payload length in bytes

◆ sx127x_set_modem()

void sx127x_set_modem	(	sx127x_t *	dev,
		uint8_t	modem
	)

Configures the radio with the given modem.

Parameters

[in]	dev	The sx127x device descriptor
[in]	modem	Modem to be used [0: FSK, 1: LoRa]

◆ sx127x_set_op_mode()

void sx127x_set_op_mode	(	const sx127x_t *	dev,
		uint8_t	op_mode
	)

Sets the SX127X operating mode.

Parameters

[in]	dev	The sx127x device descriptor
[in]	op_mode	The new operating mode

◆ sx127x_set_payload_length()

void sx127x_set_payload_length	(	sx127x_t *	dev,
		uint8_t	len
	)

Sets the SX127X payload length.

Parameters

[in]	dev	The sx127x device descriptor
[in]	len	The payload len

◆ sx127x_set_preamble_length()

void sx127x_set_preamble_length	(	sx127x_t *	dev,
		uint16_t	preamble
	)

Sets the SX127X LoRa preamble length.

Parameters

[in]	dev	The sx127x device descriptor
[in]	preamble	The LoRa preamble length

◆ sx127x_set_rx()

void sx127x_set_rx ( sx127x_t * dev )

Sets the radio in reception mode.

Parameters

[in] dev The sx127x device descriptor

◆ sx127x_set_rx_single()

void sx127x_set_rx_single	(	sx127x_t *	dev,
		bool	single
	)

Enable/disable the SX127X LoRa RX single mode.

Parameters

[in]	dev	The sx127x device descriptor
[in]	single	The LoRa RX single mode

◆ sx127x_set_rx_timeout()

void sx127x_set_rx_timeout	(	sx127x_t *	dev,
		uint32_t	timeout
	)

Sets the SX127X RX timeout.

Parameters

[in]	dev	The sx127x device descriptor
[in]	timeout	The RX timeout

◆ sx127x_set_sleep()

void sx127x_set_sleep ( sx127x_t * dev )

Sets the radio in sleep mode.

Parameters

[in] dev The sx127x device descriptor

◆ sx127x_set_spreading_factor()

void sx127x_set_spreading_factor	(	sx127x_t *	dev,
		uint8_t	sf
	)

Sets the SX127X LoRa spreading factor.

Parameters

[in]	dev	The sx127x device descriptor
[in]	sf	The spreading factor

◆ sx127x_set_standby()

void sx127x_set_standby ( sx127x_t * dev )

Sets the radio in stand-by mode.

Parameters

[in] dev The sx127x device descriptor

◆ sx127x_set_state()

void sx127x_set_state	(	sx127x_t *	dev,
		uint8_t	state
	)

Sets current state of transceiver.

Parameters

[in]	dev	The sx127x device descriptor
[in]	state	The new radio state

Returns: radio state [RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]

◆ sx127x_set_symbol_timeout()

void sx127x_set_symbol_timeout	(	sx127x_t *	dev,
		uint16_t	timeout
	)

Sets the SX127X LoRa symbol timeout.

Parameters

[in]	dev	The sx127x device descriptor
[in]	timeout	The LoRa symbol timeout

◆ sx127x_set_syncword()

void sx127x_set_syncword	(	sx127x_t *	dev,
		uint8_t	syncword
	)

Sets the synchronization word.

Parameters

[in]	dev	The sx127x device descriptor
[in]	syncword	The synchronization word

◆ sx127x_set_tx()

void sx127x_set_tx ( sx127x_t * dev )

Sets the radio in transmission mode.

Parameters

[in] dev The sx127x device descriptor

◆ sx127x_set_tx_power()

void sx127x_set_tx_power	(	sx127x_t *	dev,
		int8_t	power
	)

Sets the SX127X transmission power.

Parameters

[in]	dev	The sx127x device descriptor
[in]	power	The TX power

◆ sx127x_set_tx_timeout()

void sx127x_set_tx_timeout	(	sx127x_t *	dev,
		uint32_t	timeout
	)

Sets the SX127X TX timeout.

Parameters

[in]	dev	The sx127x device descriptor
[in]	timeout	The TX timeout

◆ sx127x_setup()

void sx127x_setup	(	sx127x_t *	dev,
		const sx127x_params_t *	params,
		uint8_t	index
	)

Setup the SX127X.

Parameters

[in]	dev	Device descriptor
[in]	params	Parameters for device initialization
[in]	index	Index of `params` in a global parameter struct array. If initialized manually, pass a unique identifier instead.

◆ sx127x_start_cad()

void sx127x_start_cad ( sx127x_t * dev )

Start a channel activity detection.

Parameters

[in] dev The sx127x device descriptor

Detailed Description

Modules

Files

Data Structures

Typedefs

Enumerations

Functions

SX127X device default configuration

SX127X device descriptor boolean flags

Macro Definition Documentation

◆ SX127X_CHANNEL_DEFAULT

◆ SX127X_CHANNEL_HOPPING_FLAG

◆ SX127X_ENABLE_CRC_FLAG

◆ SX127X_ENABLE_FIXED_HEADER_LENGTH_FLAG

◆ SX127X_EVENT_HANDLER_STACK_SIZE

◆ SX127X_HF_CHANNEL_DEFAULT

◆ SX127X_IQ_INVERTED_FLAG

◆ SX127X_IRQ_DIO0

◆ SX127X_IRQ_DIO1

◆ SX127X_IRQ_DIO2

◆ SX127X_IRQ_DIO3

◆ SX127X_IRQ_DIO4

◆ SX127X_IRQ_DIO5

◆ SX127X_LOW_DATARATE_OPTIMIZE_FLAG

◆ SX127X_MODEM_DEFAULT

◆ SX127X_RADIO_TX_POWER

◆ SX127X_RADIO_WAKEUP_TIME

◆ SX127X_RF_MID_BAND_THRESH

◆ SX127X_RX_BUFFER_SIZE

◆ SX127X_RX_CONTINUOUS_FLAG

◆ SX127X_RX_SINGLE

◆ SX127X_TX_TIMEOUT_DEFAULT

◆ SX127X_XTAL_FREQ

Typedef Documentation

◆ sx127x_dio_irq_handler_t

◆ sx127x_flags_t

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

Function Documentation

◆ sx127x_get_bandwidth()

◆ sx127x_get_channel()

◆ sx127x_get_coding_rate()

◆ sx127x_get_crc()

◆ sx127x_get_fixed_header_len_mode()

◆ sx127x_get_hop_period()

◆ sx127x_get_iq_invert()

◆ sx127x_get_max_payload_len()

◆ sx127x_get_op_mode()

◆ sx127x_get_payload_length()

◆ sx127x_get_preamble_length()

◆ sx127x_get_rx_single()

◆ sx127x_get_spreading_factor()

◆ sx127x_get_state()

◆ sx127x_get_syncword()

◆ sx127x_get_time_on_air()

◆ sx127x_get_tx_power()

◆ sx127x_init()

◆ sx127x_init_radio_settings()

◆ sx127x_is_channel_free()

◆ sx127x_random()

◆ sx127x_read_rssi()

◆ sx127x_reset()

◆ sx127x_set_bandwidth()

◆ sx127x_set_channel()

◆ sx127x_set_coding_rate()

◆ sx127x_set_crc()

◆ sx127x_set_fixed_header_len_mode()

◆ sx127x_set_freq_hop()

◆ sx127x_set_hop_period()

◆ sx127x_set_iq_invert()

◆ sx127x_set_max_payload_len()

◆ sx127x_set_modem()

◆ sx127x_set_op_mode()

◆ sx127x_set_payload_length()

◆ sx127x_set_preamble_length()

◆ sx127x_set_rx()