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

Macros
#define	AU915_MAX_NB_CHANNELS 72

#define	AU915_TX_MIN_DATARATE DR_0

#define	AU915_TX_MAX_DATARATE DR_6

#define	AU915_RX_MIN_DATARATE DR_8

#define	AU915_RX_MAX_DATARATE DR_13

#define	AU915_DEFAULT_DATARATE DR_2

#define	AU915_DWELL_LIMIT_DATARATE DR_2

#define	AU915_MIN_RX1_DR_OFFSET 0

#define	AU915_MAX_RX1_DR_OFFSET 6

#define	AU915_MIN_TX_POWER TX_POWER_14

#define	AU915_MAX_TX_POWER TX_POWER_0

#define	AU915_DEFAULT_TX_POWER TX_POWER_0

#define	AU915_DEFAULT_UPLINK_DWELL_TIME 1

#define	AU915_DEFAULT_MAX_EIRP 30.0f

#define	AU915_DEFAULT_ANTENNA_GAIN 2.15f

#define	AU915_DUTY_CYCLE_ENABLED 0

#define	AU915_MAX_RX_WINDOW 3000

#define	AU915_RX_WND_2_FREQ 923300000

#define	AU915_RX_WND_2_DR DR_8

#define	AU915_BEACON_CHANNEL_FREQ 923300000

#define	AU915_BEACON_CHANNEL_STEPWIDTH 600000

#define	AU915_PING_SLOT_CHANNEL_FREQ 923300000

#define	AU915_BEACON_NB_CHANNELS 8

#define	AU915_BEACON_SIZE 23

#define	AU915_RFU1_SIZE 5

#define	AU915_RFU2_SIZE 3

#define	AU915_BEACON_CHANNEL_DR DR_8

#define	AU915_BEACON_CHANNEL_BW 2

#define	AU915_PING_SLOT_CHANNEL_DR DR_8

#define	AU915_MAX_NB_BANDS 1

#define	AU915_BAND0 { 1, AU915_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	AU915_FIRST_RX1_CHANNEL ( (uint32_t) 923300000 )

#define	AU915_LAST_RX1_CHANNEL ( (uint32_t) 927500000 )

#define	AU915_STEPWIDTH_RX1_CHANNEL ( (uint32_t) 600000 )

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

◆ AU915_MAX_NB_CHANNELS

#define AU915_MAX_NB_CHANNELS 72

LoRaMac maximum number of channels

◆ AU915_TX_MIN_DATARATE

#define AU915_TX_MIN_DATARATE DR_0

Minimal datarate that can be used by the node

◆ AU915_TX_MAX_DATARATE

#define AU915_TX_MAX_DATARATE DR_6

Maximal datarate that can be used by the node

◆ AU915_RX_MIN_DATARATE

#define AU915_RX_MIN_DATARATE DR_8

Minimal datarate that can be used by the node

◆ AU915_RX_MAX_DATARATE

#define AU915_RX_MAX_DATARATE DR_13

Maximal datarate that can be used by the node

◆ AU915_DEFAULT_DATARATE

#define AU915_DEFAULT_DATARATE DR_2

Default datarate used by the node

◆ AU915_DWELL_LIMIT_DATARATE

#define AU915_DWELL_LIMIT_DATARATE DR_2

The minimum datarate which is used when the dwell time is limited.

◆ AU915_MIN_RX1_DR_OFFSET

#define AU915_MIN_RX1_DR_OFFSET 0

Minimal Rx1 receive datarate offset

◆ AU915_MAX_RX1_DR_OFFSET

#define AU915_MAX_RX1_DR_OFFSET 6

Maximal Rx1 receive datarate offset

◆ AU915_MIN_TX_POWER

#define AU915_MIN_TX_POWER TX_POWER_14

Minimal Tx output power that can be used by the node

◆ AU915_MAX_TX_POWER

#define AU915_MAX_TX_POWER TX_POWER_0

Maximal Tx output power that can be used by the node

◆ AU915_DEFAULT_TX_POWER

#define AU915_DEFAULT_TX_POWER TX_POWER_0

Default Tx output power used by the node

◆ AU915_DEFAULT_UPLINK_DWELL_TIME

