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

Macros
#define	IN865_MAX_NB_CHANNELS 16

#define	IN865_NUMB_DEFAULT_CHANNELS 3

#define	IN865_NUMB_CHANNELS_CF_LIST 5

#define	IN865_TX_MIN_DATARATE DR_0

#define	IN865_TX_MAX_DATARATE DR_7

#define	IN865_RX_MIN_DATARATE DR_0

#define	IN865_RX_MAX_DATARATE DR_7

#define	IN865_DEFAULT_DATARATE DR_0

#define	IN865_MIN_RX1_DR_OFFSET 0

#define	IN865_MAX_RX1_DR_OFFSET 7

#define	IN865_MIN_TX_POWER TX_POWER_10

#define	IN865_MAX_TX_POWER TX_POWER_0

#define	IN865_DEFAULT_TX_POWER TX_POWER_0

#define	IN865_DEFAULT_MAX_EIRP 30.0f

#define	IN865_DEFAULT_ANTENNA_GAIN 2.15f

#define	IN865_DUTY_CYCLE_ENABLED 0

#define	IN865_MAX_RX_WINDOW 3000

#define	IN865_RX_WND_2_FREQ 866550000

#define	IN865_RX_WND_2_DR DR_2

#define	IN865_DEFAULT_UPLINK_DWELL_TIME 0

#define	IN865_BEACON_CHANNEL_FREQ 866550000

#define	IN865_PING_SLOT_CHANNEL_FREQ 866550000

#define	IN865_BEACON_SIZE 19

#define	IN865_RFU1_SIZE 1

#define	IN865_RFU2_SIZE 3

#define	IN865_BEACON_CHANNEL_DR DR_4

#define	IN865_BEACON_CHANNEL_BW 0

#define	IN865_PING_SLOT_CHANNEL_DR DR_4

#define	IN865_MAX_NB_BANDS 1

#define	IN865_BAND0 { 1 , IN865_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	IN865_LC1 { 865062500, 0, { ( ( DR_5 << 4 ) \| DR_0 ) }, 0 }

#define	IN865_LC2 { 865402500, 0, { ( ( DR_5 << 4 ) \| DR_0 ) }, 0 }

#define	IN865_LC3 { 865985000, 0, { ( ( DR_5 << 4 ) \| DR_0 ) }, 0 }

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

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

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

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

