Radio Class Reference

Constructor of the radio object, the parameters are the callback functions described in the header.

Parameters:

[IN]	events Structure containing the driver callback functions

Definition at line 17 of file radio.cpp.

Checks if the given RF frequency is supported by the hardware.

Parameters:

[IN]	frequency RF frequency to be checked

Return values:

isSupported

[true: supported, false: unsupported]

Implemented in SX1272MB2xAS, and SX1272.

Reads the current RSSI value.

Return values:

rssiValue

Current RSSI value in [dBm]

Implemented in SX1272.

Return current radio status.

Parameters:

status

Radio status.[RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]

Implemented in SX1272.

Initializes the radio.

Parameters:

[IN]	events Structure containing the driver callback functions

Implemented in SX1272.

Sets the channels configuration.

Parameters:

[IN]	modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]	freq Channel RF frequency
[IN]	rssiThresh RSSI threshold

Return values:

isFree

[true: Channel is free, false: Channel is not free]

Implemented in SX1272.

Generates a 32 bits random value based on the RSSI readings.

Remarks:

This function sets the radio in LoRa modem mode and disables all interrupts. After calling this function either Radio.SetRxConfig or Radio.SetTxConfig functions must be called.

Return values:

randomValue

32 bits random value

Implemented in SX1272.

Reads the radio register at the specified address.

Parameters:

[IN],:

addr Register address

Return values:

data	Register value

Implemented in SX1272MB2xAS, and SX1272.

Reads multiple radio registers starting at address.

Parameters:

[IN]	addr First Radio register address
[OUT]	buffer Buffer where to copy the registers data
[IN]	size Number of registers to be read

Implemented in SX1272MB2xAS, and SX1272.

Reads the contents of the Radio FIFO.

Parameters:

[OUT]	buffer Buffer where to copy the FIFO read data.
[IN]	size Number of bytes to be read from the FIFO

Implemented in SX1272MB2xAS, and SX1272.

Sets the radio in reception mode for the given time.

Parameters:

[IN]	timeout Reception timeout [us] [0: continuous, others timeout]

Implemented in SX1272.

Sends the buffer of size. Prepares the packet to be sent and sets the radio in transmission.

Parameters:

[IN],:	buffer Buffer pointer
[IN],:	size Buffer size

Implemented in SX1272.

Sets the channel frequency.

Parameters:

[IN]	freq Channel RF frequency

Implemented in SX1272.

Sets the maximum payload length.

Parameters:

[IN]	modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]	max Maximum payload length in bytes

Implemented in SX1272.

Configures the radio with the given modem.

Parameters:

[IN]	modem Modem to be used [0: FSK, 1: LoRa]

Implemented in SX1272.

Sets the network to public or private. Updates the sync byte.

Remarks:

Applies to LoRa modem only

Parameters:

[IN]	enable if true, it enables a public network

Implemented in SX1272.

Sets the reception parameters.

Parameters:

[IN]	modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]	bandwidth Sets the bandwidth FSK : >= 2600 and <= 250000 Hz LoRa: [0: 125 kHz, 1: 250 kHz, 2: 500 kHz, 3: Reserved]
[IN]	datarate Sets the Datarate FSK : 600..300000 bits/s LoRa: [6: 64, 7: 128, 8: 256, 9: 512, 10: 1024, 11: 2048, 12: 4096 chips]
[IN]	coderate Sets the coding rate ( LoRa only ) FSK : N/A ( set to 0 ) LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
[IN]	bandwidthAfc Sets the AFC Bandwidth ( FSK only ) FSK : >= 2600 and <= 250000 Hz LoRa: N/A ( set to 0 )
[IN]	preambleLen Sets the Preamble length ( LoRa only ) FSK : N/A ( set to 0 ) LoRa: Length in symbols ( the hardware adds 4 more symbols )
[IN]	symbTimeout Sets the RxSingle timeout value FSK : timeout number of bytes LoRa: timeout in symbols
[IN]	fixLen Fixed length packets [0: variable, 1: fixed]
[IN]	payloadLen Sets payload length when fixed lenght is used
[IN]	crcOn Enables/Disables the CRC [0: OFF, 1: ON]
[IN]	freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
[IN]	hopPeriod Number of symbols bewteen each hop (LoRa only)
[IN]	iqInverted Inverts IQ signals ( LoRa only ) FSK : N/A ( set to 0 ) LoRa: [0: not inverted, 1: inverted]
[IN]	rxContinuous Sets the reception in continuous mode [false: single mode, true: continuous mode]

Implemented in SX1272.

Sets the transmission parameters.

Parameters:

[IN]	modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]	power Sets the output power [dBm]
[IN]	fdev Sets the frequency deviation ( FSK only ) FSK : [Hz] LoRa: 0
[IN]	bandwidth Sets the bandwidth ( LoRa only ) FSK : 0 LoRa: [0: 125 kHz, 1: 250 kHz, 2: 500 kHz, 3: Reserved]
[IN]	datarate Sets the Datarate FSK : 600..300000 bits/s LoRa: [6: 64, 7: 128, 8: 256, 9: 512, 10: 1024, 11: 2048, 12: 4096 chips]
[IN]	coderate Sets the coding rate ( LoRa only ) FSK : N/A ( set to 0 ) LoRa: [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
[IN]	preambleLen Sets the preamble length
[IN]	fixLen Fixed length packets [0: variable, 1: fixed]
[IN]	crcOn Enables disables the CRC [0: OFF, 1: ON]
[IN]	freqHopOn Enables disables the intra-packet frequency hopping [0: OFF, 1: ON] (LoRa only)
[IN]	hopPeriod Number of symbols bewteen each hop (LoRa only)
[IN]	iqInverted Inverts IQ signals ( LoRa only ) FSK : N/A ( set to 0 ) LoRa: [0: not inverted, 1: inverted]
[IN]	timeout Transmission timeout [us]

Implemented in SX1272.

Sets the radio in continuous wave transmission mode.

Parameters:

[IN],:	freq Channel RF frequency
[IN],:	power Sets the output power [dBm]
[IN],:	time Transmission mode timeout [s]

Implemented in SX1272.

Sets the radio in sleep mode.

Implemented in SX1272.

Sets the radio in standby mode.

Implemented in SX1272.

Sets the radio in CAD mode.

Implemented in SX1272.

Computes the packet time on air for the given payload.

Can only be called once SetRxConfig or SetTxConfig have been called

Parameters:

[IN]	modem Radio modem to be used [0: FSK, 1: LoRa]
[IN]	pktLen Packet payload length

Return values:

airTime

Computed airTime for the given packet payload length

Implemented in SX1272.

Sets the radio in transmission mode for the given time.

Parameters:

[IN]	timeout Transmission timeout [us] [0: continuous, others timeout]

Implemented in SX1272.

Writes the radio register at the specified address.

Parameters:

[IN],:	addr Register address
[IN],:	data New register value

Implemented in SX1272MB2xAS, and SX1272.

Writes multiple radio registers starting at address.

Parameters:

[IN]	addr First Radio register address
[IN]	buffer Buffer containing the new register's values
[IN]	size Number of registers to be written

Implemented in SX1272MB2xAS, and SX1272.

Writes the buffer contents to the Radio FIFO.

Parameters:

[IN]	buffer Buffer containing data to be put on the FIFO.
[IN]	size Number of bytes to be written to the FIFO

Implemented in SX1272MB2xAS, and SX1272.