#define AU915_DEFAULT_UPLINK_DWELL_TIME 1

Default uplink dwell time configuration

◆ AU915_DEFAULT_MAX_EIRP

#define AU915_DEFAULT_MAX_EIRP 30.0f

Default Max EIRP

◆ AU915_DEFAULT_ANTENNA_GAIN

#define AU915_DEFAULT_ANTENNA_GAIN 2.15f

Default antenna gain

◆ AU915_DUTY_CYCLE_ENABLED

#define AU915_DUTY_CYCLE_ENABLED 0

Enabled or disabled the duty cycle

◆ AU915_MAX_RX_WINDOW

#define AU915_MAX_RX_WINDOW 3000

Maximum RX window duration

◆ AU915_RX_WND_2_FREQ

#define AU915_RX_WND_2_FREQ 923300000

Second reception window channel frequency definition.

◆ AU915_RX_WND_2_DR

#define AU915_RX_WND_2_DR DR_8

Second reception window channel datarate definition.

◆ AU915_BEACON_CHANNEL_FREQ

#define AU915_BEACON_CHANNEL_FREQ 923300000

Beacon frequency

◆ AU915_BEACON_CHANNEL_STEPWIDTH

#define AU915_BEACON_CHANNEL_STEPWIDTH 600000

Beacon frequency channel stepwidth

◆ AU915_PING_SLOT_CHANNEL_FREQ

#define AU915_PING_SLOT_CHANNEL_FREQ 923300000

Ping slot channel frequency

◆ AU915_BEACON_NB_CHANNELS

#define AU915_BEACON_NB_CHANNELS 8

Number of possible beacon channels

◆ AU915_BEACON_SIZE

#define AU915_BEACON_SIZE 23

Payload size of a beacon frame

◆ AU915_RFU1_SIZE

#define AU915_RFU1_SIZE 5

Size of RFU 1 field

◆ AU915_RFU2_SIZE

#define AU915_RFU2_SIZE 3

Size of RFU 2 field

◆ AU915_BEACON_CHANNEL_DR

#define AU915_BEACON_CHANNEL_DR DR_8

Datarate of the beacon channel

◆ AU915_BEACON_CHANNEL_BW

#define AU915_BEACON_CHANNEL_BW 2

Bandwith of the beacon channel

◆ AU915_PING_SLOT_CHANNEL_DR

#define AU915_PING_SLOT_CHANNEL_DR DR_8

Ping slot channel datarate

◆ AU915_MAX_NB_BANDS

#define AU915_MAX_NB_BANDS 1

LoRaMac maximum number of bands

◆ AU915_BAND0

#define AU915_BAND0 { 1, AU915_MAX_TX_POWER, 0, 0, 0, 0, 0 }

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

◆ AU915_FIRST_RX1_CHANNEL

#define AU915_FIRST_RX1_CHANNEL ( (uint32_t) 923300000 )

Defines the first channel for RX window 1 for US band

◆ AU915_LAST_RX1_CHANNEL

#define AU915_LAST_RX1_CHANNEL ( (uint32_t) 927500000 )

Defines the last channel for RX window 1 for US band

◆ AU915_STEPWIDTH_RX1_CHANNEL

#define AU915_STEPWIDTH_RX1_CHANNEL ( (uint32_t) 600000 )

Defines the step width of the channels for RX window 1

Function Documentation

◆ RegionAU915GetPhyParam()

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

◆ RegionAU915SetBandTxDone()

void RegionAU915SetBandTxDone ( SetBandTxDoneParams_t * txDone )

Updates the last TX done parameters of the current channel.

Parameters

[IN]	txDone Pointer to the function parameters.

◆ RegionAU915InitDefaults()

void RegionAU915InitDefaults ( InitDefaultsParams_t * params )

Initializes the channels masks and the channels.

Parameters

[IN]	type Sets the initialization type.

◆ RegionAU915GetNvmCtx()

