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_DEFAULT_RX1_DR_OFFSET 0

#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_ADR_ACK_LIMIT 64

#define	US915_ADR_ACK_DELAY 32

#define	US915_DUTY_CYCLE_ENABLED 0

#define	US915_MAX_RX_WINDOW 3000

#define	US915_RECEIVE_DELAY1 1000

#define	US915_RECEIVE_DELAY2 2000

#define	US915_JOIN_ACCEPT_DELAY1 5000

#define	US915_JOIN_ACCEPT_DELAY2 6000

#define	US915_MAX_FCNT_GAP 16384

#define	US915_ACKTIMEOUT 2000

#define	US915_ACK_TIMEOUT_RND 1000

#define	US915_RX_WND_2_FREQ 923300000

#define	US915_RX_WND_2_DR DR_8

#define	US915_MAX_NB_BANDS 1

#define	US915_BAND0

#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 (InitType_t type)
	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...

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

uint8_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...

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

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

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

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

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

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

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

static const uint32_t	BandwidthsUS915 [] = {125000, 125000, 125000, 125000, 500000, 0, 0, 0, 500000, 500000, 500000, 500000, 500000, 500000, 0, 0}

static const int8_t	DatarateOffsetsUS915 [5][4]

static const uint8_t	MaxPayloadOfDatarateUS915 [] = {11, 53, 125, 242, 242, 0, 0, 0, 53, 129, 242, 242, 242, 242, 0, 0}

static const uint8_t	MaxPayloadOfDatarateRepeaterUS915 [] = {11, 53, 125, 242, 242, 0, 0, 0, 33, 109, 222, 222, 222, 222, 0, 0}

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_DEFAULT_RX1_DR_OFFSET

#define US915_DEFAULT_RX1_DR_OFFSET 0

Default 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_ADR_ACK_LIMIT

#define US915_ADR_ACK_LIMIT 64

ADR Ack limit

◆ US915_ADR_ACK_DELAY

#define US915_ADR_ACK_DELAY 32

ADR Ack delay

◆ 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_RECEIVE_DELAY1

#define US915_RECEIVE_DELAY1 1000

Receive delay 1

◆ US915_RECEIVE_DELAY2

#define US915_RECEIVE_DELAY2 2000

Receive delay 2

◆ US915_JOIN_ACCEPT_DELAY1

#define US915_JOIN_ACCEPT_DELAY1 5000

Join accept delay 1

◆ US915_JOIN_ACCEPT_DELAY2

#define US915_JOIN_ACCEPT_DELAY2 6000

Join accept delay 2

◆ US915_MAX_FCNT_GAP

#define US915_MAX_FCNT_GAP 16384

Maximum frame counter gap

◆ US915_ACKTIMEOUT

#define US915_ACKTIMEOUT 2000

Ack timeout

◆ US915_ACK_TIMEOUT_RND

#define US915_ACK_TIMEOUT_RND 1000

Random ack timeout limits

◆ 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_MAX_NB_BANDS

#define US915_MAX_NB_BANDS 1

LoRaMac maximum number of bands

◆ US915_BAND0

#define US915_BAND0

Value:

    {                               \
        1, US915_MAX_TX_POWER, 0, 0 \
    }

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

◆ 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

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

txDone Pointer to the function parameters.

◆ RegionUS915InitDefaults()

void RegionUS915InitDefaults ( InitType_t type )

Initializes the channels masks and the channels.

Parameters

type	Sets the initialization type.

◆ RegionUS915Verify()

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

◆ RegionUS915ApplyCFList()

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

◆ RegionUS915ChanMaskSet()

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

◆ RegionUS915AdrNext()

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

◆ RegionUS915ComputeRxWindowParameters()

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

◆ RegionUS915RxConfig()

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

◆ RegionUS915TxConfig()

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

◆ 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

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.

◆ RegionUS915RxParamSetupReq()

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

◆ RegionUS915NewChannelReq()

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

◆ RegionUS915TxParamSetupReq()

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

◆ RegionUS915DlChannelReq()

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

◆ RegionUS915AlternateDr()

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

◆ RegionUS915CalcBackOff()

void RegionUS915CalcBackOff ( CalcBackOffParams_t * calcBackOff )

Calculates the back-off time.

Parameters

calcBackOff Pointer to the function parameters.

◆ RegionUS915NextChannel()

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

