Implementation according to LoRaWAN Specification v1.0.2. More...

Macros
#define	RU864_MAX_NB_CHANNELS 16

#define	RU864_NUMB_DEFAULT_CHANNELS 8

#define	RU864_NUMB_CHANNELS_CF_LIST 5

#define	RU864_TX_MIN_DATARATE DR_0

#define	RU864_TX_MAX_DATARATE DR_7

#define	RU864_RX_MIN_DATARATE DR_0

#define	RU864_RX_MAX_DATARATE DR_7

#define	RU864_DEFAULT_DATARATE DR_2

#define	RU864_MIN_RX1_DR_OFFSET 0

#define	RU864_MAX_RX1_DR_OFFSET 7

#define	RU864_DEFAULT_RX1_DR_OFFSET 0

#define	RU864_MIN_TX_POWER TX_POWER_7

#define	RU864_MAX_TX_POWER TX_POWER_0

#define	RU864_DEFAULT_TX_POWER TX_POWER_0

#define	RU864_DEFAULT_MAX_EIRP 16.0f

#define	RU864_DEFAULT_ANTENNA_GAIN 2.15f

#define	RU864_ADR_ACK_LIMIT 64

#define	RU864_ADR_ACK_DELAY 32

#define	RU864_DUTY_CYCLE_ENABLED 0

#define	RU864_MAX_RX_WINDOW 3000

#define	RU864_RECEIVE_DELAY1 1000

#define	RU864_RECEIVE_DELAY2 2000

#define	RU864_JOIN_ACCEPT_DELAY1 5000

#define	RU864_JOIN_ACCEPT_DELAY2 6000

#define	RU864_MAX_FCNT_GAP 16384

#define	RU864_ACKTIMEOUT 2000

#define	RU864_ACK_TIMEOUT_RND 1000

#define	RU864_RX_WND_2_DR DR_2

#define	RU864_MAX_NB_BANDS 1

#define	RU864_BAND0

#define	RU864_LC1

#define	RU864_LC2

#define	RU864_LC3

#define	RU864_LC4

#define	RU864_LC5

#define	RU864_LC6

#define	RU864_LC7

#define	RU864_LC8

#define	RU864_JOIN_CHANNELS (uint16_t)(LC(1) \| LC(2))

Functions
PhyParam_t	RegionRU864GetPhyParam (GetPhyParams_t *getPhy)
	The function gets a value of a specific phy attribute. More...

void	RegionRU864SetBandTxDone (SetBandTxDoneParams_t *txDone)
	Updates the last TX done parameters of the current channel. More...

void	RegionRU864InitDefaults (InitType_t type)
	Initializes the channels masks and the channels. More...

bool	RegionRU864Verify (VerifyParams_t *verify, PhyAttribute_t phyAttribute)
	Verifies a parameter. More...

void	RegionRU864ApplyCFList (ApplyCFListParams_t *applyCFList)
	The function parses the input buffer and sets up the channels of the CF list. More...

bool	RegionRU864ChanMaskSet (ChanMaskSetParams_t *chanMaskSet)
	Sets a channels mask. More...

bool	RegionRU864AdrNext (AdrNextParams_t adrNext, int8_t drOut, int8_t txPowOut, uint32_t adrAckCounter)
	Calculates the next datarate to set, when ADR is on or off. More...

void	RegionRU864ComputeRxWindowParameters (int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)

bool	RegionRU864RxConfig (RxConfigParams_t rxConfig, int8_t datarate)
	Configuration of the RX windows. More...

bool	RegionRU864TxConfig (TxConfigParams_t txConfig, int8_t txPower, TimerTime_t *txTimeOnAir)
	TX configuration. More...

uint8_t	RegionRU864LinkAdrReq (LinkAdrReqParams_t linkAdrReq, int8_t drOut, int8_t txPowOut, uint8_t nbRepOut, uint8_t *nbBytesParsed)
	The function processes a Link ADR Request. More...

uint8_t	RegionRU864RxParamSetupReq (RxParamSetupReqParams_t *rxParamSetupReq)
	The function processes a RX Parameter Setup Request. More...

uint8_t	RegionRU864NewChannelReq (NewChannelReqParams_t *newChannelReq)
	The function processes a Channel Request. More...