void* RegionAU915GetNvmCtx ( 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.

◆ RegionAU915Verify()

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

◆ RegionAU915ApplyCFList()

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

◆ RegionAU915ChanMaskSet()

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

◆ RegionAU915ComputeRxWindowParameters()

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

◆ RegionAU915RxConfig()

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

◆ RegionAU915TxConfig()

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

◆ RegionAU915LinkAdrReq()

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

◆ RegionAU915RxParamSetupReq()

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

◆ RegionAU915NewChannelReq()

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

◆ RegionAU915TxParamSetupReq()

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

◆ RegionAU915DlChannelReq()

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

◆ RegionAU915AlternateDr()

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

◆ RegionAU915NextChannel()

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

◆ RegionAU915ChannelAdd()

LoRaMacStatus_t RegionAU915ChannelAdd ( ChannelAddParams_t * channelAdd )

Adds a channel.

Parameters

[IN]	channelAdd Pointer to the function parameters.

Return values

Status of the operation.

◆ RegionAU915ChannelsRemove()

bool RegionAU915ChannelsRemove ( ChannelRemoveParams_t * channelRemove )

Removes a channel.

Parameters

[IN]	channelRemove Pointer to the function parameters.

Return values

Returns true, if the channel was removed successfully.

◆ RegionAU915SetContinuousWave()

void RegionAU915SetContinuousWave ( ContinuousWaveParams_t * continuousWave )

Sets the radio into continuous wave mode.

Parameters

[IN]	continuousWave Pointer to the function parameters.

◆ RegionAU915ApplyDrOffset()

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

◆ RegionAU915RxBeaconSetup()

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

◆ AU915_MAX_NB_CHANNELS

◆ AU915_TX_MIN_DATARATE

◆ AU915_TX_MAX_DATARATE

◆ AU915_RX_MIN_DATARATE

◆ AU915_RX_MAX_DATARATE

◆ AU915_DEFAULT_DATARATE

◆ AU915_DWELL_LIMIT_DATARATE

◆ AU915_MIN_RX1_DR_OFFSET

◆ AU915_MAX_RX1_DR_OFFSET

◆ AU915_MIN_TX_POWER

◆ AU915_MAX_TX_POWER

◆ AU915_DEFAULT_TX_POWER

◆ AU915_DEFAULT_UPLINK_DWELL_TIME

◆ AU915_DEFAULT_MAX_EIRP

◆ AU915_DEFAULT_ANTENNA_GAIN

◆ AU915_DUTY_CYCLE_ENABLED

◆ AU915_MAX_RX_WINDOW

◆ AU915_RX_WND_2_FREQ

◆ AU915_RX_WND_2_DR

◆ AU915_BEACON_CHANNEL_FREQ

◆ AU915_BEACON_CHANNEL_STEPWIDTH

◆ AU915_PING_SLOT_CHANNEL_FREQ

◆ AU915_BEACON_NB_CHANNELS

◆ AU915_BEACON_SIZE

◆ AU915_RFU1_SIZE

◆ AU915_RFU2_SIZE

◆ AU915_BEACON_CHANNEL_DR

◆ AU915_BEACON_CHANNEL_BW

◆ AU915_PING_SLOT_CHANNEL_DR

◆ AU915_MAX_NB_BANDS

◆ AU915_BAND0

◆ AU915_FIRST_RX1_CHANNEL

◆ AU915_LAST_RX1_CHANNEL

◆ AU915_STEPWIDTH_RX1_CHANNEL

Function Documentation

◆ RegionAU915GetPhyParam()

◆ RegionAU915SetBandTxDone()

◆ RegionAU915InitDefaults()

◆ RegionAU915GetNvmCtx()

◆ RegionAU915Verify()

◆ RegionAU915ApplyCFList()

◆ RegionAU915ChanMaskSet()

◆ RegionAU915ComputeRxWindowParameters()

◆ RegionAU915RxConfig()

◆ RegionAU915TxConfig()

◆ RegionAU915LinkAdrReq()

◆ RegionAU915RxParamSetupReq()

◆ RegionAU915NewChannelReq()

◆ RegionAU915TxParamSetupReq()

◆ RegionAU915DlChannelReq()

◆ RegionAU915AlternateDr()

◆ RegionAU915NextChannel()

◆ RegionAU915ChannelAdd()

◆ RegionAU915ChannelsRemove()

◆ RegionAU915SetContinuousWave()

◆ RegionAU915ApplyDrOffset()

◆ RegionAU915RxBeaconSetup()