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

Macros
#define	US915_MAX_NB_CHANNELS 72

#define	US915_TX_MIN_DATARATE DR_0

#define	US915_TX_MAX_DATARATE DR_4

#define	US915_RX_MIN_DATARATE DR_8

#define	US915_RX_MAX_DATARATE DR_13

#define	US915_DEFAULT_DATARATE DR_0

#define	US915_MIN_RX1_DR_OFFSET 0

#define	US915_MAX_RX1_DR_OFFSET 3

#define	US915_MIN_TX_POWER TX_POWER_14

#define	US915_MAX_TX_POWER TX_POWER_0

#define	US915_DEFAULT_TX_POWER TX_POWER_0

#define	US915_DEFAULT_MAX_ERP 30.0f

#define	US915_DUTY_CYCLE_ENABLED 0

#define	US915_MAX_RX_WINDOW 3000

#define	US915_RX_WND_2_FREQ 923300000

#define	US915_RX_WND_2_DR DR_8

#define	US915_DEFAULT_UPLINK_DWELL_TIME 0

#define	US915_BEACON_CHANNEL_FREQ 923300000

#define	US915_BEACON_CHANNEL_STEPWIDTH 600000

#define	US915_PING_SLOT_CHANNEL_FREQ 923300000

#define	US915_BEACON_NB_CHANNELS 8

#define	US915_BEACON_SIZE 23

#define	US915_RFU1_SIZE 4

#define	US915_RFU2_SIZE 3

#define	US915_BEACON_CHANNEL_DR DR_8

#define	US915_BEACON_CHANNEL_BW 2

#define	US915_PING_SLOT_CHANNEL_DR DR_8

#define	US915_MAX_NB_BANDS 1

#define	US915_BAND0 { 1, US915_MAX_TX_POWER, 0, 0, 0, 0, 0 }

#define	US915_FIRST_RX1_CHANNEL ( (uint32_t) 923300000 )

#define	US915_LAST_RX1_CHANNEL ( (uint32_t) 927500000 )

#define	US915_STEPWIDTH_RX1_CHANNEL ( (uint32_t) 600000 )

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

◆ US915_MAX_NB_CHANNELS

#define US915_MAX_NB_CHANNELS 72

LoRaMac maximum number of channels

◆ US915_TX_MIN_DATARATE

#define US915_TX_MIN_DATARATE DR_0

Minimal datarate that can be used by the node

◆ US915_TX_MAX_DATARATE

#define US915_TX_MAX_DATARATE DR_4

Maximal datarate that can be used by the node

◆ US915_RX_MIN_DATARATE

#define US915_RX_MIN_DATARATE DR_8

Minimal datarate that can be used by the node

◆ US915_RX_MAX_DATARATE

#define US915_RX_MAX_DATARATE DR_13

Maximal datarate that can be used by the node

◆ US915_DEFAULT_DATARATE

#define US915_DEFAULT_DATARATE DR_0

Default datarate used by the node

◆ US915_MIN_RX1_DR_OFFSET

#define US915_MIN_RX1_DR_OFFSET 0

Minimal Rx1 receive datarate offset

◆ US915_MAX_RX1_DR_OFFSET

#define US915_MAX_RX1_DR_OFFSET 3

Maximal Rx1 receive datarate offset

◆ US915_MIN_TX_POWER

#define US915_MIN_TX_POWER TX_POWER_14

Minimal Tx output power that can be used by the node

◆ US915_MAX_TX_POWER

#define US915_MAX_TX_POWER TX_POWER_0

Maximal Tx output power that can be used by the node

◆ US915_DEFAULT_TX_POWER

#define US915_DEFAULT_TX_POWER TX_POWER_0

Default Tx output power used by the node

◆ US915_DEFAULT_MAX_ERP

#define US915_DEFAULT_MAX_ERP 30.0f

Default Max ERP

◆ US915_DUTY_CYCLE_ENABLED

#define US915_DUTY_CYCLE_ENABLED 0

Enabled or disabled the duty cycle

◆ US915_MAX_RX_WINDOW

#define US915_MAX_RX_WINDOW 3000

Maximum RX window duration

◆ US915_RX_WND_2_FREQ

#define US915_RX_WND_2_FREQ 923300000

Second reception window channel frequency definition.

◆ US915_RX_WND_2_DR

#define US915_RX_WND_2_DR DR_8

Second reception window channel datarate definition.

◆ US915_DEFAULT_UPLINK_DWELL_TIME

#define US915_DEFAULT_UPLINK_DWELL_TIME 0

Default uplink dwell time configuration

◆ US915_BEACON_CHANNEL_FREQ

#define US915_BEACON_CHANNEL_FREQ 923300000

Beacon frequency

◆ US915_BEACON_CHANNEL_STEPWIDTH

#define US915_BEACON_CHANNEL_STEPWIDTH 600000

Beacon frequency channel stepwidth

◆ US915_PING_SLOT_CHANNEL_FREQ

#define US915_PING_SLOT_CHANNEL_FREQ 923300000

Ping slot channel frequency

◆ US915_BEACON_NB_CHANNELS

#define US915_BEACON_NB_CHANNELS 8

Number of possible beacon channels

◆ US915_BEACON_SIZE

#define US915_BEACON_SIZE 23

Payload size of a beacon frame

◆ US915_RFU1_SIZE

#define US915_RFU1_SIZE 4

Size of RFU 1 field

◆ US915_RFU2_SIZE

#define US915_RFU2_SIZE 3

Size of RFU 2 field

◆ US915_BEACON_CHANNEL_DR

#define US915_BEACON_CHANNEL_DR DR_8

Datarate of the beacon channel

◆ US915_BEACON_CHANNEL_BW

#define US915_BEACON_CHANNEL_BW 2

