LoRaMAC  4.4.5
Documentation of the API
RegionKR920.h
Go to the documentation of this file.
1 
37 #ifndef __REGION_KR920_H__
38 #define __REGION_KR920_H__
39 
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44 
45 #include "region/Region.h"
46 
50 #define KR920_MAX_NB_CHANNELS 16
51 
55 #define KR920_NUMB_DEFAULT_CHANNELS 3
56 
60 #define KR920_NUMB_CHANNELS_CF_LIST 5
61 
65 #define KR920_TX_MIN_DATARATE DR_0
66 
70 #define KR920_TX_MAX_DATARATE DR_5
71 
75 #define KR920_RX_MIN_DATARATE DR_0
76 
80 #define KR920_RX_MAX_DATARATE DR_5
81 
85 #define KR920_DEFAULT_DATARATE DR_0
86 
90 #define KR920_MIN_RX1_DR_OFFSET 0
91 
95 #define KR920_MAX_RX1_DR_OFFSET 5
96 
100 #define KR920_MIN_TX_POWER TX_POWER_7
101 
105 #define KR920_MAX_TX_POWER TX_POWER_0
106 
110 #define KR920_DEFAULT_TX_POWER TX_POWER_0
111 
115 #define KR920_DEFAULT_MAX_EIRP_LOW 10.0f
116 
120 #define KR920_DEFAULT_MAX_EIRP_HIGH 14.0f
121 
125 #define KR920_DEFAULT_ANTENNA_GAIN 2.15f
126 
130 #define KR920_DUTY_CYCLE_ENABLED 0
131 
135 #define KR920_MAX_RX_WINDOW 4000
136 
137 #if ( KR920_DEFAULT_DATARATE > DR_5 )
138 #error "A default DR higher than DR_5 may lead to connectivity loss."
139 #endif
140 
144 #define KR920_RX_WND_2_FREQ 921900000
145 
149 #define KR920_RX_WND_2_DR DR_0
150 
154 #define KR920_DEFAULT_UPLINK_DWELL_TIME 0
155 
156 /*
157  * CLASS B
158  */
162 #define KR920_BEACON_CHANNEL_FREQ 923100000
163 
167 #define KR920_PING_SLOT_CHANNEL_FREQ 923100000
168 
172 #define KR920_BEACON_SIZE 17
173 
177 #define KR920_RFU1_SIZE 2
178 
182 #define KR920_RFU2_SIZE 0
183 
187 #define KR920_BEACON_CHANNEL_DR DR_3
188 
192 #define KR920_BEACON_CHANNEL_BW 0
193 
197 #define KR920_PING_SLOT_CHANNEL_DR DR_3
198 
202 #define KR920_MAX_NB_BANDS 1
203 
208 #define KR920_BAND0 { 1 , KR920_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 100.0 %
209 
214 #define KR920_LC1 { 922100000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
215 
220 #define KR920_LC2 { 922300000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
221 
226 #define KR920_LC3 { 922500000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
227 
231 #define KR920_JOIN_CHANNELS ( uint16_t )( LC( 1 ) | LC( 2 ) | LC( 3 ) )
232 
236 #define KR920_RSSI_FREE_TH -65
237 
241 #define KR920_CARRIER_SENSE_TIME 6
242 
246 static const uint8_t DataratesKR920[] = { 12, 11, 10, 9, 8, 7 };
247 
251 static const uint32_t BandwidthsKR920[] = { 125000, 125000, 125000, 125000, 125000, 125000 };
252 
256 static const uint8_t MaxPayloadOfDatarateKR920[] = { 51, 51, 51, 115, 242, 242 };
257 
266 
273 
280 
288 void* RegionKR920GetNvmCtx( GetNvmCtxParams_t* params );
289 
299 bool RegionKR920Verify( VerifyParams_t* verify, PhyAttribute_t phyAttribute );
300 
307 void RegionKR920ApplyCFList( ApplyCFListParams_t* applyCFList );
308 
316 bool RegionKR920ChanMaskSet( ChanMaskSetParams_t* chanMaskSet );
317 
331 void RegionKR920ComputeRxWindowParameters( int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams );
332 
342 bool RegionKR920RxConfig( RxConfigParams_t* rxConfig, int8_t* datarate );
343 
355 bool RegionKR920TxConfig( TxConfigParams_t* txConfig, int8_t* txPower, TimerTime_t* txTimeOnAir );
356 
364 uint8_t RegionKR920LinkAdrReq( LinkAdrReqParams_t* linkAdrReq, int8_t* drOut, int8_t* txPowOut, uint8_t* nbRepOut, uint8_t* nbBytesParsed );
365 
373 uint8_t RegionKR920RxParamSetupReq( RxParamSetupReqParams_t* rxParamSetupReq );
374 
382 uint8_t RegionKR920NewChannelReq( NewChannelReqParams_t* newChannelReq );
383 
393 int8_t RegionKR920TxParamSetupReq( TxParamSetupReqParams_t* txParamSetupReq );
394 
402 uint8_t RegionKR920DlChannelReq( DlChannelReqParams_t* dlChannelReq );
403 
411 int8_t RegionKR920AlternateDr( int8_t currentDr, AlternateDrType_t type );
412 
425 LoRaMacStatus_t RegionKR920NextChannel( NextChanParams_t* nextChanParams, uint8_t* channel, TimerTime_t* time, TimerTime_t* aggregatedTimeOff );
426 
435 
443 bool RegionKR920ChannelsRemove( ChannelRemoveParams_t* channelRemove );
444 
451 
463 uint8_t RegionKR920ApplyDrOffset( uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset );
464 
470  void RegionKR920RxBeaconSetup( RxBeaconSetup_t* rxBeaconSetup, uint8_t* outDr );
471 
474 #ifdef __cplusplus
475 }
476 #endif
477 
478 #endif // __REGION_KR920_H__
AlternateDrType_t
AlternateDrType_t
Definition: Region.h:1264
Region.h
Region implementation.
RegionKR920ChannelsRemove
bool RegionKR920ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.
GetPhyParams_t
Definition: Region.h:921
LoRaMacStatus_t
LoRaMacStatus_t
Definition: LoRaMac.h:2153
RegionKR920SetBandTxDone
void RegionKR920SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
RegionKR920GetPhyParam
PhyParam_t RegionKR920GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
RegionKR920NextChannel
LoRaMacStatus_t RegionKR920NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
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.
ChanMaskSetParams_t
Definition: Region.h:1064
ContinuousWaveParams_t
Definition: Region.h:1344
NextChanParams_t
Definition: Region.h:1279
RxBeaconSetup_t
Definition: Region.h:1375
RegionKR920ChannelAdd
LoRaMacStatus_t RegionKR920ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
RegionKR920SetContinuousWave
void RegionKR920SetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
NewChannelReqParams_t
Definition: Region.h:1215
TxParamSetupReqParams_t
Definition: Region.h:1230
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.
RegionKR920RxParamSetupReq
uint8_t RegionKR920RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
RegionKR920InitDefaults
void RegionKR920InitDefaults(InitDefaultsParams_t *params)
Initializes the channels masks and the channels.
PhyAttribute_t
PhyAttribute_t
Definition: Region.h:589
RegionKR920ApplyCFList
void RegionKR920ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
GetNvmCtxParams_t
Definition: Region.h:1000
RegionKR920DlChannelReq
uint8_t RegionKR920DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
RegionKR920ChanMaskSet
bool RegionKR920ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
ChannelAddParams_t
Definition: Region.h:1318
RxConfigParams_t
Definition: Region.h:1079
RegionKR920Verify
bool RegionKR920Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
RegionKR920GetNvmCtx
void * RegionKR920GetNvmCtx(GetNvmCtxParams_t *params)
Returns a pointer to the internal context and its size.
ApplyCFListParams_t
Definition: Region.h:1049
DlChannelReqParams_t
Definition: Region.h:1249
TxConfigParams_t
Definition: Region.h:1126
RegionKR920TxParamSetupReq
int8_t RegionKR920TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
InitDefaultsParams_t
Definition: Region.h:985
SetBandTxDoneParams_t
Definition: Region.h:958
RxParamSetupReqParams_t
Definition: Region.h:1196
VerifyParams_t
Definition: Region.h:1012
PhyParam_t
Definition: Region.h:890
RegionKR920AlternateDr
int8_t RegionKR920AlternateDr(int8_t currentDr, AlternateDrType_t type)
Alternates the datarate of the channel for the join request.
RegionKR920ApplyDrOffset
uint8_t RegionKR920ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
RegionKR920RxBeaconSetup
void RegionKR920RxBeaconSetup(RxBeaconSetup_t *rxBeaconSetup, uint8_t *outDr)
Sets the radio into beacon reception mode.
RegionKR920ComputeRxWindowParameters
void RegionKR920ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
ChannelRemoveParams_t
Definition: Region.h:1333