◆ RegionUS915ChannelAdd()

LoRaMacStatus_t RegionUS915ChannelAdd ( ChannelAddParams_t * channelAdd )

Adds a channel.

Parameters

channelAdd Pointer to the function parameters.

Return values

Status of the operation.

◆ RegionUS915ChannelsRemove()

bool RegionUS915ChannelsRemove ( ChannelRemoveParams_t * channelRemove )

Removes a channel.

Parameters

channelRemove Pointer to the function parameters.

Return values

Returns true, if the channel was removed successfully.

◆ RegionUS915SetContinuousWave()

void RegionUS915SetContinuousWave ( ContinuousWaveParams_t * continuousWave )

Sets the radio into continuous wave mode.

Parameters

continuousWave Pointer to the function parameters.

◆ RegionUS915ApplyDrOffset()

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

Variable Documentation

◆ DataratesUS915

const uint8_t DataratesUS915[] = {10, 9, 8, 7, 8, 0, 0, 0, 12, 11, 10, 9, 8, 7, 0, 0}

static

Data rates table definition

◆ BandwidthsUS915

const uint32_t BandwidthsUS915[] = {125000, 125000, 125000, 125000, 500000, 0, 0, 0, 500000, 500000, 500000, 500000, 500000, 500000, 0, 0}

static

Bandwidths table definition in Hz

◆ DatarateOffsetsUS915

const int8_t DatarateOffsetsUS915[5][4]

static

Initial value:

=
        {
            {DR_10, DR_9, DR_8, DR_8},    
            {DR_11, DR_10, DR_9, DR_8},   
            {DR_12, DR_11, DR_10, DR_9},  
            {DR_13, DR_12, DR_11, DR_10}, 
            {DR_13, DR_13, DR_12, DR_11}, 
    }

Up/Down link data rates offset definition

◆ MaxPayloadOfDatarateUS915

const uint8_t MaxPayloadOfDatarateUS915[] = {11, 53, 125, 242, 242, 0, 0, 0, 53, 129, 242, 242, 242, 242, 0, 0}

static

Maximum payload with respect to the datarate index. Cannot operate with repeater.

◆ MaxPayloadOfDatarateRepeaterUS915

const uint8_t MaxPayloadOfDatarateRepeaterUS915[] = {11, 53, 125, 242, 242, 0, 0, 0, 33, 109, 222, 222, 222, 222, 0, 0}

static

Maximum payload with respect to the datarate index. Can operate with repeater.

Macros

Functions

Variables

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_DEFAULT_RX1_DR_OFFSET

◆ US915_MIN_TX_POWER

◆ US915_MAX_TX_POWER

◆ US915_DEFAULT_TX_POWER

◆ US915_DEFAULT_MAX_ERP

◆ US915_ADR_ACK_LIMIT

◆ US915_ADR_ACK_DELAY

◆ US915_DUTY_CYCLE_ENABLED

◆ US915_MAX_RX_WINDOW

◆ US915_RECEIVE_DELAY1

◆ US915_RECEIVE_DELAY2

◆ US915_JOIN_ACCEPT_DELAY1

◆ US915_JOIN_ACCEPT_DELAY2

◆ US915_MAX_FCNT_GAP

◆ US915_ACKTIMEOUT

◆ US915_ACK_TIMEOUT_RND

◆ US915_RX_WND_2_FREQ

◆ US915_RX_WND_2_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()

◆ RegionUS915AdrNext()

◆ RegionUS915ComputeRxWindowParameters()

◆ RegionUS915RxConfig()

◆ RegionUS915TxConfig()

◆ RegionUS915LinkAdrReq()

◆ RegionUS915RxParamSetupReq()

◆ RegionUS915NewChannelReq()

◆ RegionUS915TxParamSetupReq()

◆ RegionUS915DlChannelReq()

◆ RegionUS915AlternateDr()

◆ RegionUS915CalcBackOff()

◆ RegionUS915NextChannel()

◆ RegionUS915ChannelAdd()

◆ RegionUS915ChannelsRemove()

◆ RegionUS915SetContinuousWave()

◆ RegionUS915ApplyDrOffset()

Variable Documentation

◆ DataratesUS915

◆ BandwidthsUS915

◆ DatarateOffsetsUS915

◆ MaxPayloadOfDatarateUS915

◆ MaxPayloadOfDatarateRepeaterUS915