Bandwith of the beacon channel

◆ US915_PING_SLOT_CHANNEL_DR

#define US915_PING_SLOT_CHANNEL_DR DR_8

Ping slot channel datarate

◆ US915_MAX_NB_BANDS

#define US915_MAX_NB_BANDS 1

LoRaMac maximum number of bands

◆ US915_BAND0

#define US915_BAND0 { 1, US915_MAX_TX_POWER, 0, 0, 0, 0, 0 }

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

◆ US915_FIRST_RX1_CHANNEL

#define US915_FIRST_RX1_CHANNEL ( (uint32_t) 923300000 )

Defines the first channel for RX window 1 for US band

◆ US915_LAST_RX1_CHANNEL

#define US915_LAST_RX1_CHANNEL ( (uint32_t) 927500000 )

Defines the last channel for RX window 1 for US band

◆ US915_STEPWIDTH_RX1_CHANNEL

#define US915_STEPWIDTH_RX1_CHANNEL ( (uint32_t) 600000 )

Defines the step width of the channels for RX window 1

Function Documentation

◆ RegionUS915GetPhyParam()

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

◆ RegionUS915SetBandTxDone()

void RegionUS915SetBandTxDone ( SetBandTxDoneParams_t * txDone )

Updates the last TX done parameters of the current channel.

Parameters

[IN]	txDone Pointer to the function parameters.

◆ RegionUS915InitDefaults()

void RegionUS915InitDefaults ( InitDefaultsParams_t * params )

Initializes the channels masks and the channels.

Parameters

[IN]	type Sets the initialization type.

◆ RegionUS915Verify()

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

◆ RegionUS915ApplyCFList()

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

◆ RegionUS915ChanMaskSet()

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

◆ RegionUS915ComputeRxWindowParameters()

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

◆ RegionUS915RxConfig()

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

◆ RegionUS915TxConfig()

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

◆ RegionUS915LinkAdrReq()

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

◆ RegionUS915RxParamSetupReq()

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

◆ RegionUS915NewChannelReq()

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

◆ RegionUS915TxParamSetupReq()

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

◆ RegionUS915DlChannelReq()

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

◆ RegionUS915AlternateDr()

int8_t RegionUS915AlternateDr	(	int8_t	currentDr,
		AlternateDrType_t	type
	)

Alternates the datarate of the channel for the join request.

Parameters

[IN]	currentDr Current datarate.
[IN]	type Alternation type.

Return values

Datarate to apply.

◆ RegionUS915NextChannel()

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

◆ RegionUS915ChannelAdd()

LoRaMacStatus_t RegionUS915ChannelAdd ( ChannelAddParams_t * channelAdd )

Adds a channel.

Parameters

[IN]	channelAdd Pointer to the function parameters.

Return values

Status of the operation.

◆ RegionUS915ChannelsRemove()

bool RegionUS915ChannelsRemove ( ChannelRemoveParams_t * channelRemove )

Removes a channel.

Parameters

[IN]	channelRemove Pointer to the function parameters.

Return values

Returns true, if the channel was removed successfully.

◆ RegionUS915ApplyDrOffset()

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

◆ RegionUS915RxBeaconSetup()

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

◆ US915_MAX_NB_CHANNELS

◆ US915_TX_MIN_DATARATE

◆ US915_TX_MAX_DATARATE

◆ US915_RX_MIN_DATARATE

◆ US915_RX_MAX_DATARATE

◆ US915_DEFAULT_DATARATE

◆ US915_MIN_RX1_DR_OFFSET

◆ US915_MAX_RX1_DR_OFFSET

◆ US915_MIN_TX_POWER

◆ US915_MAX_TX_POWER

◆ US915_DEFAULT_TX_POWER

◆ US915_DEFAULT_MAX_ERP

◆ US915_DUTY_CYCLE_ENABLED

◆ US915_MAX_RX_WINDOW

◆ US915_RX_WND_2_FREQ

◆ US915_RX_WND_2_DR

◆ US915_DEFAULT_UPLINK_DWELL_TIME

◆ US915_BEACON_CHANNEL_FREQ

◆ US915_BEACON_CHANNEL_STEPWIDTH

◆ US915_PING_SLOT_CHANNEL_FREQ

◆ US915_BEACON_NB_CHANNELS

◆ US915_BEACON_SIZE

◆ US915_RFU1_SIZE

◆ US915_RFU2_SIZE

◆ US915_BEACON_CHANNEL_DR

◆ US915_BEACON_CHANNEL_BW

◆ US915_PING_SLOT_CHANNEL_DR

◆ US915_MAX_NB_BANDS

◆ US915_BAND0

◆ US915_FIRST_RX1_CHANNEL

◆ US915_LAST_RX1_CHANNEL

◆ US915_STEPWIDTH_RX1_CHANNEL

Function Documentation

◆ RegionUS915GetPhyParam()

◆ RegionUS915SetBandTxDone()

◆ RegionUS915InitDefaults()

◆ RegionUS915Verify()

◆ RegionUS915ApplyCFList()

◆ RegionUS915ChanMaskSet()

◆ RegionUS915ComputeRxWindowParameters()

◆ RegionUS915RxConfig()

◆ RegionUS915TxConfig()

◆ RegionUS915LinkAdrReq()

◆ RegionUS915RxParamSetupReq()

◆ RegionUS915NewChannelReq()

◆ RegionUS915TxParamSetupReq()

◆ RegionUS915DlChannelReq()

◆ RegionUS915AlternateDr()

◆ RegionUS915NextChannel()

◆ RegionUS915ChannelAdd()

◆ RegionUS915ChannelsRemove()

◆ RegionUS915ApplyDrOffset()

◆ RegionUS915RxBeaconSetup()