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

Macros
#define	EU868_MAX_NB_CHANNELS 16

#define	EU868_NUMB_DEFAULT_CHANNELS 3

#define	EU868_NUMB_CHANNELS_CF_LIST 5

#define	EU868_TX_MIN_DATARATE DR_0

#define	EU868_TX_MAX_DATARATE DR_7

#define	EU868_RX_MIN_DATARATE DR_0

#define	EU868_RX_MAX_DATARATE DR_7

#define	EU868_DEFAULT_DATARATE DR_0

#define	EU868_MIN_RX1_DR_OFFSET 0

#define	EU868_MAX_RX1_DR_OFFSET 5

#define	EU868_MIN_TX_POWER TX_POWER_7

#define	EU868_MAX_TX_POWER TX_POWER_0

#define	EU868_DEFAULT_TX_POWER TX_POWER_0

#define	EU868_DEFAULT_MAX_EIRP 16.0f

#define	EU868_DEFAULT_ANTENNA_GAIN 2.15f

#define	EU868_DUTY_CYCLE_ENABLED 1

#define	EU868_MAX_RX_WINDOW 3000

#define	EU868_RX_WND_2_FREQ 869525000

#define	EU868_RX_WND_2_DR DR_0

#define	EU868_DEFAULT_UPLINK_DWELL_TIME 0

#define	EU868_BEACON_CHANNEL_FREQ 869525000

#define	EU868_PING_SLOT_CHANNEL_FREQ 869525000

#define	EU868_BEACON_SIZE 17

#define	EU868_RFU1_SIZE 1

#define	EU868_RFU2_SIZE 0

#define	EU868_BEACON_CHANNEL_DR DR_3

#define	EU868_BEACON_CHANNEL_BW 0

#define	EU868_PING_SLOT_CHANNEL_DR DR_3

#define	EU868_MAX_NB_BANDS 6

#define	EU868_BAND0 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	EU868_BAND1 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	EU868_BAND2 { 1000, EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	EU868_BAND3 { 10 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	EU868_BAND4 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	EU868_BAND5 { 1000, EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	EU868_LC1 { 868100000, 0, { ( ( DR_5 << 4 ) \| DR_0 ) }, 1 }

#define	EU868_LC2 { 868300000, 0, { ( ( DR_5 << 4 ) \| DR_0 ) }, 1 }

#define	EU868_LC3 { 868500000, 0, { ( ( DR_5 << 4 ) \| DR_0 ) }, 1 }

#define	EU868_JOIN_CHANNELS ( uint16_t )( LC( 1 ) \| LC( 2 ) \| LC( 3 ) )

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

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

void	RegionEU868InitDefaults (InitDefaultsParams_t *params)
	Initializes the channels masks and the channels. More...

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

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

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

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

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

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