int8_t	RegionRU864TxParamSetupReq (TxParamSetupReqParams_t *txParamSetupReq)
	The function processes a TX ParamSetup Request. More...

uint8_t	RegionRU864DlChannelReq (DlChannelReqParams_t *dlChannelReq)
	The function processes a DlChannel Request. More...

int8_t	RegionRU864AlternateDr (AlternateDrParams_t *alternateDr)
	Alternates the datarate of the channel for the join request. More...

void	RegionRU864CalcBackOff (CalcBackOffParams_t *calcBackOff)
	Calculates the back-off time. More...

bool	RegionRU864NextChannel (NextChanParams_t nextChanParams, uint8_t channel, TimerTime_t time, TimerTime_t aggregatedTimeOff)
	Searches and set the next random available channel. More...

LoRaMacStatus_t	RegionRU864ChannelAdd (ChannelAddParams_t *channelAdd)
	Adds a channel. More...

bool	RegionRU864ChannelsRemove (ChannelRemoveParams_t *channelRemove)
	Removes a channel. More...

void	RegionRU864SetContinuousWave (ContinuousWaveParams_t *continuousWave)
	Sets the radio into continuous wave mode. More...

uint8_t	RegionRU864ApplyDrOffset (uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
	Computes new datarate according to the given offset. More...

bool	RegionRU864SetVersion (uint8_t version)
	Adjust frequency band to RU864-1, RU864-2, RU864-3. More...

Variables
static const uint8_t	DataratesRU864 [] = {12, 11, 10, 9, 8, 7, 7, 50}

static const uint32_t	BandwidthsRU864 [] = {125000, 125000, 125000, 125000, 125000, 125000, 250000, 0}

static const uint8_t	MaxPayloadOfDatarateRU864 [] = {59, 59, 59, 123, 230, 230, 230, 230}

static const uint8_t	MaxPayloadOfDatarateRepeaterRU864 [] = {59, 59, 59, 123, 250, 250, 250, 250}

static const int8_t	EffectiveRx1DrOffsetRU864 [] = {0, 1, 2, 3, 4, 5, -1, -2}

Detailed Description

Implementation according to LoRaWAN Specification v1.0.2.

Macro Definition Documentation

◆ RU864_MAX_NB_CHANNELS

#define RU864_MAX_NB_CHANNELS 16

LoRaMac maximum number of channels

◆ RU864_NUMB_DEFAULT_CHANNELS

#define RU864_NUMB_DEFAULT_CHANNELS 8

Number of default channels

◆ RU864_NUMB_CHANNELS_CF_LIST

#define RU864_NUMB_CHANNELS_CF_LIST 5

Number of channels to apply for the CF list

Todo:: should be 6

◆ RU864_TX_MIN_DATARATE

#define RU864_TX_MIN_DATARATE DR_0

Minimal datarate that can be used by the node

◆ RU864_TX_MAX_DATARATE

#define RU864_TX_MAX_DATARATE DR_7

Maximal datarate that can be used by the node

◆ RU864_RX_MIN_DATARATE

#define RU864_RX_MIN_DATARATE DR_0

Minimal datarate that can be used by the node

◆ RU864_RX_MAX_DATARATE

#define RU864_RX_MAX_DATARATE DR_7

Maximal datarate that can be used by the node

◆ RU864_DEFAULT_DATARATE

#define RU864_DEFAULT_DATARATE DR_2

Default datarate used by the node

◆ RU864_MIN_RX1_DR_OFFSET

#define RU864_MIN_RX1_DR_OFFSET 0

Minimal Rx1 receive datarate offset

◆ RU864_MAX_RX1_DR_OFFSET

#define RU864_MAX_RX1_DR_OFFSET 7

Maximal Rx1 receive datarate offset

◆ RU864_DEFAULT_RX1_DR_OFFSET

#define RU864_DEFAULT_RX1_DR_OFFSET 0

Default Rx1 receive datarate offset

◆ RU864_MIN_TX_POWER

#define RU864_MIN_TX_POWER TX_POWER_7

Minimal Tx output power that can be used by the node

◆ RU864_MAX_TX_POWER

#define RU864_MAX_TX_POWER TX_POWER_0

Maximal Tx output power that can be used by the node

◆ RU864_DEFAULT_TX_POWER

#define RU864_DEFAULT_TX_POWER TX_POWER_0

Default Tx output power used by the node

◆ RU864_DEFAULT_MAX_EIRP

#define RU864_DEFAULT_MAX_EIRP 16.0f

Default Max EIRP

◆ RU864_DEFAULT_ANTENNA_GAIN

#define RU864_DEFAULT_ANTENNA_GAIN 2.15f

Default antenna gain

◆ RU864_ADR_ACK_LIMIT

#define RU864_ADR_ACK_LIMIT 64

ADR Ack limit

◆ RU864_ADR_ACK_DELAY

#define RU864_ADR_ACK_DELAY 32

ADR Ack delay

◆ RU864_DUTY_CYCLE_ENABLED

#define RU864_DUTY_CYCLE_ENABLED 0

Enabled or disabled the duty cycle

◆ RU864_MAX_RX_WINDOW

#define RU864_MAX_RX_WINDOW 3000

Maximum RX window duration

◆ RU864_RECEIVE_DELAY1

#define RU864_RECEIVE_DELAY1 1000

Receive delay 1

◆ RU864_RECEIVE_DELAY2

#define RU864_RECEIVE_DELAY2 2000

Receive delay 2

◆ RU864_JOIN_ACCEPT_DELAY1

#define RU864_JOIN_ACCEPT_DELAY1 5000

Join accept delay 1

◆ RU864_JOIN_ACCEPT_DELAY2

#define RU864_JOIN_ACCEPT_DELAY2 6000

Join accept delay 2

◆ RU864_MAX_FCNT_GAP

#define RU864_MAX_FCNT_GAP 16384

Maximum frame counter gap

◆ RU864_ACKTIMEOUT

#define RU864_ACKTIMEOUT 2000

Ack timeout

◆ RU864_ACK_TIMEOUT_RND

#define RU864_ACK_TIMEOUT_RND 1000

Random ack timeout limits

◆ RU864_RX_WND_2_DR

#define RU864_RX_WND_2_DR DR_2

Second reception window channel datarate definition.

◆ RU864_MAX_NB_BANDS

#define RU864_MAX_NB_BANDS 1

Maximum number of bands

◆ RU864_BAND0

#define RU864_BAND0

Value:

    {                                    \
        100, RU864_MAX_TX_POWER, 0, 0, 0 \
    }

Band 0 definition { DutyCycle, TxMaxPower, LastTxDoneTime, TimeOff }

◆ RU864_LC1

#define RU864_LC1

Value:

    {                                           \
        868900000, 0, {((DR_5 << 4) | DR_0)}, 0 \
    }

LoRaMac default channel 1 Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }

◆ RU864_LC2

#define RU864_LC2

Value:

    {                                           \
        869100000, 0, {((DR_5 << 4) | DR_0)}, 0 \
    }

LoRaMac default channel 2 Channel = { Frequency [Hz], RX1 Frequency [Hz], { ( ( DrMax << 4 ) | DrMin ) }, Band }

◆ RU864_LC3

#define RU864_LC3

Value:

    {                                           \
        869300000, 0, {((DR_5 << 4) | DR_0)}, 0 \
    }

◆ RU864_LC4

#define RU864_LC4

Value:

    {                                           \
        869500000, 0, {((DR_5 << 4) | DR_0)}, 0 \
    }

◆ RU864_LC5

#define RU864_LC5

Value:

    {                                           \
        869700000, 0, {((DR_5 << 4) | DR_0)}, 0 \
    }

◆ RU864_LC6

#define RU864_LC6

Value:

    {                                           \
        869900000, 0, {((DR_5 << 4) | DR_0)}, 0 \
    }

◆ RU864_LC7

#define RU864_LC7

Value:

    {                                           \
        870100000, 0, {((DR_5 << 4) | DR_0)}, 0 \
    }

◆ RU864_LC8

#define RU864_LC8

Value:

    {                                           \
        870300000, 0, {((DR_5 << 4) | DR_0)}, 0 \
    }

◆ RU864_JOIN_CHANNELS

#define RU864_JOIN_CHANNELS (uint16_t)(LC(1) | LC(2))

LoRaMac channels which are allowed for the join procedure

