LoRaMAC  4.4.5
Documentation of the API
RegionEU868.h
Go to the documentation of this file.
1 
37 #ifndef __REGION_EU868_H__
38 #define __REGION_EU868_H__
39 
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44 
45 #include "region/Region.h"
46 
50 #define EU868_MAX_NB_CHANNELS 16
51 
55 #define EU868_NUMB_DEFAULT_CHANNELS 3
56 
60 #define EU868_NUMB_CHANNELS_CF_LIST 5
61 
65 #define EU868_TX_MIN_DATARATE DR_0
66 
70 #define EU868_TX_MAX_DATARATE DR_7
71 
75 #define EU868_RX_MIN_DATARATE DR_0
76 
80 #define EU868_RX_MAX_DATARATE DR_7
81 
85 #define EU868_DEFAULT_DATARATE DR_0
86 
90 #define EU868_MIN_RX1_DR_OFFSET 0
91 
95 #define EU868_MAX_RX1_DR_OFFSET 5
96 
100 #define EU868_MIN_TX_POWER TX_POWER_7
101 
105 #define EU868_MAX_TX_POWER TX_POWER_0
106 
110 #define EU868_DEFAULT_TX_POWER TX_POWER_0
111 
115 #define EU868_DEFAULT_MAX_EIRP 16.0f
116 
120 #define EU868_DEFAULT_ANTENNA_GAIN 2.15f
121 
125 #define EU868_DUTY_CYCLE_ENABLED 1
126 
130 #define EU868_MAX_RX_WINDOW 3000
131 
132 #if ( EU868_DEFAULT_DATARATE > DR_5 )
133 #error "A default DR higher than DR_5 may lead to connectivity loss."
134 #endif
135 
139 #define EU868_RX_WND_2_FREQ 869525000
140 
144 #define EU868_RX_WND_2_DR DR_0
145 
149 #define EU868_DEFAULT_UPLINK_DWELL_TIME 0
150 
151 /*
152  * CLASS B
153  */
157 #define EU868_BEACON_CHANNEL_FREQ 869525000
158 
162 #define EU868_PING_SLOT_CHANNEL_FREQ 869525000
163 
167 #define EU868_BEACON_SIZE 17
168 
172 #define EU868_RFU1_SIZE 2
173 
177 #define EU868_RFU2_SIZE 0
178 
182 #define EU868_BEACON_CHANNEL_DR DR_3
183 
187 #define EU868_BEACON_CHANNEL_BW 0
188 
192 #define EU868_PING_SLOT_CHANNEL_DR DR_3
193 
197 #define EU868_MAX_NB_BANDS 6
198 
203 #define EU868_BAND0 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 1.0 %
204 
209 #define EU868_BAND1 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 1.0 %
210 
215 #define EU868_BAND2 { 1000, EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 0.1 %
216 
221 #define EU868_BAND3 { 10 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 10.0 %
222 
227 #define EU868_BAND4 { 100 , EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 1.0 %
228 
234 #define EU868_BAND5 { 1000, EU868_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 0.1 %
235 
240 #define EU868_LC1 { 868100000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 1 }
241 
246 #define EU868_LC2 { 868300000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 1 }
247 
252 #define EU868_LC3 { 868500000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 1 }
253 
257 #define EU868_JOIN_CHANNELS ( uint16_t )( LC( 1 ) | LC( 2 ) | LC( 3 ) )
258 
262 static const uint8_t DataratesEU868[] = { 12, 11, 10, 9, 8, 7, 7, 50 };
263 
267 static const uint32_t BandwidthsEU868[] = { 125000, 125000, 125000, 125000, 125000, 125000, 250000, 0 };
268 
272 static const uint8_t MaxPayloadOfDatarateEU868[] = { 51, 51, 51, 115, 242, 242, 242, 242 };
273 
282 
289 
296 
304 void* RegionEU868GetNvmCtx( GetNvmCtxParams_t* params );
305 
315 bool RegionEU868Verify( VerifyParams_t* verify, PhyAttribute_t phyAttribute );
316 
323 void RegionEU868ApplyCFList( ApplyCFListParams_t* applyCFList );
324 
332 bool RegionEU868ChanMaskSet( ChanMaskSetParams_t* chanMaskSet );
333 
347 void RegionEU868ComputeRxWindowParameters( int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams );
348 
358 bool RegionEU868RxConfig( RxConfigParams_t* rxConfig, int8_t* datarate );
359 
371 bool RegionEU868TxConfig( TxConfigParams_t* txConfig, int8_t* txPower, TimerTime_t* txTimeOnAir );
372 
380 uint8_t RegionEU868LinkAdrReq( LinkAdrReqParams_t* linkAdrReq, int8_t* drOut, int8_t* txPowOut, uint8_t* nbRepOut, uint8_t* nbBytesParsed );
381 
389 uint8_t RegionEU868RxParamSetupReq( RxParamSetupReqParams_t* rxParamSetupReq );
390 
398 uint8_t RegionEU868NewChannelReq( NewChannelReqParams_t* newChannelReq );
399 
409 int8_t RegionEU868TxParamSetupReq( TxParamSetupReqParams_t* txParamSetupReq );
410 
418 uint8_t RegionEU868DlChannelReq( DlChannelReqParams_t* dlChannelReq );
419 
427 int8_t RegionEU868AlternateDr( int8_t currentDr, AlternateDrType_t type );
428 
441 LoRaMacStatus_t RegionEU868NextChannel( NextChanParams_t* nextChanParams, uint8_t* channel, TimerTime_t* time, TimerTime_t* aggregatedTimeOff );
442 
451 
459 bool RegionEU868ChannelsRemove( ChannelRemoveParams_t* channelRemove );
460 
467 
479 uint8_t RegionEU868ApplyDrOffset( uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset );
480 
486 void RegionEU868RxBeaconSetup( RxBeaconSetup_t* rxBeaconSetup, uint8_t* outDr );
487 
490 #ifdef __cplusplus
491 }
492 #endif
493 
494 #endif // __REGION_EU868_H__
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
RegionEU868GetPhyParam
PhyParam_t RegionEU868GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
RegionEU868ChannelsRemove
bool RegionEU868ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.
RegionEU868RxBeaconSetup
void RegionEU868RxBeaconSetup(RxBeaconSetup_t *rxBeaconSetup, uint8_t *outDr)
Sets the radio into beacon reception mode.
RegionEU868DlChannelReq
uint8_t RegionEU868DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
RegionEU868ComputeRxWindowParameters
void RegionEU868ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
RegionEU868LinkAdrReq
uint8_t RegionEU868LinkAdrReq(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
RegionEU868ApplyCFList
void RegionEU868ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
RegionEU868NextChannel
LoRaMacStatus_t RegionEU868NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
RegionEU868ChannelAdd
LoRaMacStatus_t RegionEU868ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
RegionEU868SetBandTxDone
void RegionEU868SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
NewChannelReqParams_t
Definition: Region.h:1215
RegionEU868AlternateDr
int8_t RegionEU868AlternateDr(int8_t currentDr, AlternateDrType_t type)
Alternates the datarate of the channel for the join request.
TxParamSetupReqParams_t
Definition: Region.h:1230
RegionEU868RxParamSetupReq
uint8_t RegionEU868RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
PhyAttribute_t
PhyAttribute_t
Definition: Region.h:589
RegionEU868NewChannelReq
uint8_t RegionEU868NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
RegionEU868ChanMaskSet
bool RegionEU868ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
GetNvmCtxParams_t
Definition: Region.h:1000
ChannelAddParams_t
Definition: Region.h:1318
RegionEU868SetContinuousWave
void RegionEU868SetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
RxConfigParams_t
Definition: Region.h:1079
RegionEU868ApplyDrOffset
uint8_t RegionEU868ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
ApplyCFListParams_t
Definition: Region.h:1049
RegionEU868TxConfig
bool RegionEU868TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
DlChannelReqParams_t
Definition: Region.h:1249
RegionEU868InitDefaults
void RegionEU868InitDefaults(InitDefaultsParams_t *params)
Initializes the channels masks and the channels.
TxConfigParams_t
Definition: Region.h:1126
RegionEU868Verify
bool RegionEU868Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
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
RegionEU868RxConfig
bool RegionEU868RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
RegionEU868GetNvmCtx
void * RegionEU868GetNvmCtx(GetNvmCtxParams_t *params)
Returns a pointer to the internal context and its size.
RegionEU868TxParamSetupReq
int8_t RegionEU868TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
ChannelRemoveParams_t
Definition: Region.h:1333