SX126x-Arduino  2.0.1
Macros | Functions | Variables
Region KR920

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

Macros

#define KR920_MAX_NB_CHANNELS   16
 
#define KR920_NUMB_DEFAULT_CHANNELS   7
 
#define KR920_NUMB_CHANNELS_CF_LIST   5
 
#define KR920_TX_MIN_DATARATE   DR_0
 
#define KR920_TX_MAX_DATARATE   DR_5
 
#define KR920_RX_MIN_DATARATE   DR_0
 
#define KR920_RX_MAX_DATARATE   DR_5
 
#define KR920_DEFAULT_DATARATE   DR_0
 
#define KR920_MIN_RX1_DR_OFFSET   0
 
#define KR920_MAX_RX1_DR_OFFSET   5
 
#define KR920_DEFAULT_RX1_DR_OFFSET   0
 
#define KR920_MIN_TX_POWER   TX_POWER_7
 
#define KR920_MAX_TX_POWER   TX_POWER_0
 
#define KR920_DEFAULT_TX_POWER   TX_POWER_0
 
#define KR920_DEFAULT_MAX_EIRP_LOW   10.0f
 
#define KR920_DEFAULT_MAX_EIRP_HIGH   14.0f
 
#define KR920_DEFAULT_ANTENNA_GAIN   2.15f
 
#define KR920_ADR_ACK_LIMIT   64
 
#define KR920_ADR_ACK_DELAY   32
 
#define KR920_DUTY_CYCLE_ENABLED   0
 
#define KR920_MAX_RX_WINDOW   4000
 
#define KR920_RECEIVE_DELAY1   1000
 
#define KR920_RECEIVE_DELAY2   2000
 
#define KR920_JOIN_ACCEPT_DELAY1   5000
 
#define KR920_JOIN_ACCEPT_DELAY2   6000
 
#define KR920_MAX_FCNT_GAP   16384
 
#define KR920_ACKTIMEOUT   2000
 
#define KR920_ACK_TIMEOUT_RND   1000
 
#define KR920_RX_WND_2_FREQ   921900000
 
#define KR920_RX_WND_2_DR   DR_0
 
#define KR920_MAX_NB_BANDS   1
 
#define KR920_BAND0
 
#define KR920_LC1
 
#define KR920_LC2
 
#define KR920_LC3
 
#define KR920_LC4
 
#define KR920_LC5
 
#define KR920_LC6
 
#define KR920_LC7
 
#define KR920_JOIN_CHANNELS   (uint16_t)(LC(1) | LC(2) | LC(3))
 
#define KR920_RSSI_FREE_TH   -65
 
#define KR920_CARRIER_SENSE_TIME   6
 

Functions

PhyParam_t RegionKR920GetPhyParam (GetPhyParams_t *getPhy)
 The function gets a value of a specific phy attribute. More...
 
void RegionKR920SetBandTxDone (SetBandTxDoneParams_t *txDone)
 Updates the last TX done parameters of the current channel. More...
 
void RegionKR920InitDefaults (InitType_t type)
 Initializes the channels masks and the channels. More...
 
bool RegionKR920Verify (VerifyParams_t *verify, PhyAttribute_t phyAttribute)
 Verifies a parameter. More...
 
void RegionKR920ApplyCFList (ApplyCFListParams_t *applyCFList)
 The function parses the input buffer and sets up the channels of the CF list. More...
 
bool RegionKR920ChanMaskSet (ChanMaskSetParams_t *chanMaskSet)
 Sets a channels mask. More...
 
