LoRaMAC  4.4.5
Documentation of the API
RegionCN470.h
Go to the documentation of this file.
1 
37 #ifndef __REGION_CN470_H__
38 #define __REGION_CN470_H__
39 
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44 
45 #include "region/Region.h"
46 
50 #define CN470_MAX_NB_CHANNELS 96
51 
55 #define CN470_TX_MIN_DATARATE DR_0
56 
60 #define CN470_TX_MAX_DATARATE DR_5
61 
65 #define CN470_RX_MIN_DATARATE DR_0
66 
70 #define CN470_RX_MAX_DATARATE DR_5
71 
75 #define CN470_DEFAULT_DATARATE DR_0
76 
80 #define CN470_MIN_RX1_DR_OFFSET 0
81 
85 #define CN470_MAX_RX1_DR_OFFSET 5
86 
90 #define CN470_MIN_TX_POWER TX_POWER_7
91 
95 #define CN470_MAX_TX_POWER TX_POWER_0
96 
100 #define CN470_DEFAULT_TX_POWER TX_POWER_0
101 
105 #define CN470_DEFAULT_MAX_EIRP 19.15f
106 
110 #define CN470_DEFAULT_ANTENNA_GAIN 2.15f
111 
115 #define CN470_DUTY_CYCLE_ENABLED 0
116 
120 #define CN470_MAX_RX_WINDOW 3000
121 
125 #define CN470_RX_WND_2_FREQ 505300000
126 
130 #define CN470_RX_WND_2_DR DR_0
131 
135 #define CN470_DEFAULT_UPLINK_DWELL_TIME 0
136 
137 /*
138  * CLASS B
139  */
143 #define CN470_BEACON_CHANNEL_FREQ 508300000
144 
148 #define CN470_BEACON_CHANNEL_STEPWIDTH 200000
149 
153 #define CN470_PING_SLOT_CHANNEL_FREQ 508300000
154 
158 #define CN470_BEACON_NB_CHANNELS 8
159 
163 #define CN470_BEACON_SIZE 19
164 
168 #define CN470_RFU1_SIZE 3
169 
173 #define CN470_RFU2_SIZE 1
174 
178 #define CN470_BEACON_CHANNEL_DR DR_2
179 
183 #define CN470_BEACON_CHANNEL_BW 0
184 
188 #define CN470_PING_SLOT_CHANNEL_DR DR_2
189 
193 #define CN470_MAX_NB_BANDS 1
194 
199 #define CN470_BAND0 { 1, CN470_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 100.0 %
200 
204 #define CN470_FIRST_RX1_CHANNEL ( (uint32_t) 500300000 )
205 
209 #define CN470_LAST_RX1_CHANNEL ( (uint32_t) 509700000 )
210 
214 #define CN470_STEPWIDTH_RX1_CHANNEL ( (uint32_t) 200000 )
215 
219 static const uint8_t DataratesCN470[] = { 12, 11, 10, 9, 8, 7 };
220 
224 static const uint32_t BandwidthsCN470[] = { 125000, 125000, 125000, 125000, 125000, 125000 };
225 
229 static const uint8_t MaxPayloadOfDatarateCN470[] = { 51, 51, 51, 115, 242, 242 };
230 
239 
246 
253 
261 void* RegionCN470GetNvmCtx( GetNvmCtxParams_t* params );
262 
272 bool RegionCN470Verify( VerifyParams_t* verify, PhyAttribute_t phyAttribute );
273 
280 void RegionCN470ApplyCFList( ApplyCFListParams_t* applyCFList );
281 
289 bool RegionCN470ChanMaskSet( ChanMaskSetParams_t* chanMaskSet );
290 
304 void RegionCN470ComputeRxWindowParameters( int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams );
305 
315 bool RegionCN470RxConfig( RxConfigParams_t* rxConfig, int8_t* datarate );
316 
328 bool RegionCN470TxConfig( TxConfigParams_t* txConfig, int8_t* txPower, TimerTime_t* txTimeOnAir );
329 
337 uint8_t RegionCN470LinkAdrReq( LinkAdrReqParams_t* linkAdrReq, int8_t* drOut, int8_t* txPowOut, uint8_t* nbRepOut, uint8_t* nbBytesParsed );
338 
346 uint8_t RegionCN470RxParamSetupReq( RxParamSetupReqParams_t* rxParamSetupReq );
347 
355 uint8_t RegionCN470NewChannelReq( NewChannelReqParams_t* newChannelReq );
356 
366 int8_t RegionCN470TxParamSetupReq( TxParamSetupReqParams_t* txParamSetupReq );
367 
375 uint8_t RegionCN470DlChannelReq( DlChannelReqParams_t* dlChannelReq );
376 
386 int8_t RegionCN470AlternateDr( int8_t currentDr, AlternateDrType_t type );
387 
400 LoRaMacStatus_t RegionCN470NextChannel( NextChanParams_t* nextChanParams, uint8_t* channel, TimerTime_t* time, TimerTime_t* aggregatedTimeOff );
401 
410 
418 bool RegionCN470ChannelsRemove( ChannelRemoveParams_t* channelRemove );
419 
426 
438 uint8_t RegionCN470ApplyDrOffset( uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset );
439 
445 void RegionCN470RxBeaconSetup( RxBeaconSetup_t* rxBeaconSetup, uint8_t* outDr );
446 
449 #ifdef __cplusplus
450 }
451 #endif
452 
453 #endif // __REGION_CN470_H__
RegionCN470ComputeRxWindowParameters
void RegionCN470ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
AlternateDrType_t
AlternateDrType_t
Definition: Region.h:1264
Region.h
Region implementation.
GetPhyParams_t
Definition: Region.h:921
LoRaMacStatus_t
LoRaMacStatus_t
Definition: LoRaMac.h:2153
RegionCN470RxBeaconSetup
void RegionCN470RxBeaconSetup(RxBeaconSetup_t *rxBeaconSetup, uint8_t *outDr)
Sets the radio into beacon reception mode.
RegionCN470TxParamSetupReq
int8_t RegionCN470TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
RegionCN470SetBandTxDone
void RegionCN470SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
RegionCN470NewChannelReq
uint8_t RegionCN470NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
ChanMaskSetParams_t
Definition: Region.h:1064
RegionCN470AlternateDr
int8_t RegionCN470AlternateDr(int8_t currentDr, AlternateDrType_t type)
Alternates the datarate of the channel for the join request.
ContinuousWaveParams_t
Definition: Region.h:1344
NextChanParams_t
Definition: Region.h:1279
RxBeaconSetup_t
Definition: Region.h:1375
RegionCN470ChanMaskSet
bool RegionCN470ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
RegionCN470SetContinuousWave
void RegionCN470SetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
NewChannelReqParams_t
Definition: Region.h:1215
RegionCN470Verify
bool RegionCN470Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
RegionCN470RxParamSetupReq
uint8_t RegionCN470RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
TxParamSetupReqParams_t
Definition: Region.h:1230
RegionCN470ChannelAdd
LoRaMacStatus_t RegionCN470ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
PhyAttribute_t
PhyAttribute_t
Definition: Region.h:589
GetNvmCtxParams_t
Definition: Region.h:1000
RegionCN470TxConfig
bool RegionCN470TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
ChannelAddParams_t
Definition: Region.h:1318
RegionCN470InitDefaults
void RegionCN470InitDefaults(InitDefaultsParams_t *params)
Initializes the channels masks and the channels.
RegionCN470DlChannelReq
uint8_t RegionCN470DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
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.
RxConfigParams_t
Definition: Region.h:1079
RegionCN470ApplyCFList
void RegionCN470ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
RegionCN470GetNvmCtx
void * RegionCN470GetNvmCtx(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
RegionCN470GetPhyParam
PhyParam_t RegionCN470GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
TxConfigParams_t
Definition: Region.h:1126
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
RegionCN470RxConfig
bool RegionCN470RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
RegionCN470NextChannel
LoRaMacStatus_t RegionCN470NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
RegionCN470ApplyDrOffset
uint8_t RegionCN470ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
ChannelRemoveParams_t
Definition: Region.h:1333
RegionCN470ChannelsRemove
bool RegionCN470ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.