Function Documentation

◆ RegionRU864GetPhyParam()

PhyParam_t RegionRU864GetPhyParam ( GetPhyParams_t * getPhy )

The function gets a value of a specific phy attribute.

Parameters

getPhy Pointer to the function parameters.

Return values

Returns a structure containing the PHY parameter.

◆ RegionRU864SetBandTxDone()

void RegionRU864SetBandTxDone ( SetBandTxDoneParams_t * txDone )

Updates the last TX done parameters of the current channel.

Parameters

txDone Pointer to the function parameters.

◆ RegionRU864InitDefaults()

void RegionRU864InitDefaults ( InitType_t type )

Initializes the channels masks and the channels.

Parameters

type	Sets the initialization type.

◆ RegionRU864Verify()

bool RegionRU864Verify	(	VerifyParams_t *	verify,
		PhyAttribute_t	phyAttribute
	)

Verifies a parameter.

Parameters

verify	Pointer to the function parameters.
phyAttribute	Sets the initialization type.

Return values

Returns true, if the parameter is valid.

◆ RegionRU864ApplyCFList()

void RegionRU864ApplyCFList ( ApplyCFListParams_t * applyCFList )

The function parses the input buffer and sets up the channels of the CF list.

Parameters

applyCFList Pointer to the function parameters.

◆ RegionRU864ChanMaskSet()

bool RegionRU864ChanMaskSet ( ChanMaskSetParams_t * chanMaskSet )

Sets a channels mask.

Parameters

chanMaskSet Pointer to the function parameters.

Return values

Returns true, if the channels mask could be set.

◆ RegionRU864AdrNext()

bool RegionRU864AdrNext	(	AdrNextParams_t *	adrNext,
		int8_t *	drOut,
		int8_t *	txPowOut,
		uint32_t *	adrAckCounter
	)

Calculates the next datarate to set, when ADR is on or off.

Parameters

adrNext	Pointer to the function parameters.
drOut	The calculated datarate for the next TX.
txPowOut	The TX power for the next TX.
adrAckCounter	The calculated ADR acknowledgement counter.

Return values

Returns true, if an ADR request should be performed.

◆ RegionRU864ComputeRxWindowParameters()

void RegionRU864ComputeRxWindowParameters	(	int8_t	datarate,
		uint8_t	minRxSymbols,
		uint32_t	rxError,
		RxConfigParams_t *	rxConfigParams
	)

Computes the Rx window timeout and offset.

Parameters

datarate	Rx window datarate index to be used
minRxSymbols	Minimum required number of symbols to detect an Rx frame.
rxError	System maximum timing error of the receiver. In milliseconds The receiver will turn on in a [-rxError : +rxError] ms interval around RxOffset
rxConfigParams	Returns updated WindowTimeout and WindowOffset fields.

◆ RegionRU864RxConfig()

bool RegionRU864RxConfig	(	RxConfigParams_t *	rxConfig,
		int8_t *	datarate
	)

Configuration of the RX windows.

Parameters

rxConfig	Pointer to the function parameters.
datarate	The datarate index which was set.

Return values

Returns true, if the configuration was applied successfully.

◆ RegionRU864TxConfig()

bool RegionRU864TxConfig	(	TxConfigParams_t *	txConfig,
		int8_t *	txPower,
		TimerTime_t *	txTimeOnAir
	)

TX configuration.

Parameters

txConfig	Pointer to the function parameters.
txPower	The tx power index which was set.
txTimeOnAir	The time-on-air of the frame.

Return values

Returns true, if the configuration was applied successfully.

◆ RegionRU864LinkAdrReq()

uint8_t RegionRU864LinkAdrReq	(	LinkAdrReqParams_t *	linkAdrReq,
		int8_t *	drOut,
		int8_t *	txPowOut,
		uint8_t *	nbRepOut,
		uint8_t *	nbBytesParsed
	)

The function processes a Link ADR Request.

Parameters

linkAdrReq	Pointer to the function parameters.
drOut	Data rate.
txPowOut	TX power.
nbRepOut	Number of repeats.
nbBytesParsed	Number of parsed bytes.

Return values

Returns the status of the operation, according to the LoRaMAC specification.

◆ RegionRU864RxParamSetupReq()