uint8_t	RegionEU868LinkAdrReq (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	RegionEU868RxParamSetupReq (RxParamSetupReqParams_t *rxParamSetupReq)
	The function processes a RX Parameter Setup Request. More...

int8_t	RegionEU868NewChannelReq (NewChannelReqParams_t *newChannelReq)
	The function processes a Channel Request. More...

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

int8_t	RegionEU868DlChannelReq (DlChannelReqParams_t *dlChannelReq)
	The function processes a DlChannel Request. More...

int8_t	RegionEU868AlternateDr (int8_t currentDr, AlternateDrType_t type)
	Alternates the datarate of the channel for the join request. More...

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

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

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

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

void	RegionEU868RxBeaconSetup (RxBeaconSetup_t rxBeaconSetup, uint8_t outDr)
	Sets the radio into beacon reception mode. More...

Detailed Description

Implementation according to LoRaWAN Specification v1.0.2.

Macro Definition Documentation

◆ EU868_MAX_NB_CHANNELS

#define EU868_MAX_NB_CHANNELS 16

LoRaMac maximum number of channels

◆ EU868_NUMB_DEFAULT_CHANNELS

#define EU868_NUMB_DEFAULT_CHANNELS 3

Number of default channels

◆ EU868_NUMB_CHANNELS_CF_LIST

#define EU868_NUMB_CHANNELS_CF_LIST 5

Number of channels to apply for the CF list

◆ EU868_TX_MIN_DATARATE

#define EU868_TX_MIN_DATARATE DR_0

Minimal datarate that can be used by the node

◆ EU868_TX_MAX_DATARATE

#define EU868_TX_MAX_DATARATE DR_7

Maximal datarate that can be used by the node

◆ EU868_RX_MIN_DATARATE

#define EU868_RX_MIN_DATARATE DR_0

Minimal datarate that can be used by the node

◆ EU868_RX_MAX_DATARATE

#define EU868_RX_MAX_DATARATE DR_7

Maximal datarate that can be used by the node

◆ EU868_DEFAULT_DATARATE

#define EU868_DEFAULT_DATARATE DR_0

Default datarate used by the node

◆ EU868_MIN_RX1_DR_OFFSET

#define EU868_MIN_RX1_DR_OFFSET 0

Minimal Rx1 receive datarate offset

◆ EU868_MAX_RX1_DR_OFFSET

#define EU868_MAX_RX1_DR_OFFSET 5

Maximal Rx1 receive datarate offset

◆ EU868_MIN_TX_POWER

#define EU868_MIN_TX_POWER TX_POWER_7

Minimal Tx output power that can be used by the node

◆ EU868_MAX_TX_POWER

#define EU868_MAX_TX_POWER TX_POWER_0

Maximal Tx output power that can be used by the node

◆ EU868_DEFAULT_TX_POWER

#define EU868_DEFAULT_TX_POWER TX_POWER_0

Default Tx output power used by the node

◆ EU868_DEFAULT_MAX_EIRP

#define EU868_DEFAULT_MAX_EIRP 16.0f

Default Max EIRP

◆ EU868_DEFAULT_ANTENNA_GAIN

#define EU868_DEFAULT_ANTENNA_GAIN 2.15f

Default antenna gain

◆ EU868_DUTY_CYCLE_ENABLED

#define EU868_DUTY_CYCLE_ENABLED 1

Enabled or disabled the duty cycle

◆ EU868_MAX_RX_WINDOW

#define EU868_MAX_RX_WINDOW 3000

Maximum RX window duration

◆ EU868_RX_WND_2_FREQ

#define EU868_RX_WND_2_FREQ 869525000

Second reception window channel frequency definition.

◆ EU868_RX_WND_2_DR

#define EU868_RX_WND_2_DR DR_0

Second reception window channel datarate definition.

◆ EU868_DEFAULT_UPLINK_DWELL_TIME

#define EU868_DEFAULT_UPLINK_DWELL_TIME 0

Default uplink dwell time configuration

◆ EU868_BEACON_CHANNEL_FREQ

#define EU868_BEACON_CHANNEL_FREQ 869525000

Beacon frequency

◆ EU868_PING_SLOT_CHANNEL_FREQ

#define EU868_PING_SLOT_CHANNEL_FREQ 869525000

Ping slot channel frequency

◆ EU868_BEACON_SIZE

#define EU868_BEACON_SIZE 17

Payload size of a beacon frame

◆ EU868_RFU1_SIZE

#define EU868_RFU1_SIZE 1

Size of RFU 1 field

◆ EU868_RFU2_SIZE

#define EU868_RFU2_SIZE 0

Size of RFU 2 field

◆ EU868_BEACON_CHANNEL_DR

#define EU868_BEACON_CHANNEL_DR DR_3

Datarate of the beacon channel

◆ EU868_BEACON_CHANNEL_BW

#define EU868_BEACON_CHANNEL_BW 0

Bandwith of the beacon channel

◆ EU868_PING_SLOT_CHANNEL_DR

#define EU868_PING_SLOT_CHANNEL_DR DR_3

Ping slot channel datarate

◆ EU868_MAX_NB_BANDS

#define EU868_MAX_NB_BANDS 6

Maximum number of bands

◆ EU868_BAND0

#define EU868_BAND0 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

Band 0 definition Band = { DutyCycle, TxMaxPower, LastBandUpdateTime, LastMaxCreditAssignTime, TimeCredits, MaxTimeCredits, ReadyForTransmission }

◆ EU868_BAND1

#define EU868_BAND1 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

Band 1 definition Band = { DutyCycle, TxMaxPower, LastBandUpdateTime, LastMaxCreditAssignTime, TimeCredits, MaxTimeCredits, ReadyForTransmission }

◆ EU868_BAND2

#define EU868_BAND2 { 1000, EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

Band 2 definition Band = { DutyCycle, TxMaxPower, LastBandUpdateTime, LastMaxCreditAssignTime, TimeCredits, MaxTimeCredits, ReadyForTransmission }

◆ EU868_BAND3

#define EU868_BAND3 { 10 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

Band 3 definition Band = { DutyCycle, TxMaxPower, LastBandUpdateTime, LastMaxCreditAssignTime, TimeCredits, MaxTimeCredits, ReadyForTransmission }

◆ EU868_BAND4

#define EU868_BAND4 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

Band 4 definition Band = { DutyCycle, TxMaxPower, LastBandUpdateTime, LastMaxCreditAssignTime, TimeCredits, MaxTimeCredits, ReadyForTransmission }

◆ EU868_BAND5

#define EU868_BAND5 { 1000, EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 }

Band 5 definition Band = { DutyCycle, TxMaxPower, LastJoinTxDoneTime, LastTxDoneTime, TimeOff, DutyCycleTimePeriod, MaxAllowedTimeOnAir, AggregatedTimeOnAir, StartTimeOfPeriod }

◆ EU868_LC1

#define EU868_LC1 { 868100000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 1 }

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

◆ EU868_LC2

#define EU868_LC2 { 868300000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 1 }

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

◆ EU868_LC3

#define EU868_LC3 { 868500000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 1 }

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

◆ EU868_JOIN_CHANNELS

#define EU868_JOIN_CHANNELS ( uint16_t )( LC( 1 ) | LC( 2 ) | LC( 3 ) )

LoRaMac channels which are allowed for the join procedure

Function Documentation

◆ RegionEU868GetPhyParam()

PhyParam_t RegionEU868GetPhyParam ( GetPhyParams_t * getPhy )

The function gets a value of a specific phy attribute.

Parameters

[IN]	getPhy Pointer to the function parameters.

Return values

Returns a structure containing the PHY parameter.

◆ RegionEU868SetBandTxDone()

void RegionEU868SetBandTxDone ( SetBandTxDoneParams_t * txDone )

Updates the last TX done parameters of the current channel.

Parameters

[IN]	txDone Pointer to the function parameters.

◆ RegionEU868InitDefaults()

void RegionEU868InitDefaults ( InitDefaultsParams_t * params )

Initializes the channels masks and the channels.

Parameters

[IN]	type Sets the initialization type.

◆ RegionEU868Verify()

bool RegionEU868Verify	(	VerifyParams_t *	verify,
		PhyAttribute_t	phyAttribute
	)

Verifies a parameter.

Parameters

[IN]	verify Pointer to the function parameters.
[IN]	type Sets the initialization type.

Return values

Returns true, if the parameter is valid.

◆ RegionEU868ApplyCFList()

void RegionEU868ApplyCFList ( ApplyCFListParams_t * applyCFList )

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

Parameters

[IN]	applyCFList Pointer to the function parameters.

◆ RegionEU868ChanMaskSet()

bool RegionEU868ChanMaskSet ( ChanMaskSetParams_t * chanMaskSet )

Sets a channels mask.

Parameters

[IN]	chanMaskSet Pointer to the function parameters.

Return values

Returns true, if the channels mask could be set.

◆ RegionEU868ComputeRxWindowParameters()

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

Computes the Rx window timeout and offset.

Parameters

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

◆ RegionEU868RxConfig()

bool RegionEU868RxConfig	(	RxConfigParams_t *	rxConfig,
		int8_t *	datarate
	)

Configuration of the RX windows.

Parameters

[IN]	rxConfig Pointer to the function parameters.
[OUT]	datarate The datarate index which was set.

Return values

Returns true, if the configuration was applied successfully.

◆ RegionEU868TxConfig()

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

TX configuration.

Parameters

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

Return values

Returns true, if the configuration was applied successfully.

◆ RegionEU868LinkAdrReq()

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

The function processes a Link ADR Request.

Parameters

[IN]	linkAdrReq Pointer to the function parameters.

Return values

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

◆ RegionEU868RxParamSetupReq()

uint8_t RegionEU868RxParamSetupReq ( RxParamSetupReqParams_t * rxParamSetupReq )

The function processes a RX Parameter Setup Request.

Parameters

[IN]	rxParamSetupReq Pointer to the function parameters.

Return values

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

◆ RegionEU868NewChannelReq()

int8_t RegionEU868NewChannelReq ( NewChannelReqParams_t * newChannelReq )

The function processes a Channel Request.

Parameters

[IN]	newChannelReq Pointer to the function parameters.

Return values

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

◆ RegionEU868TxParamSetupReq()

int8_t RegionEU868TxParamSetupReq ( TxParamSetupReqParams_t * txParamSetupReq )

The function processes a TX ParamSetup Request.

Parameters

[IN]	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.

◆ RegionEU868DlChannelReq()

int8_t RegionEU868DlChannelReq ( DlChannelReqParams_t * dlChannelReq )

The function processes a DlChannel Request.

Parameters

[IN]	dlChannelReq Pointer to the function parameters.

Return values

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

◆ RegionEU868AlternateDr()

int8_t RegionEU868AlternateDr	(	int8_t	currentDr,
		AlternateDrType_t	type
	)

Alternates the datarate of the channel for the join request.

Parameters

[IN]	currentDr Current datarate.

Return values

Datarate to apply.

◆ RegionEU868NextChannel()

LoRaMacStatus_t RegionEU868NextChannel	(	NextChanParams_t *	nextChanParams,
		uint8_t *	channel,
		TimerTime_t *	time,
		TimerTime_t *	aggregatedTimeOff
	)

Searches and set the next random available channel.

Parameters

[OUT]	channel Next channel to use for TX.
[OUT]	time Time to wait for the next transmission according to the duty cycle.
[OUT]	aggregatedTimeOff Updates the aggregated time off.

Return values

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

◆ RegionEU868ChannelAdd()

LoRaMacStatus_t RegionEU868ChannelAdd ( ChannelAddParams_t * channelAdd )

Adds a channel.

Parameters

[IN]	channelAdd Pointer to the function parameters.

Return values

Status of the operation.

◆ RegionEU868ChannelsRemove()

bool RegionEU868ChannelsRemove ( ChannelRemoveParams_t * channelRemove )

Removes a channel.

Parameters

[IN]	channelRemove Pointer to the function parameters.

Return values

Returns true, if the channel was removed successfully.

◆ RegionEU868ApplyDrOffset()

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

Computes new datarate according to the given offset.

Parameters

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

Return values

newDr Computed datarate.

◆ RegionEU868RxBeaconSetup()

void RegionEU868RxBeaconSetup	(	RxBeaconSetup_t *	rxBeaconSetup,
		uint8_t *	outDr
	)

Sets the radio into beacon reception mode.

Parameters

[IN]	rxBeaconSetup Pointer to the function parameters

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ EU868_MAX_NB_CHANNELS

◆ EU868_NUMB_DEFAULT_CHANNELS

◆ EU868_NUMB_CHANNELS_CF_LIST

◆ EU868_TX_MIN_DATARATE

◆ EU868_TX_MAX_DATARATE

◆ EU868_RX_MIN_DATARATE

◆ EU868_RX_MAX_DATARATE

◆ EU868_DEFAULT_DATARATE

◆ EU868_MIN_RX1_DR_OFFSET

◆ EU868_MAX_RX1_DR_OFFSET

◆ EU868_MIN_TX_POWER

◆ EU868_MAX_TX_POWER

◆ EU868_DEFAULT_TX_POWER

◆ EU868_DEFAULT_MAX_EIRP

◆ EU868_DEFAULT_ANTENNA_GAIN

◆ EU868_DUTY_CYCLE_ENABLED

◆ EU868_MAX_RX_WINDOW

◆ EU868_RX_WND_2_FREQ

◆ EU868_RX_WND_2_DR

◆ EU868_DEFAULT_UPLINK_DWELL_TIME

◆ EU868_BEACON_CHANNEL_FREQ

◆ EU868_PING_SLOT_CHANNEL_FREQ

◆ EU868_BEACON_SIZE

◆ EU868_RFU1_SIZE

◆ EU868_RFU2_SIZE

◆ EU868_BEACON_CHANNEL_DR

◆ EU868_BEACON_CHANNEL_BW

◆ EU868_PING_SLOT_CHANNEL_DR

◆ EU868_MAX_NB_BANDS

◆ EU868_BAND0

◆ EU868_BAND1

◆ EU868_BAND2

◆ EU868_BAND3

◆ EU868_BAND4

◆ EU868_BAND5

◆ EU868_LC1

◆ EU868_LC2

◆ EU868_LC3

◆ EU868_JOIN_CHANNELS

Function Documentation

◆ RegionEU868GetPhyParam()

◆ RegionEU868SetBandTxDone()

◆ RegionEU868InitDefaults()

◆ RegionEU868Verify()

◆ RegionEU868ApplyCFList()

◆ RegionEU868ChanMaskSet()

◆ RegionEU868ComputeRxWindowParameters()

◆ RegionEU868RxConfig()

◆ RegionEU868TxConfig()

◆ RegionEU868LinkAdrReq()

◆ RegionEU868RxParamSetupReq()

◆ RegionEU868NewChannelReq()

◆ RegionEU868TxParamSetupReq()

◆ RegionEU868DlChannelReq()

◆ RegionEU868AlternateDr()

◆ RegionEU868NextChannel()

◆ RegionEU868ChannelAdd()

◆ RegionEU868ChannelsRemove()

◆ RegionEU868ApplyDrOffset()

◆ RegionEU868RxBeaconSetup()