LoRaMAC  4.6.0
Documentation of the API
Region CN779

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

Macros

#define CN779_MAX_NB_CHANNELS   16
 
#define CN779_NUMB_DEFAULT_CHANNELS   3
 
#define CN779_NUMB_CHANNELS_CF_LIST   5
 
#define CN779_TX_MIN_DATARATE   DR_0
 
#define CN779_TX_MAX_DATARATE   DR_7
 
#define CN779_RX_MIN_DATARATE   DR_0
 
#define CN779_RX_MAX_DATARATE   DR_7
 
#define CN779_DEFAULT_DATARATE   DR_0
 
#define CN779_MIN_RX1_DR_OFFSET   0
 
#define CN779_MAX_RX1_DR_OFFSET   5
 
#define CN779_MIN_TX_POWER   TX_POWER_5
 
#define CN779_MAX_TX_POWER   TX_POWER_0
 
#define CN779_DEFAULT_TX_POWER   TX_POWER_0
 
#define CN779_DEFAULT_MAX_EIRP   12.15f
 
#define CN779_DEFAULT_ANTENNA_GAIN   2.15f
 
#define CN779_DUTY_CYCLE_ENABLED   1
 
#define CN779_MAX_RX_WINDOW   3000
 
#define CN779_RX_WND_2_FREQ   786000000
 
#define CN779_RX_WND_2_DR   DR_0
 
#define CN779_DEFAULT_UPLINK_DWELL_TIME   0
 
#define CN779_BEACON_CHANNEL_FREQ   785000000
 
#define CN779_PING_SLOT_CHANNEL_FREQ   785000000
 
#define CN779_BEACON_SIZE   17
 
#define CN779_RFU1_SIZE   1
 
#define CN779_RFU2_SIZE   0
 
#define CN779_BEACON_CHANNEL_DR   DR_3
 
#define CN779_BEACON_CHANNEL_BW   0
 
#define CN779_PING_SLOT_CHANNEL_DR   DR_3
 
#define CN779_MAX_NB_BANDS   1
 
#define CN779_BAND0   { 100, CN779_MAX_TX_POWER, 0, 0, 0, 0, 0 }
 
#define CN779_LC1   { 779500000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
 
#define CN779_LC2   { 779700000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
 
#define CN779_LC3   { 779900000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
 
#define CN779_JOIN_CHANNELS   ( uint16_t )( LC( 1 ) | LC( 2 ) | LC( 3 ) )
 

Functions

PhyParam_t RegionCN779GetPhyParam (GetPhyParams_t *getPhy)
 The function gets a value of a specific phy attribute. More...
 
void RegionCN779SetBandTxDone (SetBandTxDoneParams_t *txDone)
 Updates the last TX done parameters of the current channel. More...
 
void RegionCN779InitDefaults (InitDefaultsParams_t *params)
 Initializes the channels masks and the channels. More...
 
bool RegionCN779Verify (VerifyParams_t *verify, PhyAttribute_t phyAttribute)
 Verifies a parameter. More...
 
void RegionCN779ApplyCFList (ApplyCFListParams_t *applyCFList)
 The function parses the input buffer and sets up the channels of the CF list. More...
 
bool RegionCN779ChanMaskSet (ChanMaskSetParams_t *chanMaskSet)
 Sets a channels mask. More...
 
