| SX126x-Arduino 2.0.1

RegionKR920.h
Go to the documentation of this file.
1
35 #ifndef __REGION_KR920_H__
36 #define __REGION_KR920_H__
37
38 extern "C"
39 {
40
44 #define KR920_MAX_NB_CHANNELS 16
45
49 #define KR920_NUMB_DEFAULT_CHANNELS 7
50
54 #define KR920_NUMB_CHANNELS_CF_LIST 5
55
59 #define KR920_TX_MIN_DATARATE DR_0
60
64 #define KR920_TX_MAX_DATARATE DR_5
65
69 #define KR920_RX_MIN_DATARATE DR_0
70
74 #define KR920_RX_MAX_DATARATE DR_5
75
79 #define KR920_DEFAULT_DATARATE DR_0
80
84 #define KR920_MIN_RX1_DR_OFFSET 0
85
89 #define KR920_MAX_RX1_DR_OFFSET 5
90
94 #define KR920_DEFAULT_RX1_DR_OFFSET 0
95
99 #define KR920_MIN_TX_POWER TX_POWER_7
100
104 #define KR920_MAX_TX_POWER TX_POWER_0
105
109 #define KR920_DEFAULT_TX_POWER TX_POWER_0
110
114 #define KR920_DEFAULT_MAX_EIRP_LOW 10.0f
115
119 #define KR920_DEFAULT_MAX_EIRP_HIGH 14.0f
120
124 #define KR920_DEFAULT_ANTENNA_GAIN 2.15f
125
129 #define KR920_ADR_ACK_LIMIT 64
130
134 #define KR920_ADR_ACK_DELAY 32
135
139 #define KR920_DUTY_CYCLE_ENABLED 0
140
144 #define KR920_MAX_RX_WINDOW 4000
145
149 #define KR920_RECEIVE_DELAY1 1000
150
154 #define KR920_RECEIVE_DELAY2 2000
155
159 #define KR920_JOIN_ACCEPT_DELAY1 5000
160
164 #define KR920_JOIN_ACCEPT_DELAY2 6000
165
169 #define KR920_MAX_FCNT_GAP 16384
170
174 #define KR920_ACKTIMEOUT 2000
175
179 #define KR920_ACK_TIMEOUT_RND 1000
180
181 #if (KR920_DEFAULT_DATARATE > DR_5)
182 #error "A default DR higher than DR_5 may lead to connectivity loss."
183 #endif
184
188 #define KR920_RX_WND_2_FREQ 921900000
189
193 #define KR920_RX_WND_2_DR DR_0
194
198 #define KR920_MAX_NB_BANDS 1
199
204 #define KR920_BAND0 \
205 { \
206 1, KR920_MAX_TX_POWER, 0, 0 \
207 } // 100.0 %
208
213 #define KR920_LC1 \
214 { \
215 922100000, 0, {((DR_5 << 4) | DR_0)}, 0 \
216 }
217
222 #define KR920_LC2 \
223 { \
224 922300000, 0, {((DR_5 << 4) | DR_0)}, 0 \
225 }
226
231 #define KR920_LC3 \
232 { \
233 922500000, 0, {((DR_5 << 4) | DR_0)}, 0 \
234 }
235
236 #define KR920_LC4 \
237 { \
238 922700000, 0, {((DR_5 << 4) | DR_0)}, 0 \
239 }
240 #define KR920_LC5 \
241 { \
242 922900000, 0, {((DR_5 << 4) | DR_0)}, 0 \
243 }
244 #define KR920_LC6 \
245 { \
246 923100000, 0, {((DR_5 << 4) | DR_0)}, 0 \
247 }
248 #define KR920_LC7 \
249 { \
250 923300000, 0, {((DR_5 << 4) | DR_0)}, 0 \
251 }
252
256 #define KR920_JOIN_CHANNELS (uint16_t)(LC(1) | LC(2) | LC(3))
257
261 #define KR920_RSSI_FREE_TH -65
262
266 #define KR920_CARRIER_SENSE_TIME 6
267
271 static const uint8_t DataratesKR920[] = {12, 11, 10, 9, 8, 7};
272
276 static const uint32_t BandwidthsKR920[] = {125000, 125000, 125000, 125000, 125000, 125000};
277
281 static const uint8_t MaxPayloadOfDatarateKR920[] = {51, 51, 51, 115, 242, 242};
282
286 static const uint8_t MaxPayloadOfDatarateRepeaterKR920[] = {51, 51, 51, 115, 222, 222};
287
295 PhyParam_t RegionKR920GetPhyParam(GetPhyParams_t *getPhy);
296
302 void RegionKR920SetBandTxDone(SetBandTxDoneParams_t *txDone);
303
309 void RegionKR920InitDefaults(InitType_t type);
310
320 bool RegionKR920Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute);
321
328 void RegionKR920ApplyCFList(ApplyCFListParams_t *applyCFList);
329
337 bool RegionKR920ChanMaskSet(ChanMaskSetParams_t *chanMaskSet);
338
352 bool RegionKR920AdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter);
353
367 void RegionKR920ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams);
368
378 bool RegionKR920RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate);
379
391 bool RegionKR920TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir);
392
408 uint8_t RegionKR920LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed);
409
417 uint8_t RegionKR920RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq);
418
426 uint8_t RegionKR920NewChannelReq(NewChannelReqParams_t *newChannelReq);
427
437 int8_t RegionKR920TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq);
438
446 uint8_t RegionKR920DlChannelReq(DlChannelReqParams_t *dlChannelReq);
447
455 int8_t RegionKR920AlternateDr(AlternateDrParams_t *alternateDr);
456
462 void RegionKR920CalcBackOff(CalcBackOffParams_t *calcBackOff);
463
478 bool RegionKR920NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff);
479
487 LoRaMacStatus_t RegionKR920ChannelAdd(ChannelAddParams_t *channelAdd);
488
496 bool RegionKR920ChannelsRemove(ChannelRemoveParams_t *channelRemove);
497
503 void RegionKR920SetContinuousWave(ContinuousWaveParams_t *continuousWave);
504
516 uint8_t RegionKR920ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset);
517
519 };
520 #endif // __REGION_KR920_H__
RegionKR920ChannelsRemove
bool RegionKR920ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.
sChannelRemoveParams
Definition: Region.h:1217
LoRaMacStatus_t
enum eLoRaMacStatus LoRaMacStatus_t
RegionKR920InitDefaults
void RegionKR920InitDefaults(InitType_t type)
Initializes the channels masks and the channels.
sTxConfigParams
Definition: Region.h:999
RegionKR920SetBandTxDone
void RegionKR920SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
InitType_t
enum eInitType InitType_t
sSetBandTxDoneParams
Definition: Region.h:832
sRxParamSetupReqParams
Definition: Region.h:1065
RegionKR920GetPhyParam
PhyParam_t RegionKR920GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
uVerifyParams
Definition: Region.h:850
sRxConfigParams
Definition: Region.h:948
sAlternateDrParams
Definition: Region.h:1133
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.
sNewChannelReqParams
Definition: Region.h:1084
sContinuousWaveParams
Definition: Region.h:1228
sAdrNextParams
Definition: Region.h:917
sCalcBackOffParams
Definition: Region.h:1144
RegionKR920ChannelAdd
LoRaMacStatus_t RegionKR920ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
RegionKR920SetContinuousWave
void RegionKR920SetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
sApplyCFListParams
Definition: Region.h:887
sTxParamSetupReqParams
Definition: Region.h:1099
RegionKR920RxConfig
bool RegionKR920RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
RegionKR920TxConfig
bool RegionKR920TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
RegionKR920NewChannelReq
uint8_t RegionKR920NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
sChanMaskSetParams
Definition: Region.h:902
RegionKR920RxParamSetupReq
uint8_t RegionKR920RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
sLinkAdrReqParams
Definition: Region.h:1030
RegionKR920NextChannel
bool RegionKR920NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
RegionKR920ApplyCFList
void RegionKR920ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
RegionKR920DlChannelReq
uint8_t RegionKR920DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
RegionKR920ChanMaskSet
bool RegionKR920ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
MaxPayloadOfDatarateKR920
static const uint8_t MaxPayloadOfDatarateKR920[]
Definition: RegionKR920.h:281
BandwidthsKR920
static const uint32_t BandwidthsKR920[]
Definition: RegionKR920.h:276
sNextChanParams
Definition: Region.h:1175
uPhyParam
Definition: Region.h:780
RegionKR920Verify
bool RegionKR920Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
RegionKR920AlternateDr
int8_t RegionKR920AlternateDr(AlternateDrParams_t *alternateDr)
Alternates the datarate of the channel for the join request.
MaxPayloadOfDatarateRepeaterKR920
static const uint8_t MaxPayloadOfDatarateRepeaterKR920[]
Definition: RegionKR920.h:286
sChannelAddParams
Definition: Region.h:1202
RegionKR920TxParamSetupReq
int8_t RegionKR920TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
sDlChannelReqParams
Definition: Region.h:1118
sGetPhyParams
Definition: Region.h:803
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.
PhyAttribute_t
enum ePhyAttribute PhyAttribute_t
RegionKR920ApplyDrOffset
uint8_t RegionKR920ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
TimerTime_t
uint32_t TimerTime_t
Timer time variable definition.
Definition: timer.h:69
DataratesKR920
static const uint8_t DataratesKR920[]
Definition: RegionKR920.h:271
RegionKR920CalcBackOff
void RegionKR920CalcBackOff(CalcBackOffParams_t *calcBackOff)
Calculates the back-off time.
RegionKR920ComputeRxWindowParameters
void RegionKR920ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)