SX126x-Arduino  1.2.1
Macros | Functions | Variables
Region IN865

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_DEFAULT_RX1_DR_OFFSET   0
 
#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_ADR_ACK_LIMIT   64
 
#define IN865_ADR_ACK_DELAY   32
 
#define IN865_DUTY_CYCLE_ENABLED   1
 
#define IN865_MAX_RX_WINDOW   3000
 
#define IN865_RECEIVE_DELAY1   1000
 
#define IN865_RECEIVE_DELAY2   2000
 
#define IN865_JOIN_ACCEPT_DELAY1   5000
 
#define IN865_JOIN_ACCEPT_DELAY2   6000
 
#define IN865_MAX_FCNT_GAP   16384
 
#define IN865_ACKTIMEOUT   2000
 
#define IN865_ACK_TIMEOUT_RND   1000
 
#define IN865_RX_WND_2_FREQ   866550000
 
#define IN865_RX_WND_2_DR   DR_2
 
#define IN865_MAX_NB_BANDS   1
 
#define IN865_BAND0
 
#define IN865_LC1
 
#define IN865_LC2
 
#define IN865_LC3
 
#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 (InitType_t type)
 Initializes the channels masks and the channels. 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...
 
bool RegionIN865AdrNext (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 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 (AlternateDrParams_t *alternateDr)
 Alternates the datarate of the channel for the join request. More...
 
void RegionIN865CalcBackOff (CalcBackOffParams_t *calcBackOff)
 Calculates the back-off time. More...
 
bool 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...
 

Variables

static const uint8_t DataratesIN865 [] = {12, 11, 10, 9, 8, 7, 7, 50}
 
static const uint32_t BandwidthsIN865 [] = {125000, 125000, 125000, 125000, 125000, 125000, 250000, 0}
 
static const uint8_t MaxPayloadOfDatarateIN865 [] = {51, 51, 51, 115, 242, 242, 242, 242}
 
static const uint8_t MaxPayloadOfDatarateRepeaterIN865 [] = {51, 51, 51, 115, 222, 222, 222, 222}
 
static const int8_t EffectiveRx1DrOffsetIN865 [] = {0, 1, 2, 3, 4, 5, -1, -2}
 

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_DEFAULT_RX1_DR_OFFSET

#define IN865_DEFAULT_RX1_DR_OFFSET   0

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

#define IN865_ADR_ACK_LIMIT   64

ADR Ack limit

◆ IN865_ADR_ACK_DELAY

#define IN865_ADR_ACK_DELAY   32

ADR Ack delay

◆ IN865_DUTY_CYCLE_ENABLED

#define IN865_DUTY_CYCLE_ENABLED   1

Enabled or disabled the duty cycle

◆ IN865_MAX_RX_WINDOW

#define IN865_MAX_RX_WINDOW   3000

Maximum RX window duration

◆ IN865_RECEIVE_DELAY1

#define IN865_RECEIVE_DELAY1   1000

Receive delay 1

◆ IN865_RECEIVE_DELAY2

#define IN865_RECEIVE_DELAY2   2000

Receive delay 2

◆ IN865_JOIN_ACCEPT_DELAY1

#define IN865_JOIN_ACCEPT_DELAY1   5000

Join accept delay 1

◆ IN865_JOIN_ACCEPT_DELAY2

#define IN865_JOIN_ACCEPT_DELAY2   6000

Join accept delay 2

◆ IN865_MAX_FCNT_GAP

#define IN865_MAX_FCNT_GAP   16384

Maximum frame counter gap

◆ IN865_ACKTIMEOUT

#define IN865_ACKTIMEOUT   2000

Ack timeout

◆ IN865_ACK_TIMEOUT_RND

#define IN865_ACK_TIMEOUT_RND   1000

Random ack timeout limits

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

#define IN865_MAX_NB_BANDS   1

Maximum number of bands

◆ IN865_BAND0

#define IN865_BAND0
Value:
{ \
1, IN865_MAX_TX_POWER, 0, 0 \
}

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

◆ IN865_LC1

#define IN865_LC1
Value:
{ \
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
Value:
{ \
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
Value:
{ \
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
getPhyPointer to the function parameters.
Return values
Returnsa structure containing the PHY parameter.

◆ RegionIN865SetBandTxDone()

void RegionIN865SetBandTxDone ( SetBandTxDoneParams_t txDone)

Updates the last TX done parameters of the current channel.

Parameters
txDonePointer to the function parameters.

◆ RegionIN865InitDefaults()

void RegionIN865InitDefaults ( InitType_t  type)

Initializes the channels masks and the channels.

Parameters
typeSets the initialization type.

◆ RegionIN865Verify()

bool RegionIN865Verify ( VerifyParams_t verify,
PhyAttribute_t  phyAttribute 
)

Verifies a parameter.

Parameters
verifyPointer to the function parameters.
phyAttributeSets the initialization type.
Return values
Returnstrue, 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
applyCFListPointer to the function parameters.

◆ RegionIN865ChanMaskSet()

bool RegionIN865ChanMaskSet ( ChanMaskSetParams_t chanMaskSet)

Sets a channels mask.

Parameters
chanMaskSetPointer to the function parameters.
Return values
Returnstrue, if the channels mask could be set.

◆ RegionIN865AdrNext()

bool RegionIN865AdrNext ( 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
adrNextPointer to the function parameters.
drOutThe calculated datarate for the next TX.
txPowOutThe TX power for the next TX.
adrAckCounterThe calculated ADR acknowledgement counter.
Return values
Returnstrue, if an ADR request should be performed.

◆ RegionIN865ComputeRxWindowParameters()

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

Computes the Rx window timeout and offset.

Parameters
datarateRx window datarate index to be used
minRxSymbolsMinimum required number of symbols to detect an Rx frame.
rxErrorSystem maximum timing error of the receiver. In milliseconds The receiver will turn on in a [-rxError : +rxError] ms interval around RxOffset
rxConfigParamsReturns updated WindowTimeout and WindowOffset fields.

◆ RegionIN865RxConfig()

bool RegionIN865RxConfig ( RxConfigParams_t rxConfig,
int8_t *  datarate 
)

Configuration of the RX windows.

Parameters
rxConfigPointer to the function parameters.
datarateThe datarate index which was set.
Return values
Returnstrue, if the configuration was applied successfully.

◆ RegionIN865TxConfig()

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

TX configuration.

Parameters
txConfigPointer to the function parameters.
txPowerThe tx power index which was set.
txTimeOnAirThe time-on-air of the frame.
Return values
Returnstrue, 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
linkAdrReqPointer to the function parameters.
drOutData rate.
txPowOutTX power.
nbRepOutNumber of repeats.
nbBytesParsedNumber of parsed bytes.
Return values
Returnsthe 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
rxParamSetupReqPointer to the function parameters.
Return values
Returnsthe status of the operation, according to the LoRaMAC specification.

◆ RegionIN865NewChannelReq()

uint8_t RegionIN865NewChannelReq ( NewChannelReqParams_t newChannelReq)

The function processes a Channel Request.

Parameters
newChannelReqPointer to the function parameters.
Return values
Returnsthe status of the operation, according to the LoRaMAC specification.

◆ RegionIN865TxParamSetupReq()

int8_t RegionIN865TxParamSetupReq ( TxParamSetupReqParams_t txParamSetupReq)

The function processes a TX ParamSetup Request.

Parameters
txParamSetupReqPointer to the function parameters.
Return values
Returnsthe 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
dlChannelReqPointer to the function parameters.
Return values
Returnsthe status of the operation, according to the LoRaMAC specification.

◆ RegionIN865AlternateDr()

int8_t RegionIN865AlternateDr ( AlternateDrParams_t alternateDr)

Alternates the datarate of the channel for the join request.

Parameters
alternateDrPointer to the function parameters.
Return values
Datarateto apply.

◆ RegionIN865CalcBackOff()

void RegionIN865CalcBackOff ( CalcBackOffParams_t calcBackOff)

Calculates the back-off time.

Parameters
calcBackOffPointer to the function parameters.

◆ RegionIN865NextChannel()

bool RegionIN865NextChannel ( NextChanParams_t nextChanParams,
uint8_t *  channel,
TimerTime_t time,
TimerTime_t aggregatedTimeOff 
)

Searches and set the next random available channel.

Parameters
nextChanParamsParameters of next channel to use for TX.
channelNext channel to use for TX.
timeTime to wait for the next transmission according to the duty cycle.
aggregatedTimeOffUpdates the aggregated time off.
Return values
Functionstatus [1: OK, 0: Unable to find a channel on the current datarate]

◆ RegionIN865ChannelAdd()

LoRaMacStatus_t RegionIN865ChannelAdd ( ChannelAddParams_t channelAdd)

Adds a channel.

Parameters
channelAddPointer to the function parameters.
Return values
Statusof the operation.

◆ RegionIN865ChannelsRemove()

bool RegionIN865ChannelsRemove ( ChannelRemoveParams_t channelRemove)

Removes a channel.

Parameters
channelRemovePointer to the function parameters.
Return values
Returnstrue, if the channel was removed successfully.

◆ RegionIN865SetContinuousWave()

void RegionIN865SetContinuousWave ( ContinuousWaveParams_t continuousWave)

Sets the radio into continuous wave mode.

Parameters
continuousWavePointer 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
downlinkDwellTimeDownlink dwell time configuration. 0: No limit, 1: 400ms
drCurrent datarate
drOffsetOffset to be applied
Return values
newDrComputed datarate.

Variable Documentation

◆ DataratesIN865

const uint8_t DataratesIN865[] = {12, 11, 10, 9, 8, 7, 7, 50}
static

Data rates table definition

◆ BandwidthsIN865

const uint32_t BandwidthsIN865[] = {125000, 125000, 125000, 125000, 125000, 125000, 250000, 0}
static

Bandwidths table definition in Hz

◆ MaxPayloadOfDatarateIN865

const uint8_t MaxPayloadOfDatarateIN865[] = {51, 51, 51, 115, 242, 242, 242, 242}
static

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

◆ MaxPayloadOfDatarateRepeaterIN865

const uint8_t MaxPayloadOfDatarateRepeaterIN865[] = {51, 51, 51, 115, 222, 222, 222, 222}
static

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

◆ EffectiveRx1DrOffsetIN865

const int8_t EffectiveRx1DrOffsetIN865[] = {0, 1, 2, 3, 4, 5, -1, -2}
static

Effective datarate offsets for receive window 1.

DR_5
#define DR_5
Definition: Region.h:159
DR_0
#define DR_0
Definition: Region.h:79
IN865_MAX_TX_POWER
#define IN865_MAX_TX_POWER
Definition: RegionIN865.h:104