SX126x-Arduino  2.0.1
Macros | Functions | Variables
Region CN470

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

Macros

#define CN470_MAX_NB_CHANNELS   96
 
#define CN470_TX_MIN_DATARATE   DR_0
 
#define CN470_TX_MAX_DATARATE   DR_5
 
#define CN470_RX_MIN_DATARATE   DR_0
 
#define CN470_RX_MAX_DATARATE   DR_5
 
#define CN470_DEFAULT_DATARATE   DR_0
 
#define CN470_MIN_RX1_DR_OFFSET   0
 
#define CN470_MAX_RX1_DR_OFFSET   3
 
#define CN470_DEFAULT_RX1_DR_OFFSET   0
 
#define CN470_MIN_TX_POWER   TX_POWER_7
 
#define CN470_MAX_TX_POWER   TX_POWER_0
 
#define CN470_DEFAULT_TX_POWER   TX_POWER_0
 
#define CN470_DEFAULT_MAX_EIRP   19.15f
 
#define CN470_DEFAULT_ANTENNA_GAIN   2.15f
 
#define CN470_ADR_ACK_LIMIT   64
 
#define CN470_ADR_ACK_DELAY   32
 
#define CN470_DUTY_CYCLE_ENABLED   0
 
#define CN470_MAX_RX_WINDOW   3000
 
#define CN470_RECEIVE_DELAY1   1000
 
#define CN470_RECEIVE_DELAY2   2000
 
#define CN470_JOIN_ACCEPT_DELAY1   5000
 
#define CN470_JOIN_ACCEPT_DELAY2   6000
 
#define CN470_MAX_FCNT_GAP   16384
 
#define CN470_ACKTIMEOUT   2000
 
#define CN470_ACK_TIMEOUT_RND   1000
 
#define CN470_RX_WND_2_FREQ   505300000
 
#define CN470_RX_WND_2_DR   DR_0
 
#define CN470_MAX_NB_BANDS   1
 
#define CN470_BAND0
 
#define CN470_FIRST_RX1_CHANNEL   ((uint32_t)500300000)
 
#define CN470_LAST_RX1_CHANNEL   ((uint32_t)509700000)
 
#define CN470_STEPWIDTH_RX1_CHANNEL   ((uint32_t)200000)
 

Functions

PhyParam_t RegionCN470GetPhyParam (GetPhyParams_t *getPhy)
 The function gets a value of a specific phy attribute. More...
 
void RegionCN470SetBandTxDone (SetBandTxDoneParams_t *txDone)
 Updates the last TX done parameters of the current channel. More...
 
void RegionCN470InitDefaults (InitType_t type)
 Initializes the channels masks and the channels. More...
 
bool RegionCN470Verify (VerifyParams_t *verify, PhyAttribute_t phyAttribute)
 Verifies a parameter. More...
 
void RegionCN470ApplyCFList (ApplyCFListParams_t *applyCFList)
 The function parses the input buffer and sets up the channels of the CF list. More...
 
bool RegionCN470ChanMaskSet (ChanMaskSetParams_t *chanMaskSet)
 Sets a channels mask. More...
 