bool RegionKR920AdrNext (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 RegionKR920ComputeRxWindowParameters (int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
 
bool RegionKR920RxConfig (RxConfigParams_t *rxConfig, int8_t *datarate)
 Configuration of the RX windows. More...
 
bool RegionKR920TxConfig (TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
 TX configuration. More...
 
uint8_t RegionKR920LinkAdrReq (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 RegionKR920RxParamSetupReq (RxParamSetupReqParams_t *rxParamSetupReq)
 The function processes a RX Parameter Setup Request. More...
 
uint8_t RegionKR920NewChannelReq (NewChannelReqParams_t *newChannelReq)
 The function processes a Channel Request. More...
 
int8_t RegionKR920TxParamSetupReq (TxParamSetupReqParams_t *txParamSetupReq)
 The function processes a TX ParamSetup Request. More...
 
uint8_t RegionKR920DlChannelReq (DlChannelReqParams_t *dlChannelReq)
 The function processes a DlChannel Request. More...
 
int8_t RegionKR920AlternateDr (AlternateDrParams_t *alternateDr)
 Alternates the datarate of the channel for the join request. More...
 
void RegionKR920CalcBackOff (CalcBackOffParams_t *calcBackOff)
 Calculates the back-off time. More...
 
bool RegionKR920NextChannel (NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
 Searches and set the next random available channel. More...
 
LoRaMacStatus_t RegionKR920ChannelAdd (ChannelAddParams_t *channelAdd)
 Adds a channel. More...
 
bool RegionKR920ChannelsRemove (ChannelRemoveParams_t *channelRemove)
 Removes a channel. More...
 
void RegionKR920SetContinuousWave (ContinuousWaveParams_t *continuousWave)
 Sets the radio into continuous wave mode. More...
 
uint8_t RegionKR920ApplyDrOffset (uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
 Computes new datarate according to the given offset. More...
 

Variables

static const uint8_t DataratesKR920 [] = {12, 11, 10, 9, 8, 7}
 
static const uint32_t BandwidthsKR920 [] = {125000, 125000, 125000, 125000, 125000, 125000}
 
static const uint8_t MaxPayloadOfDatarateKR920 [] = {51, 51, 51, 115, 242, 242}
 
static const uint8_t MaxPayloadOfDatarateRepeaterKR920 [] = {51, 51, 51, 115, 222, 222}
 

Detailed Description

Implementation according to LoRaWAN Specification v1.0.2.

Macro Definition Documentation

◆ KR920_MAX_NB_CHANNELS

#define KR920_MAX_NB_CHANNELS   16

LoRaMac maximum number of channels

◆ KR920_NUMB_DEFAULT_CHANNELS

#define KR920_NUMB_DEFAULT_CHANNELS   7

Number of default channels

◆ KR920_NUMB_CHANNELS_CF_LIST

#define KR920_NUMB_CHANNELS_CF_LIST   5

Number of channels to apply for the CF list

◆ KR920_TX_MIN_DATARATE

#define KR920_TX_MIN_DATARATE   DR_0

Minimal datarate that can be used by the node

◆ KR920_TX_MAX_DATARATE

#define KR920_TX_MAX_DATARATE   DR_5

Maximal datarate that can be used by the node

◆ KR920_RX_MIN_DATARATE

#define KR920_RX_MIN_DATARATE   DR_0

Minimal datarate that can be used by the node

◆ KR920_RX_MAX_DATARATE

#define KR920_RX_MAX_DATARATE   DR_5

Maximal datarate that can be used by the node

◆ KR920_DEFAULT_DATARATE

#define KR920_DEFAULT_DATARATE   DR_0

Default datarate used by the node

◆ KR920_MIN_RX1_DR_OFFSET

#define KR920_MIN_RX1_DR_OFFSET   0

Minimal Rx1 receive datarate offset

◆ KR920_MAX_RX1_DR_OFFSET

#define KR920_MAX_RX1_DR_OFFSET   5

Maximal Rx1 receive datarate offset

◆ KR920_DEFAULT_RX1_DR_OFFSET

#define KR920_DEFAULT_RX1_DR_OFFSET   0

Default Rx1 receive datarate offset

◆ KR920_MIN_TX_POWER

#define KR920_MIN_TX_POWER   TX_POWER_7

Minimal Tx output power that can be used by the node

◆ KR920_MAX_TX_POWER

#define KR920_MAX_TX_POWER   TX_POWER_0

Maximal Tx output power that can be used by the node

◆ KR920_DEFAULT_TX_POWER

#define KR920_DEFAULT_TX_POWER   TX_POWER_0

Default Tx output power used by the node

◆ KR920_DEFAULT_MAX_EIRP_LOW

#define KR920_DEFAULT_MAX_EIRP_LOW   10.0f

Default Max EIRP for frequency 920.9 MHz - 921.9 MHz

◆ KR920_DEFAULT_MAX_EIRP_HIGH

#define KR920_DEFAULT_MAX_EIRP_HIGH   14.0f

Default Max EIRP for frequency 922.1 MHz - 923.3 MHz

◆ KR920_DEFAULT_ANTENNA_GAIN

#define KR920_DEFAULT_ANTENNA_GAIN   2.15f

Default antenna gain

◆ KR920_ADR_ACK_LIMIT

#define KR920_ADR_ACK_LIMIT   64

ADR Ack limit

◆ KR920_ADR_ACK_DELAY

#define KR920_ADR_ACK_DELAY   32

ADR Ack delay

◆ KR920_DUTY_CYCLE_ENABLED

#define KR920_DUTY_CYCLE_ENABLED   0

Enabled or disabled the duty cycle

◆ KR920_MAX_RX_WINDOW

#define KR920_MAX_RX_WINDOW   4000

Maximum RX window duration

◆ KR920_RECEIVE_DELAY1

#define KR920_RECEIVE_DELAY1   1000

Receive delay 1

◆ KR920_RECEIVE_DELAY2

#define KR920_RECEIVE_DELAY2   2000

Receive delay 2

◆ KR920_JOIN_ACCEPT_DELAY1

#define KR920_JOIN_ACCEPT_DELAY1   5000

Join accept delay 1

◆ KR920_JOIN_ACCEPT_DELAY2

#define KR920_JOIN_ACCEPT_DELAY2   6000

Join accept delay 2

◆ KR920_MAX_FCNT_GAP

#define KR920_MAX_FCNT_GAP   16384

Maximum frame counter gap

◆ KR920_ACKTIMEOUT

#define KR920_ACKTIMEOUT   2000

Ack timeout

◆ KR920_ACK_TIMEOUT_RND

#define KR920_ACK_TIMEOUT_RND   1000

Random ack timeout limits

◆ KR920_RX_WND_2_FREQ

#define KR920_RX_WND_2_FREQ   921900000

Second reception window channel frequency definition.

◆ KR920_RX_WND_2_DR

#define KR920_RX_WND_2_DR   DR_0

Second reception window channel datarate definition.

◆ KR920_MAX_NB_BANDS

#define KR920_MAX_NB_BANDS   1

Maximum number of bands

◆ KR920_BAND0

#define KR920_BAND0
Value:
{ \
1, KR920_MAX_TX_POWER, 0, 0 \
}

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

◆ KR920_LC1

#define KR920_LC1
Value:
{ \
922100000, 0, {((DR_5 << 4) | DR_0)}, 0 \
}

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

◆ KR920_LC2

#define KR920_LC2
Value:
{ \
922300000, 0, {((DR_5 << 4) | DR_0)}, 0 \
}

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

◆ KR920_LC3

#define KR920_LC3
Value:
{ \
922500000, 0, {((DR_5 << 4) | DR_0)}, 0 \
}

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

◆ KR920_LC4

#define KR920_LC4
Value:
{ \
922700000, 0, {((DR_5 << 4) | DR_0)}, 0 \
}

◆ KR920_LC5

#define KR920_LC5
Value:
{ \
922900000, 0, {((DR_5 << 4) | DR_0)}, 0 \
}

◆ KR920_LC6

#define KR920_LC6
Value:
{ \
923100000, 0, {((DR_5 << 4) | DR_0)}, 0 \
}

◆ KR920_LC7

#define KR920_LC7
Value:
{ \
923300000, 0, {((DR_5 << 4) | DR_0)}, 0 \
}

◆ KR920_JOIN_CHANNELS

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

LoRaMac channels which are allowed for the join procedure

◆ KR920_RSSI_FREE_TH

#define KR920_RSSI_FREE_TH   -65

RSSI threshold for a free channel [dBm]

◆ KR920_CARRIER_SENSE_TIME

#define KR920_CARRIER_SENSE_TIME   6

Specifies the time the node performs a carrier sense

Function Documentation

◆ RegionKR920GetPhyParam()

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

◆ RegionKR920SetBandTxDone()

void RegionKR920SetBandTxDone ( SetBandTxDoneParams_t txDone)

Updates the last TX done parameters of the current channel.

Parameters
txDonePointer to the function parameters.

◆ RegionKR920InitDefaults()

void RegionKR920InitDefaults ( InitType_t  type)

Initializes the channels masks and the channels.

Parameters
typeSets the initialization type.

◆ RegionKR920Verify()

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

◆ RegionKR920ApplyCFList()

void RegionKR920ApplyCFList ( ApplyCFListParams_t applyCFList)

The function parses the input buffer and sets up the channels of the CF list.

Parameters
applyCFListPointer to the function parameters.

◆ RegionKR920ChanMaskSet()

bool RegionKR920ChanMaskSet ( ChanMaskSetParams_t chanMaskSet)

Sets a channels mask.

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

◆ RegionKR920AdrNext()

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

◆ RegionKR920ComputeRxWindowParameters()

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

◆ RegionKR920RxConfig()

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

◆ RegionKR920TxConfig()

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

◆ RegionKR920LinkAdrReq()

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

◆ RegionKR920RxParamSetupReq()

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

◆ RegionKR920NewChannelReq()

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

◆ RegionKR920TxParamSetupReq()

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

◆ RegionKR920DlChannelReq()

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

◆ RegionKR920AlternateDr()

int8_t RegionKR920AlternateDr ( AlternateDrParams_t alternateDr)

Alternates the datarate of the channel for the join request.

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

◆ RegionKR920CalcBackOff()

void RegionKR920CalcBackOff ( CalcBackOffParams_t calcBackOff)

Calculates the back-off time.

Parameters
calcBackOffPointer to the function parameters.

◆ RegionKR920NextChannel()

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

◆ RegionKR920ChannelAdd()

LoRaMacStatus_t RegionKR920ChannelAdd ( ChannelAddParams_t channelAdd)

Adds a channel.

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

◆ RegionKR920ChannelsRemove()

bool RegionKR920ChannelsRemove ( ChannelRemoveParams_t channelRemove)

Removes a channel.

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

◆ RegionKR920SetContinuousWave()

void RegionKR920SetContinuousWave ( ContinuousWaveParams_t continuousWave)

Sets the radio into continuous wave mode.

Parameters
continuousWavePointer to the function parameters.

◆ RegionKR920ApplyDrOffset()

uint8_t RegionKR920ApplyDrOffset ( 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

◆ DataratesKR920

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

Data rates table definition

◆ BandwidthsKR920

const uint32_t BandwidthsKR920[] = {125000, 125000, 125000, 125000, 125000, 125000}
static

Bandwidths table definition in Hz

◆ MaxPayloadOfDatarateKR920

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

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

◆ MaxPayloadOfDatarateRepeaterKR920

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

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

KR920_MAX_TX_POWER
#define KR920_MAX_TX_POWER
Definition: RegionKR920.h:104
DR_5
#define DR_5
Definition: Region.h:179
DR_0
#define DR_0
Definition: Region.h:84