uint8_t RegionRU864RxParamSetupReq ( RxParamSetupReqParams_t * rxParamSetupReq )

The function processes a RX Parameter Setup Request.

Parameters

rxParamSetupReq Pointer to the function parameters.

Return values

Returns the status of the operation, according to the LoRaMAC specification.

◆ RegionRU864NewChannelReq()

uint8_t RegionRU864NewChannelReq ( NewChannelReqParams_t * newChannelReq )

The function processes a Channel Request.

Parameters

newChannelReq Pointer to the function parameters.

Return values

Returns the status of the operation, according to the LoRaMAC specification.

◆ RegionRU864TxParamSetupReq()

int8_t RegionRU864TxParamSetupReq ( TxParamSetupReqParams_t * txParamSetupReq )

The function processes a TX ParamSetup Request.

Parameters

txParamSetupReq Pointer to the function parameters.

Return values

Returns the status of the operation, according to the LoRaMAC specification. Returns -1, if the functionality is not implemented. In this case, the end node shall not process the command.

◆ RegionRU864DlChannelReq()

uint8_t RegionRU864DlChannelReq ( DlChannelReqParams_t * dlChannelReq )

The function processes a DlChannel Request.

Parameters

dlChannelReq Pointer to the function parameters.

Return values

Returns the status of the operation, according to the LoRaMAC specification.

◆ RegionRU864AlternateDr()

int8_t RegionRU864AlternateDr ( AlternateDrParams_t * alternateDr )

Alternates the datarate of the channel for the join request.

Parameters

alternateDr Pointer to the function parameters.

Return values

Datarate to apply.

◆ RegionRU864CalcBackOff()

void RegionRU864CalcBackOff ( CalcBackOffParams_t * calcBackOff )

Calculates the back-off time.

Parameters

calcBackOff Pointer to the function parameters.

◆ RegionRU864NextChannel()

bool RegionRU864NextChannel	(	NextChanParams_t *	nextChanParams,
		uint8_t *	channel,
		TimerTime_t *	time,
		TimerTime_t *	aggregatedTimeOff
	)

Searches and set the next random available channel.

Parameters

nextChanParams	Parameters of next channel to use for TX.
channel	Next channel to use for TX.
time	Time to wait for the next transmission according to the duty cycle.
aggregatedTimeOff	Updates the aggregated time off.

Return values

Function status [1: OK, 0: Unable to find a channel on the current datarate]

◆ RegionRU864ChannelAdd()

LoRaMacStatus_t RegionRU864ChannelAdd ( ChannelAddParams_t * channelAdd )

Adds a channel.

Parameters

channelAdd Pointer to the function parameters.

Return values

Status of the operation.

◆ RegionRU864ChannelsRemove()

bool RegionRU864ChannelsRemove ( ChannelRemoveParams_t * channelRemove )

Removes a channel.

Parameters

channelRemove Pointer to the function parameters.

Return values

Returns true, if the channel was removed successfully.

◆ RegionRU864SetContinuousWave()

void RegionRU864SetContinuousWave ( ContinuousWaveParams_t * continuousWave )

Sets the radio into continuous wave mode.

Parameters

continuousWave Pointer to the function parameters.

◆ RegionRU864ApplyDrOffset()

uint8_t RegionRU864ApplyDrOffset	(	uint8_t	downlinkDwellTime,
		int8_t	dr,
		int8_t	drOffset
	)

Computes new datarate according to the given offset.

Parameters

downlinkDwellTime	Downlink dwell time configuration. 0: No limit, 1: 400ms
dr	Current datarate
drOffset	Offset to be applied

Return values

newDr Computed datarate.

◆ RegionRU864SetVersion()

bool RegionRU864SetVersion ( uint8_t version )

Adjust frequency band to RU864-1, RU864-2, RU864-3.

Parameters

version 1 => use default frequencies (RU864-1) 2 => adjust frequencies by substracting 1.8MHz (RU864-2) 3 => adjust frequencies by substracting 6.6MHz (RU864-3) 4 => adjust frequencies by substracting 5.9MHz (RU864-4), only lower 8 channels supported

Variable Documentation

◆ DataratesRU864

const uint8_t DataratesRU864[] = {12, 11, 10, 9, 8, 7, 7, 50}