void *	RegionIN865GetNvmCtx (GetNvmCtxParams_t *params)
	Returns a pointer to the internal context and its size. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	RegionIN865RxBeaconSetup (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

◆ IN865_MAX_NB_CHANNELS

#define IN865_MAX_NB_CHANNELS 16

LoRaMac maximum number of channels

◆ IN865_NUMB_DEFAULT_CHANNELS

#define IN865_NUMB_DEFAULT_CHANNELS 3

Number of default channels

◆ IN865_NUMB_CHANNELS_CF_LIST

#define IN865_NUMB_CHANNELS_CF_LIST 5

Number of channels to apply for the CF list

◆ IN865_TX_MIN_DATARATE

#define IN865_TX_MIN_DATARATE DR_0

Minimal datarate that can be used by the node

◆ IN865_TX_MAX_DATARATE

#define IN865_TX_MAX_DATARATE DR_7

Maximal datarate that can be used by the node

◆ IN865_RX_MIN_DATARATE

#define IN865_RX_MIN_DATARATE DR_0

Minimal datarate that can be used by the node

◆ IN865_RX_MAX_DATARATE

#define IN865_RX_MAX_DATARATE DR_7

Maximal datarate that can be used by the node

◆ IN865_DEFAULT_DATARATE

#define IN865_DEFAULT_DATARATE DR_0

Default datarate used by the node

◆ IN865_MIN_RX1_DR_OFFSET

#define IN865_MIN_RX1_DR_OFFSET 0

Minimal Rx1 receive datarate offset

◆ IN865_MAX_RX1_DR_OFFSET

#define IN865_MAX_RX1_DR_OFFSET 7

Maximal Rx1 receive datarate offset

◆ IN865_MIN_TX_POWER

#define IN865_MIN_TX_POWER TX_POWER_10

Minimal Tx output power that can be used by the node

◆ IN865_MAX_TX_POWER

#define IN865_MAX_TX_POWER TX_POWER_0

Maximal Tx output power that can be used by the node

◆ IN865_DEFAULT_TX_POWER

#define IN865_DEFAULT_TX_POWER TX_POWER_0

Default Tx output power used by the node

◆ IN865_DEFAULT_MAX_EIRP

#define IN865_DEFAULT_MAX_EIRP 30.0f

Default Max EIRP

◆ IN865_DEFAULT_ANTENNA_GAIN

#define IN865_DEFAULT_ANTENNA_GAIN 2.15f

Default antenna gain

◆ IN865_DUTY_CYCLE_ENABLED

#define IN865_DUTY_CYCLE_ENABLED 0

Enabled or disabled the duty cycle

◆ IN865_MAX_RX_WINDOW

#define IN865_MAX_RX_WINDOW 3000

Maximum RX window duration

◆ IN865_RX_WND_2_FREQ

#define IN865_RX_WND_2_FREQ 866550000

Second reception window channel frequency definition.

◆ IN865_RX_WND_2_DR

#define IN865_RX_WND_2_DR DR_2

Second reception window channel datarate definition.

◆ IN865_DEFAULT_UPLINK_DWELL_TIME

#define IN865_DEFAULT_UPLINK_DWELL_TIME 0

Default uplink dwell time configuration

◆ IN865_BEACON_CHANNEL_FREQ

#define IN865_BEACON_CHANNEL_FREQ 866550000

Beacon frequency

◆ IN865_PING_SLOT_CHANNEL_FREQ

#define IN865_PING_SLOT_CHANNEL_FREQ 866550000

Ping slot channel frequency

◆ IN865_BEACON_SIZE

#define IN865_BEACON_SIZE 19

Payload size of a beacon frame

◆ IN865_RFU1_SIZE

#define IN865_RFU1_SIZE 1

Size of RFU 1 field

◆ IN865_RFU2_SIZE

#define IN865_RFU2_SIZE 3

Size of RFU 2 field

◆ IN865_BEACON_CHANNEL_DR

#define IN865_BEACON_CHANNEL_DR DR_4

Datarate of the beacon channel

◆ IN865_BEACON_CHANNEL_BW

#define IN865_BEACON_CHANNEL_BW 0

Bandwith of the beacon channel

◆ IN865_PING_SLOT_CHANNEL_DR

#define IN865_PING_SLOT_CHANNEL_DR DR_4

Ping slot channel datarate

◆ IN865_MAX_NB_BANDS

#define IN865_MAX_NB_BANDS 1

Maximum number of bands

◆ IN865_BAND0

#define IN865_BAND0 { 1 , IN865_MAX_TX_POWER, 0, 0, 0, 0, 0 }

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

◆ IN865_LC1

#define IN865_LC1 { 865062500, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }

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

◆ IN865_LC2

#define IN865_LC2 { 865402500, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }

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

◆ IN865_LC3

#define IN865_LC3 { 865985000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }

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

◆ IN865_JOIN_CHANNELS

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

LoRaMac channels which are allowed for the join procedure

Function Documentation

◆ RegionIN865GetPhyParam()

PhyParam_t RegionIN865GetPhyParam ( 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.

◆ RegionIN865SetBandTxDone()

void RegionIN865SetBandTxDone ( SetBandTxDoneParams_t * txDone )

Updates the last TX done parameters of the current channel.

Parameters

[IN]	txDone Pointer to the function parameters.

◆ RegionIN865InitDefaults()

void RegionIN865InitDefaults ( InitDefaultsParams_t * params )

Initializes the channels masks and the channels.

Parameters

[IN]	type Sets the initialization type.

◆ RegionIN865GetNvmCtx()

void* RegionIN865GetNvmCtx ( GetNvmCtxParams_t * params )

Returns a pointer to the internal context and its size.

Parameters

[OUT] params Pointer to the function parameters.

Return values

Points to a structure where the module store its non-volatile context.

◆ RegionIN865Verify()

bool RegionIN865Verify	(	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.

◆ RegionIN865ApplyCFList()

void RegionIN865ApplyCFList ( 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.

◆ RegionIN865ChanMaskSet()

bool RegionIN865ChanMaskSet ( 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.

◆ RegionIN865ComputeRxWindowParameters()

void RegionIN865ComputeRxWindowParameters	(	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.

◆ RegionIN865RxConfig()

bool RegionIN865RxConfig	(	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.

◆ RegionIN865TxConfig()

bool RegionIN865TxConfig	(	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.

◆ RegionIN865LinkAdrReq()

uint8_t RegionIN865LinkAdrReq	(	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.

◆ RegionIN865RxParamSetupReq()

uint8_t RegionIN865RxParamSetupReq ( 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.

◆ RegionIN865NewChannelReq()

uint8_t RegionIN865NewChannelReq ( 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.

◆ RegionIN865TxParamSetupReq()

int8_t RegionIN865TxParamSetupReq ( 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.

◆ RegionIN865DlChannelReq()

uint8_t RegionIN865DlChannelReq ( 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.

◆ RegionIN865AlternateDr()

int8_t RegionIN865AlternateDr	(	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.

◆ RegionIN865NextChannel()

LoRaMacStatus_t RegionIN865NextChannel	(	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]

◆ RegionIN865ChannelAdd()

LoRaMacStatus_t RegionIN865ChannelAdd ( ChannelAddParams_t * channelAdd )

Adds a channel.

Parameters

[IN]	channelAdd Pointer to the function parameters.

Return values

Status of the operation.

◆ RegionIN865ChannelsRemove()

bool RegionIN865ChannelsRemove ( ChannelRemoveParams_t * channelRemove )

Removes a channel.

Parameters

[IN]	channelRemove Pointer to the function parameters.

Return values

Returns true, if the channel was removed successfully.

◆ RegionIN865SetContinuousWave()

void RegionIN865SetContinuousWave ( ContinuousWaveParams_t * continuousWave )

Sets the radio into continuous wave mode.

Parameters

[IN]	continuousWave Pointer to the function parameters.

◆ RegionIN865ApplyDrOffset()

uint8_t RegionIN865ApplyDrOffset	(	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.

◆ RegionIN865RxBeaconSetup()

void RegionIN865RxBeaconSetup	(	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

◆ IN865_MAX_NB_CHANNELS

◆ IN865_NUMB_DEFAULT_CHANNELS

◆ IN865_NUMB_CHANNELS_CF_LIST

◆ IN865_TX_MIN_DATARATE

◆ IN865_TX_MAX_DATARATE

◆ IN865_RX_MIN_DATARATE

◆ IN865_RX_MAX_DATARATE

◆ IN865_DEFAULT_DATARATE

◆ IN865_MIN_RX1_DR_OFFSET

◆ IN865_MAX_RX1_DR_OFFSET

◆ IN865_MIN_TX_POWER

◆ IN865_MAX_TX_POWER

◆ IN865_DEFAULT_TX_POWER

◆ IN865_DEFAULT_MAX_EIRP

◆ IN865_DEFAULT_ANTENNA_GAIN

◆ IN865_DUTY_CYCLE_ENABLED

◆ IN865_MAX_RX_WINDOW

◆ IN865_RX_WND_2_FREQ

◆ IN865_RX_WND_2_DR

◆ IN865_DEFAULT_UPLINK_DWELL_TIME

◆ IN865_BEACON_CHANNEL_FREQ

◆ IN865_PING_SLOT_CHANNEL_FREQ

◆ IN865_BEACON_SIZE

◆ IN865_RFU1_SIZE

◆ IN865_RFU2_SIZE

◆ IN865_BEACON_CHANNEL_DR

◆ IN865_BEACON_CHANNEL_BW

◆ IN865_PING_SLOT_CHANNEL_DR

◆ IN865_MAX_NB_BANDS

◆ IN865_BAND0

◆ IN865_LC1

◆ IN865_LC2

◆ IN865_LC3

◆ IN865_JOIN_CHANNELS

Function Documentation

◆ RegionIN865GetPhyParam()

◆ RegionIN865SetBandTxDone()

◆ RegionIN865InitDefaults()

◆ RegionIN865GetNvmCtx()

◆ RegionIN865Verify()

◆ RegionIN865ApplyCFList()

◆ RegionIN865ChanMaskSet()

◆ RegionIN865ComputeRxWindowParameters()

◆ RegionIN865RxConfig()

◆ RegionIN865TxConfig()

◆ RegionIN865LinkAdrReq()

◆ RegionIN865RxParamSetupReq()

◆ RegionIN865NewChannelReq()

◆ RegionIN865TxParamSetupReq()

◆ RegionIN865DlChannelReq()

◆ RegionIN865AlternateDr()

◆ RegionIN865NextChannel()

◆ RegionIN865ChannelAdd()

◆ RegionIN865ChannelsRemove()

◆ RegionIN865SetContinuousWave()

◆ RegionIN865ApplyDrOffset()

◆ RegionIN865RxBeaconSetup()