bool RegionCN470AdrNext (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 RegionCN470ComputeRxWindowParameters (int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
 
bool RegionCN470RxConfig (RxConfigParams_t *rxConfig, int8_t *datarate)
 Configuration of the RX windows. More...
 
bool RegionCN470TxConfig (TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
 TX configuration. More...
 
uint8_t RegionCN470LinkAdrReq (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 RegionCN470RxParamSetupReq (RxParamSetupReqParams_t *rxParamSetupReq)
 The function processes a RX Parameter Setup Request. More...
 
uint8_t RegionCN470NewChannelReq (NewChannelReqParams_t *newChannelReq)
 The function processes a Channel Request. More...
 
int8_t RegionCN470TxParamSetupReq (TxParamSetupReqParams_t *txParamSetupReq)
 The function processes a TX ParamSetup Request. More...
 
uint8_t RegionCN470DlChannelReq (DlChannelReqParams_t *dlChannelReq)
 The function processes a DlChannel Request. More...
 
int8_t RegionCN470AlternateDr (AlternateDrParams_t *alternateDr)
 Alternates the datarate of the channel for the join request. More...
 
void RegionCN470CalcBackOff (CalcBackOffParams_t *calcBackOff)
 Calculates the back-off time. More...
 
bool RegionCN470NextChannel (NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
 Searches and set the next random available channel. More...
 
LoRaMacStatus_t RegionCN470ChannelAdd (ChannelAddParams_t *channelAdd)
 Adds a channel. More...
 
bool RegionCN470ChannelsRemove (ChannelRemoveParams_t *channelRemove)
 Removes a channel. More...
 
void RegionCN470SetContinuousWave (ContinuousWaveParams_t *continuousWave)
 Sets the radio into continuous wave mode. More...
 
uint8_t RegionCN470ApplyDrOffset (uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
 Computes new datarate according to the given offset. More...
 

Variables

static const uint8_t DataratesCN470 [] = {12, 11, 10, 9, 8, 7}
 
static const uint32_t BandwidthsCN470 [] = {125000, 125000, 125000, 125000, 125000, 125000}
 
static const uint8_t MaxPayloadOfDatarateCN470 [] = {51, 51, 51, 115, 222, 222}
 
static const uint8_t MaxPayloadOfDatarateRepeaterCN470 [] = {51, 51, 51, 115, 222, 222}
 

Detailed Description

Implementation according to LoRaWAN Specification v1.0.2.

Macro Definition Documentation

◆ CN470_MAX_NB_CHANNELS

#define CN470_MAX_NB_CHANNELS   96

LoRaMac maximum number of channels

◆ CN470_TX_MIN_DATARATE

#define CN470_TX_MIN_DATARATE   DR_0

Minimal datarate that can be used by the node

◆ CN470_TX_MAX_DATARATE

#define CN470_TX_MAX_DATARATE   DR_5

Maximal datarate that can be used by the node

◆ CN470_RX_MIN_DATARATE

#define CN470_RX_MIN_DATARATE   DR_0

Minimal datarate that can be used by the node

◆ CN470_RX_MAX_DATARATE

#define CN470_RX_MAX_DATARATE   DR_5

Maximal datarate that can be used by the node

◆ CN470_DEFAULT_DATARATE

#define CN470_DEFAULT_DATARATE   DR_0

Default datarate used by the node

◆ CN470_MIN_RX1_DR_OFFSET

#define CN470_MIN_RX1_DR_OFFSET   0

Minimal Rx1 receive datarate offset

◆ CN470_MAX_RX1_DR_OFFSET

#define CN470_MAX_RX1_DR_OFFSET   3

Maximal Rx1 receive datarate offset

◆ CN470_DEFAULT_RX1_DR_OFFSET

#define CN470_DEFAULT_RX1_DR_OFFSET   0

Default Rx1 receive datarate offset

◆ CN470_MIN_TX_POWER

#define CN470_MIN_TX_POWER   TX_POWER_7

Minimal Tx output power that can be used by the node

◆ CN470_MAX_TX_POWER

#define CN470_MAX_TX_POWER   TX_POWER_0

Maximal Tx output power that can be used by the node

◆ CN470_DEFAULT_TX_POWER

#define CN470_DEFAULT_TX_POWER   TX_POWER_0

Default Tx output power used by the node

◆ CN470_DEFAULT_MAX_EIRP

#define CN470_DEFAULT_MAX_EIRP   19.15f

Default Max EIRP

◆ CN470_DEFAULT_ANTENNA_GAIN

#define CN470_DEFAULT_ANTENNA_GAIN   2.15f

Default antenna gain

◆ CN470_ADR_ACK_LIMIT

#define CN470_ADR_ACK_LIMIT   64

ADR Ack limit

◆ CN470_ADR_ACK_DELAY

#define CN470_ADR_ACK_DELAY   32

ADR Ack delay

◆ CN470_DUTY_CYCLE_ENABLED

#define CN470_DUTY_CYCLE_ENABLED   0

Enabled or disabled the duty cycle

◆ CN470_MAX_RX_WINDOW

#define CN470_MAX_RX_WINDOW   3000

Maximum RX window duration

◆ CN470_RECEIVE_DELAY1

#define CN470_RECEIVE_DELAY1   1000

Receive delay 1

◆ CN470_RECEIVE_DELAY2

#define CN470_RECEIVE_DELAY2   2000

Receive delay 2

◆ CN470_JOIN_ACCEPT_DELAY1

#define CN470_JOIN_ACCEPT_DELAY1   5000

Join accept delay 1

◆ CN470_JOIN_ACCEPT_DELAY2

#define CN470_JOIN_ACCEPT_DELAY2   6000

Join accept delay 2

◆ CN470_MAX_FCNT_GAP

#define CN470_MAX_FCNT_GAP   16384

Maximum frame counter gap

◆ CN470_ACKTIMEOUT

#define CN470_ACKTIMEOUT   2000

Ack timeout

◆ CN470_ACK_TIMEOUT_RND

#define CN470_ACK_TIMEOUT_RND   1000

Random ack timeout limits

◆ CN470_RX_WND_2_FREQ

#define CN470_RX_WND_2_FREQ   505300000

Second reception window channel frequency definition.

◆ CN470_RX_WND_2_DR

#define CN470_RX_WND_2_DR   DR_0

Second reception window channel datarate definition.

◆ CN470_MAX_NB_BANDS

#define CN470_MAX_NB_BANDS   1

LoRaMac maximum number of bands

◆ CN470_BAND0

#define CN470_BAND0
Value:
{ \
1, CN470_MAX_TX_POWER, 0, 0 \
}

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

◆ CN470_FIRST_RX1_CHANNEL

#define CN470_FIRST_RX1_CHANNEL   ((uint32_t)500300000)

Defines the first channel for RX window 1 for CN470 band

◆ CN470_LAST_RX1_CHANNEL

#define CN470_LAST_RX1_CHANNEL   ((uint32_t)509700000)

Defines the last channel for RX window 1 for CN470 band

◆ CN470_STEPWIDTH_RX1_CHANNEL

#define CN470_STEPWIDTH_RX1_CHANNEL   ((uint32_t)200000)

Defines the step width of the channels for RX window 1

Function Documentation

◆ RegionCN470GetPhyParam()

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

◆ RegionCN470SetBandTxDone()

void RegionCN470SetBandTxDone ( SetBandTxDoneParams_t txDone)

Updates the last TX done parameters of the current channel.

Parameters
txDonePointer to the function parameters.

◆ RegionCN470InitDefaults()

void RegionCN470InitDefaults ( InitType_t  type)

Initializes the channels masks and the channels.

Parameters
typeSets the initialization type.

◆ RegionCN470Verify()

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

◆ RegionCN470ApplyCFList()

void RegionCN470ApplyCFList ( ApplyCFListParams_t applyCFList)

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

Parameters
applyCFListPointer to the function parameters.

◆ RegionCN470ChanMaskSet()

bool RegionCN470ChanMaskSet ( ChanMaskSetParams_t chanMaskSet)

Sets a channels mask.

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

◆ RegionCN470AdrNext()

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

◆ RegionCN470ComputeRxWindowParameters()

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

◆ RegionCN470RxConfig()

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

◆ RegionCN470TxConfig()

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

◆ RegionCN470LinkAdrReq()

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

◆ RegionCN470RxParamSetupReq()

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

◆ RegionCN470NewChannelReq()

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

◆ RegionCN470TxParamSetupReq()

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

◆ RegionCN470DlChannelReq()

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

◆ RegionCN470AlternateDr()

int8_t RegionCN470AlternateDr ( AlternateDrParams_t alternateDr)

Alternates the datarate of the channel for the join request.

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

◆ RegionCN470CalcBackOff()

void RegionCN470CalcBackOff ( CalcBackOffParams_t calcBackOff)

Calculates the back-off time.

Parameters
calcBackOffPointer to the function parameters.

◆ RegionCN470NextChannel()

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

◆ RegionCN470ChannelAdd()

LoRaMacStatus_t RegionCN470ChannelAdd ( ChannelAddParams_t channelAdd)

Adds a channel.

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

◆ RegionCN470ChannelsRemove()

bool RegionCN470ChannelsRemove ( ChannelRemoveParams_t channelRemove)

Removes a channel.

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

◆ RegionCN470SetContinuousWave()

void RegionCN470SetContinuousWave ( ContinuousWaveParams_t continuousWave)

Sets the radio into continuous wave mode.

Parameters
continuousWavePointer to the function parameters.

◆ RegionCN470ApplyDrOffset()

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

◆ DataratesCN470

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

Data rates table definition

◆ BandwidthsCN470

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

Bandwidths table definition in Hz

◆ MaxPayloadOfDatarateCN470

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

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

◆ MaxPayloadOfDatarateRepeaterCN470

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

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

CN470_MAX_TX_POWER
#define CN470_MAX_TX_POWER
Definition: RegionCN470.h:94