static

Data rates table definition

◆ BandwidthsRU864

const uint32_t BandwidthsRU864[] = {125000, 125000, 125000, 125000, 125000, 125000, 250000, 0}

static

Bandwidths table definition in Hz

◆ MaxPayloadOfDatarateRU864

const uint8_t MaxPayloadOfDatarateRU864[] = {59, 59, 59, 123, 230, 230, 230, 230}

static

Maximum payload with respect to the datarate index. Cannot operate with repeater. The table is valid for uplinks and downlinks.

◆ MaxPayloadOfDatarateRepeaterRU864

const uint8_t MaxPayloadOfDatarateRepeaterRU864[] = {59, 59, 59, 123, 250, 250, 250, 250}

static

Maximum payload with respect to the datarate index. Can operate with repeater. The table provides repeater support.

◆ EffectiveRx1DrOffsetRU864

const int8_t EffectiveRx1DrOffsetRU864[] = {0, 1, 2, 3, 4, 5, -1, -2}

static

Effective datarate offsets for receive window 1.

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ RU864_MAX_NB_CHANNELS

◆ RU864_NUMB_DEFAULT_CHANNELS

◆ RU864_NUMB_CHANNELS_CF_LIST

◆ RU864_TX_MIN_DATARATE

◆ RU864_TX_MAX_DATARATE

◆ RU864_RX_MIN_DATARATE

◆ RU864_RX_MAX_DATARATE

◆ RU864_DEFAULT_DATARATE

◆ RU864_MIN_RX1_DR_OFFSET

◆ RU864_MAX_RX1_DR_OFFSET

◆ RU864_DEFAULT_RX1_DR_OFFSET

◆ RU864_MIN_TX_POWER

◆ RU864_MAX_TX_POWER

◆ RU864_DEFAULT_TX_POWER

◆ RU864_DEFAULT_MAX_EIRP

◆ RU864_DEFAULT_ANTENNA_GAIN

◆ RU864_ADR_ACK_LIMIT

◆ RU864_ADR_ACK_DELAY

◆ RU864_DUTY_CYCLE_ENABLED

◆ RU864_MAX_RX_WINDOW

◆ RU864_RECEIVE_DELAY1

◆ RU864_RECEIVE_DELAY2

◆ RU864_JOIN_ACCEPT_DELAY1

◆ RU864_JOIN_ACCEPT_DELAY2

◆ RU864_MAX_FCNT_GAP

◆ RU864_ACKTIMEOUT

◆ RU864_ACK_TIMEOUT_RND

◆ RU864_RX_WND_2_DR

◆ RU864_MAX_NB_BANDS

◆ RU864_BAND0

◆ RU864_LC1

◆ RU864_LC2

◆ RU864_LC3

◆ RU864_LC4

◆ RU864_LC5

◆ RU864_LC6

◆ RU864_LC7

◆ RU864_LC8

◆ RU864_JOIN_CHANNELS

Function Documentation

◆ RegionRU864GetPhyParam()

◆ RegionRU864SetBandTxDone()

◆ RegionRU864InitDefaults()

◆ RegionRU864Verify()

◆ RegionRU864ApplyCFList()

◆ RegionRU864ChanMaskSet()

◆ RegionRU864AdrNext()

◆ RegionRU864ComputeRxWindowParameters()

◆ RegionRU864RxConfig()

◆ RegionRU864TxConfig()

◆ RegionRU864LinkAdrReq()

◆ RegionRU864RxParamSetupReq()

◆ RegionRU864NewChannelReq()

◆ RegionRU864TxParamSetupReq()

◆ RegionRU864DlChannelReq()

◆ RegionRU864AlternateDr()

◆ RegionRU864CalcBackOff()

◆ RegionRU864NextChannel()

◆ RegionRU864ChannelAdd()

◆ RegionRU864ChannelsRemove()

◆ RegionRU864SetContinuousWave()

◆ RegionRU864ApplyDrOffset()

◆ RegionRU864SetVersion()

Variable Documentation

◆ DataratesRU864

◆ BandwidthsRU864

◆ MaxPayloadOfDatarateRU864

◆ MaxPayloadOfDatarateRepeaterRU864

◆ EffectiveRx1DrOffsetRU864