| SX126x-Arduino 2.0.1

RegionEU433.h
Go to the documentation of this file.
1
35 #ifndef __REGION_EU433_H__
36 #define __REGION_EU433_H__
37
38 extern "C"
39 {
40
44 #define EU433_MAX_NB_CHANNELS 16
45
49 #define EU433_NUMB_DEFAULT_CHANNELS 3
50
54 #define EU433_NUMB_CHANNELS_CF_LIST 5
55
59 #define EU433_TX_MIN_DATARATE DR_0
60
64 #define EU433_TX_MAX_DATARATE DR_7
65
69 #define EU433_RX_MIN_DATARATE DR_0
70
74 #define EU433_RX_MAX_DATARATE DR_7
75
79 #define EU433_DEFAULT_DATARATE DR_0
80
84 #define EU433_MIN_RX1_DR_OFFSET 0
85
89 #define EU433_MAX_RX1_DR_OFFSET 5
90
94 #define EU433_DEFAULT_RX1_DR_OFFSET 0
95
99 #define EU433_MIN_TX_POWER TX_POWER_5
100
104 #define EU433_MAX_TX_POWER TX_POWER_0
105
109 #define EU433_DEFAULT_TX_POWER TX_POWER_0
110
114 #define EU433_DEFAULT_MAX_EIRP 12.15f
115
119 #define EU433_DEFAULT_ANTENNA_GAIN 2.15f
120
124 #define EU433_ADR_ACK_LIMIT 64
125
129 #define EU433_ADR_ACK_DELAY 32
130
134 #define EU433_DUTY_CYCLE_ENABLED 1
135
139 #define EU433_MAX_RX_WINDOW 3000
140
144 #define EU433_RECEIVE_DELAY1 1000
145
149 #define EU433_RECEIVE_DELAY2 2000
150
154 #define EU433_JOIN_ACCEPT_DELAY1 5000
155
159 #define EU433_JOIN_ACCEPT_DELAY2 6000
160
164 #define EU433_MAX_FCNT_GAP 16384
165
169 #define EU433_ACKTIMEOUT 2000
170
174 #define EU433_ACK_TIMEOUT_RND 1000
175
179 #if (EU433_DEFAULT_DATARATE > DR_5)
180 #error "A default DR higher than DR_5 may lead to connectivity loss."
181 #endif
182
186 #define EU433_RX_WND_2_FREQ 434665000
187
191 #define EU433_RX_WND_2_DR DR_0
192
196 #define EU433_MAX_NB_BANDS 1
197
202 #define EU433_BAND0 \
203 { \
204 100, EU433_MAX_TX_POWER, 0, 0 \
205 } // 1.0 %
206
211 #define EU433_LC1 \
212 { \
213 433175000, 0, {((DR_5 << 4) | DR_0)}, 0 \
214 }
215
220 #define EU433_LC2 \
221 { \
222 433375000, 0, {((DR_5 << 4) | DR_0)}, 0 \
223 }
224
229 #define EU433_LC3 \
230 { \
231 433575000, 0, {((DR_5 << 4) | DR_0)}, 0 \
232 }
233
237 #define EU433_JOIN_CHANNELS (uint16_t)(LC(1) | LC(2) | LC(3))
238
242 static const uint8_t DataratesEU433[] = {12, 11, 10, 9, 8, 7, 7, 50};
243
247 static const uint32_t BandwidthsEU433[] = {125000, 125000, 125000, 125000, 125000, 125000, 250000, 0};
248
252 static const uint8_t MaxPayloadOfDatarateEU433[] = {51, 51, 51, 115, 242, 242, 242, 242};
253
257 static const uint8_t MaxPayloadOfDatarateRepeaterEU433[] = {51, 51, 51, 115, 222, 222, 222, 222};
258
266 PhyParam_t RegionEU433GetPhyParam(GetPhyParams_t *getPhy);
267
273 void RegionEU433SetBandTxDone(SetBandTxDoneParams_t *txDone);
274
280 void RegionEU433InitDefaults(InitType_t type);
281
291 bool RegionEU433Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute);
292
299 void RegionEU433ApplyCFList(ApplyCFListParams_t *applyCFList);
300
308 bool RegionEU433ChanMaskSet(ChanMaskSetParams_t *chanMaskSet);
309
323 bool RegionEU433AdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter);
324
338 void RegionEU433ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams);
339
349 bool RegionEU433RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate);
350
362 bool RegionEU433TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir);
363
379 uint8_t RegionEU433LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed);
380
388 uint8_t RegionEU433RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq);
389
397 uint8_t RegionEU433NewChannelReq(NewChannelReqParams_t *newChannelReq);
398
408 int8_t RegionEU433TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq);
409
417 uint8_t RegionEU433DlChannelReq(DlChannelReqParams_t *dlChannelReq);
418
426 int8_t RegionEU433AlternateDr(AlternateDrParams_t *alternateDr);
427
433 void RegionEU433CalcBackOff(CalcBackOffParams_t *calcBackOff);
434
449 bool RegionEU433NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff);
450
458 LoRaMacStatus_t RegionEU433ChannelAdd(ChannelAddParams_t *channelAdd);
459
467 bool RegionEU433ChannelsRemove(ChannelRemoveParams_t *channelRemove);
468
474 void RegionEU433SetContinuousWave(ContinuousWaveParams_t *continuousWave);
475
487 uint8_t RegionEU433ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset);
488
490 };
491 #endif // __REGION_EU433_H__
RegionEU433RxParamSetupReq
uint8_t RegionEU433RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
sChannelRemoveParams
Definition: Region.h:1217
LoRaMacStatus_t
enum eLoRaMacStatus LoRaMacStatus_t
sTxConfigParams
Definition: Region.h:999
InitType_t
enum eInitType InitType_t
sSetBandTxDoneParams
Definition: Region.h:832
RegionEU433TxConfig
bool RegionEU433TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
sRxParamSetupReqParams
Definition: Region.h:1065
RegionEU433ApplyCFList
void RegionEU433ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
RegionEU433InitDefaults
void RegionEU433InitDefaults(InitType_t type)
Initializes the channels masks and the channels.
uVerifyParams
Definition: Region.h:850
sRxConfigParams
Definition: Region.h:948
RegionEU433GetPhyParam
PhyParam_t RegionEU433GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
RegionEU433LinkAdrReq
uint8_t RegionEU433LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed)
The function processes a Link ADR Request.
sAlternateDrParams
Definition: Region.h:1133
sNewChannelReqParams
Definition: Region.h:1084
RegionEU433SetContinuousWave
void RegionEU433SetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
sContinuousWaveParams
Definition: Region.h:1228
sAdrNextParams
Definition: Region.h:917
RegionEU433NewChannelReq
uint8_t RegionEU433NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
sCalcBackOffParams
Definition: Region.h:1144
RegionEU433ComputeRxWindowParameters
void RegionEU433ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
DataratesEU433
static const uint8_t DataratesEU433[]
Definition: RegionEU433.h:242
sApplyCFListParams
Definition: Region.h:887
sTxParamSetupReqParams
Definition: Region.h:1099
sChanMaskSetParams
Definition: Region.h:902
RegionEU433SetBandTxDone
void RegionEU433SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
RegionEU433Verify
bool RegionEU433Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
sLinkAdrReqParams
Definition: Region.h:1030
BandwidthsEU433
static const uint32_t BandwidthsEU433[]
Definition: RegionEU433.h:247
RegionEU433NextChannel
bool RegionEU433NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
RegionEU433AdrNext
bool RegionEU433AdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter)
Calculates the next datarate to set, when ADR is on or off.
RegionEU433AlternateDr
int8_t RegionEU433AlternateDr(AlternateDrParams_t *alternateDr)
Alternates the datarate of the channel for the join request.
RegionEU433ChanMaskSet
bool RegionEU433ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
MaxPayloadOfDatarateEU433
static const uint8_t MaxPayloadOfDatarateEU433[]
Definition: RegionEU433.h:252
RegionEU433CalcBackOff
void RegionEU433CalcBackOff(CalcBackOffParams_t *calcBackOff)
Calculates the back-off time.
sNextChanParams
Definition: Region.h:1175
uPhyParam
Definition: Region.h:780
RegionEU433DlChannelReq
uint8_t RegionEU433DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
RegionEU433ChannelAdd
LoRaMacStatus_t RegionEU433ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
MaxPayloadOfDatarateRepeaterEU433
static const uint8_t MaxPayloadOfDatarateRepeaterEU433[]
Definition: RegionEU433.h:257
sChannelAddParams
Definition: Region.h:1202
sDlChannelReqParams
Definition: Region.h:1118
sGetPhyParams
Definition: Region.h:803
RegionEU433RxConfig
bool RegionEU433RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
PhyAttribute_t
enum ePhyAttribute PhyAttribute_t
TimerTime_t
uint32_t TimerTime_t
Timer time variable definition.
Definition: timer.h:69
RegionEU433ApplyDrOffset
uint8_t RegionEU433ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
RegionEU433TxParamSetupReq
int8_t RegionEU433TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
RegionEU433ChannelsRemove
bool RegionEU433ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.