void RegionCN779ComputeRxWindowParameters (int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
 
bool RegionCN779RxConfig (RxConfigParams_t *rxConfig, int8_t *datarate)
 Configuration of the RX windows. More...
 
bool RegionCN779TxConfig (TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
 TX configuration. More...
 
uint8_t RegionCN779LinkAdrReq (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 RegionCN779RxParamSetupReq (RxParamSetupReqParams_t *rxParamSetupReq)
 The function processes a RX Parameter Setup Request. More...
 
int8_t RegionCN779NewChannelReq (NewChannelReqParams_t *newChannelReq)
 The function processes a Channel Request. More...
 
int8_t RegionCN779TxParamSetupReq (TxParamSetupReqParams_t *txParamSetupReq)
 The function processes a TX ParamSetup Request. More...
 
int8_t RegionCN779DlChannelReq (DlChannelReqParams_t *dlChannelReq)
 The function processes a DlChannel Request. More...
 
int8_t RegionCN779AlternateDr (int8_t currentDr, AlternateDrType_t type)
 Alternates the datarate of the channel for the join request. More...
 
LoRaMacStatus_t RegionCN779NextChannel (NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
 Searches and set the next random available channel. More...
 
LoRaMacStatus_t RegionCN779ChannelAdd (ChannelAddParams_t *channelAdd)
 Adds a channel. More...
 
bool RegionCN779ChannelsRemove (ChannelRemoveParams_t *channelRemove)
 Removes a channel. More...
 
uint8_t RegionCN779ApplyDrOffset (uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
 Computes new datarate according to the given offset. More...
 
void RegionCN779RxBeaconSetup (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

◆ CN779_MAX_NB_CHANNELS

#define CN779_MAX_NB_CHANNELS   16

LoRaMac maximum number of channels

◆ CN779_NUMB_DEFAULT_CHANNELS

#define CN779_NUMB_DEFAULT_CHANNELS   3

Number of default channels

◆ CN779_NUMB_CHANNELS_CF_LIST

#define CN779_NUMB_CHANNELS_CF_LIST   5

Number of channels to apply for the CF list

◆ CN779_TX_MIN_DATARATE

#define CN779_TX_MIN_DATARATE   DR_0

Minimal datarate that can be used by the node

◆ CN779_TX_MAX_DATARATE

#define CN779_TX_MAX_DATARATE   DR_7

Maximal datarate that can be used by the node

◆ CN779_RX_MIN_DATARATE

#define CN779_RX_MIN_DATARATE   DR_0

Minimal datarate that can be used by the node

◆ CN779_RX_MAX_DATARATE

#define CN779_RX_MAX_DATARATE   DR_7

Maximal datarate that can be used by the node

◆ CN779_DEFAULT_DATARATE

#define CN779_DEFAULT_DATARATE   DR_0

Default datarate used by the node

◆ CN779_MIN_RX1_DR_OFFSET

#define CN779_MIN_RX1_DR_OFFSET   0

Minimal Rx1 receive datarate offset

◆ CN779_MAX_RX1_DR_OFFSET

#define CN779_MAX_RX1_DR_OFFSET   5

Maximal Rx1 receive datarate offset

◆ CN779_MIN_TX_POWER

#define CN779_MIN_TX_POWER   TX_POWER_5

Minimal Tx output power that can be used by the node

◆ CN779_MAX_TX_POWER

#define CN779_MAX_TX_POWER   TX_POWER_0

Maximal Tx output power that can be used by the node

◆ CN779_DEFAULT_TX_POWER

#define CN779_DEFAULT_TX_POWER   TX_POWER_0

Default Tx output power used by the node

◆ CN779_DEFAULT_MAX_EIRP

#define CN779_DEFAULT_MAX_EIRP   12.15f

Default Max EIRP

◆ CN779_DEFAULT_ANTENNA_GAIN

#define CN779_DEFAULT_ANTENNA_GAIN   2.15f

Default antenna gain

◆ CN779_DUTY_CYCLE_ENABLED

#define CN779_DUTY_CYCLE_ENABLED   1

Enabled or disabled the duty cycle

◆ CN779_MAX_RX_WINDOW

#define CN779_MAX_RX_WINDOW   3000

Maximum RX window duration

◆ CN779_RX_WND_2_FREQ

#define CN779_RX_WND_2_FREQ   786000000

Verification of default datarate

Second reception window channel frequency definition.

◆ CN779_RX_WND_2_DR

#define CN779_RX_WND_2_DR   DR_0

Second reception window channel datarate definition.

◆ CN779_DEFAULT_UPLINK_DWELL_TIME

#define CN779_DEFAULT_UPLINK_DWELL_TIME   0

Default uplink dwell time configuration

◆ CN779_BEACON_CHANNEL_FREQ

#define CN779_BEACON_CHANNEL_FREQ   785000000

Beacon frequency

◆ CN779_PING_SLOT_CHANNEL_FREQ

#define CN779_PING_SLOT_CHANNEL_FREQ   785000000

Ping slot channel frequency

◆ CN779_BEACON_SIZE

#define CN779_BEACON_SIZE   17

Payload size of a beacon frame

◆ CN779_RFU1_SIZE

#define CN779_RFU1_SIZE   1

Size of RFU 1 field

◆ CN779_RFU2_SIZE

#define CN779_RFU2_SIZE   0

Size of RFU 2 field

◆ CN779_BEACON_CHANNEL_DR

#define CN779_BEACON_CHANNEL_DR   DR_3

Datarate of the beacon channel

◆ CN779_BEACON_CHANNEL_BW

#define CN779_BEACON_CHANNEL_BW   0

Bandwith of the beacon channel

◆ CN779_PING_SLOT_CHANNEL_DR

#define CN779_PING_SLOT_CHANNEL_DR   DR_3

Ping slot channel datarate

◆ CN779_MAX_NB_BANDS

#define CN779_MAX_NB_BANDS   1

LoRaMac maximum number of bands

◆ CN779_BAND0

#define CN779_BAND0   { 100, CN779_MAX_TX_POWER, 0, 0, 0, 0, 0 }

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

◆ CN779_LC1

#define CN779_LC1   { 779500000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }

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

◆ CN779_LC2

#define CN779_LC2   { 779700000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }

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

◆ CN779_LC3

#define CN779_LC3   { 779900000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }

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

◆ CN779_JOIN_CHANNELS

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

LoRaMac channels which are allowed for the join procedure

Function Documentation

◆ RegionCN779GetPhyParam()

PhyParam_t RegionCN779GetPhyParam ( GetPhyParams_t getPhy)

The function gets a value of a specific phy attribute.

Parameters
[IN]getPhy Pointer to the function parameters.
Return values
Returnsa structure containing the PHY parameter.

◆ RegionCN779SetBandTxDone()

void RegionCN779SetBandTxDone ( SetBandTxDoneParams_t txDone)

Updates the last TX done parameters of the current channel.

Parameters
[IN]txDone Pointer to the function parameters.

◆ RegionCN779InitDefaults()

void RegionCN779InitDefaults ( InitDefaultsParams_t params)

Initializes the channels masks and the channels.

Parameters
[IN]type Sets the initialization type.

◆ RegionCN779Verify()

bool RegionCN779Verify ( 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
Returnstrue, if the parameter is valid.

◆ RegionCN779ApplyCFList()

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

◆ RegionCN779ChanMaskSet()

bool RegionCN779ChanMaskSet ( ChanMaskSetParams_t chanMaskSet)

Sets a channels mask.

Parameters
[IN]chanMaskSet Pointer to the function parameters.
Return values
Returnstrue, if the channels mask could be set.

◆ RegionCN779ComputeRxWindowParameters()

void RegionCN779ComputeRxWindowParameters ( 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]rxConfigParamsReturns updated WindowTimeout and WindowOffset fields.

◆ RegionCN779RxConfig()

bool RegionCN779RxConfig ( 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
Returnstrue, if the configuration was applied successfully.

◆ RegionCN779TxConfig()

bool RegionCN779TxConfig ( 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
Returnstrue, if the configuration was applied successfully.

◆ RegionCN779LinkAdrReq()

uint8_t RegionCN779LinkAdrReq ( 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
Returnsthe status of the operation, according to the LoRaMAC specification.

◆ RegionCN779RxParamSetupReq()

uint8_t RegionCN779RxParamSetupReq ( RxParamSetupReqParams_t rxParamSetupReq)

The function processes a RX Parameter Setup Request.

Parameters
[IN]rxParamSetupReq Pointer to the function parameters.
Return values
Returnsthe status of the operation, according to the LoRaMAC specification.

◆ RegionCN779NewChannelReq()

int8_t RegionCN779NewChannelReq ( NewChannelReqParams_t newChannelReq)

The function processes a Channel Request.

Parameters
[IN]newChannelReq Pointer to the function parameters.
Return values
Returnsthe status of the operation, according to the LoRaMAC specification.

◆ RegionCN779TxParamSetupReq()

int8_t RegionCN779TxParamSetupReq ( TxParamSetupReqParams_t txParamSetupReq)

The function processes a TX ParamSetup Request.

Parameters
[IN]txParamSetupReq Pointer 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.

◆ RegionCN779DlChannelReq()

int8_t RegionCN779DlChannelReq ( DlChannelReqParams_t dlChannelReq)

The function processes a DlChannel Request.

Parameters
[IN]dlChannelReq Pointer to the function parameters.
Return values
Returnsthe status of the operation, according to the LoRaMAC specification.

◆ RegionCN779AlternateDr()

int8_t RegionCN779AlternateDr ( int8_t  currentDr,
AlternateDrType_t  type 
)

Alternates the datarate of the channel for the join request.

Parameters
[IN]currentDr Current datarate.
Return values
Datarateto apply.

◆ RegionCN779NextChannel()

LoRaMacStatus_t RegionCN779NextChannel ( 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
Functionstatus [1: OK, 0: Unable to find a channel on the current datarate]

◆ RegionCN779ChannelAdd()

LoRaMacStatus_t RegionCN779ChannelAdd ( ChannelAddParams_t channelAdd)

Adds a channel.

Parameters
[IN]channelAdd Pointer to the function parameters.
Return values
Statusof the operation.

◆ RegionCN779ChannelsRemove()

bool RegionCN779ChannelsRemove ( ChannelRemoveParams_t channelRemove)

Removes a channel.

Parameters
[IN]channelRemove Pointer to the function parameters.
Return values
Returnstrue, if the channel was removed successfully.

◆ RegionCN779ApplyDrOffset()

uint8_t RegionCN779ApplyDrOffset ( 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
newDrComputed datarate.

◆ RegionCN779RxBeaconSetup()

void RegionCN779RxBeaconSetup ( RxBeaconSetup_t rxBeaconSetup,
uint8_t *  outDr 
)

Sets the radio into beacon reception mode.

Parameters
[IN]rxBeaconSetup Pointer to the function parameters