| SX126x-Arduino 2.0.1

RegionRU864.h
Go to the documentation of this file.
1
35 #ifndef __REGION_RU864_H__
36 #define __REGION_RU864_H__
37
38 extern "C"
39 {
40
44 #define RU864_MAX_NB_CHANNELS 16
45
49 #define RU864_NUMB_DEFAULT_CHANNELS 8
50
54 #define RU864_NUMB_CHANNELS_CF_LIST 5
56
60 #define RU864_TX_MIN_DATARATE DR_0
61
65 #define RU864_TX_MAX_DATARATE DR_7
66
70 #define RU864_RX_MIN_DATARATE DR_0
71
75 #define RU864_RX_MAX_DATARATE DR_7
76
80 #define RU864_DEFAULT_DATARATE DR_2
81
85 #define RU864_MIN_RX1_DR_OFFSET 0
86
90 #define RU864_MAX_RX1_DR_OFFSET 7
91
95 #define RU864_DEFAULT_RX1_DR_OFFSET 0
96
100 #define RU864_MIN_TX_POWER TX_POWER_7
101
105 #define RU864_MAX_TX_POWER TX_POWER_0
106
110 #define RU864_DEFAULT_TX_POWER TX_POWER_0
111
115 #define RU864_DEFAULT_MAX_EIRP 16.0f
116
120 #define RU864_DEFAULT_ANTENNA_GAIN 2.15f
121
125 #define RU864_ADR_ACK_LIMIT 64
126
130 #define RU864_ADR_ACK_DELAY 32
131
135 #define RU864_DUTY_CYCLE_ENABLED 0
136
140 #define RU864_MAX_RX_WINDOW 3000
141
145 #define RU864_RECEIVE_DELAY1 1000
146
150 #define RU864_RECEIVE_DELAY2 2000
151
155 #define RU864_JOIN_ACCEPT_DELAY1 5000
156
160 #define RU864_JOIN_ACCEPT_DELAY2 6000
161
165 #define RU864_MAX_FCNT_GAP 16384
166
170 #define RU864_ACKTIMEOUT 2000
171
175 #define RU864_ACK_TIMEOUT_RND 1000
176
177 #if (RU864_DEFAULT_DATARATE > DR_5)
178 #error "A default DR higher than DR_5 may lead to connectivity loss."
179 #endif
180
184 #define RU864_RX_WND_2_DR DR_2
185
189 #define RU864_MAX_NB_BANDS 1
190
195 #define RU864_BAND0 \
196 { \
197 100, RU864_MAX_TX_POWER, 0, 0, 0 \
198 } // 1.0 %
199
204 #define RU864_LC1 \
205 { \
206 868900000, 0, {((DR_5 << 4) | DR_0)}, 0 \
207 }
208
213 #define RU864_LC2 \
214 { \
215 869100000, 0, {((DR_5 << 4) | DR_0)}, 0 \
216 }
217 #define RU864_LC3 \
218 { \
219 869300000, 0, {((DR_5 << 4) | DR_0)}, 0 \
220 }
221 #define RU864_LC4 \
222 { \
223 869500000, 0, {((DR_5 << 4) | DR_0)}, 0 \
224 }
225 #define RU864_LC5 \
226 { \
227 869700000, 0, {((DR_5 << 4) | DR_0)}, 0 \
228 }
229 #define RU864_LC6 \
230 { \
231 869900000, 0, {((DR_5 << 4) | DR_0)}, 0 \
232 }
233 #define RU864_LC7 \
234 { \
235 870100000, 0, {((DR_5 << 4) | DR_0)}, 0 \
236 }
237 #define RU864_LC8 \
238 { \
239 870300000, 0, {((DR_5 << 4) | DR_0)}, 0 \
240 }
241
245 #define RU864_JOIN_CHANNELS (uint16_t)(LC(1) | LC(2))
246
250 static const uint8_t DataratesRU864[] = {12, 11, 10, 9, 8, 7, 7, 50};
251
255 static const uint32_t BandwidthsRU864[] = {125000, 125000, 125000, 125000, 125000, 125000, 250000, 0};
256
261 static const uint8_t MaxPayloadOfDatarateRU864[] = {59, 59, 59, 123, 230, 230, 230, 230};
262
268 static const uint8_t MaxPayloadOfDatarateRepeaterRU864[] = {59, 59, 59, 123, 250, 250, 250, 250};
269
273 static const int8_t EffectiveRx1DrOffsetRU864[] = {0, 1, 2, 3, 4, 5, -1, -2};
274
282 PhyParam_t RegionRU864GetPhyParam(GetPhyParams_t *getPhy);
283
289 void RegionRU864SetBandTxDone(SetBandTxDoneParams_t *txDone);
290
296 void RegionRU864InitDefaults(InitType_t type);
297
307 bool RegionRU864Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute);
308
315 void RegionRU864ApplyCFList(ApplyCFListParams_t *applyCFList);
316
324 bool RegionRU864ChanMaskSet(ChanMaskSetParams_t *chanMaskSet);
325
339 bool RegionRU864AdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter);
340
354 void RegionRU864ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams);
355
365 bool RegionRU864RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate);
366
378 bool RegionRU864TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir);
379
395 uint8_t RegionRU864LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed);
396
404 uint8_t RegionRU864RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq);
405
413 uint8_t RegionRU864NewChannelReq(NewChannelReqParams_t *newChannelReq);
414
424 int8_t RegionRU864TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq);
425
433 uint8_t RegionRU864DlChannelReq(DlChannelReqParams_t *dlChannelReq);
434
442 int8_t RegionRU864AlternateDr(AlternateDrParams_t *alternateDr);
443
449 void RegionRU864CalcBackOff(CalcBackOffParams_t *calcBackOff);
450
465 bool RegionRU864NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff);
466
474 LoRaMacStatus_t RegionRU864ChannelAdd(ChannelAddParams_t *channelAdd);
475
483 bool RegionRU864ChannelsRemove(ChannelRemoveParams_t *channelRemove);
484
490 void RegionRU864SetContinuousWave(ContinuousWaveParams_t *continuousWave);
491
503 uint8_t RegionRU864ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset);
504
512 bool RegionRU864SetVersion(uint8_t version);
514 };
515 #endif // __REGION_RU864_H__
RegionRU864ChannelAdd
LoRaMacStatus_t RegionRU864ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
RegionRU864AdrNext
bool RegionRU864AdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter)
Calculates the next datarate to set, when ADR is on or off.
MaxPayloadOfDatarateRU864
static const uint8_t MaxPayloadOfDatarateRU864[]
Definition: RegionRU864.h:261
sChannelRemoveParams
Definition: Region.h:1217
RegionRU864GetPhyParam
PhyParam_t RegionRU864GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
RegionRU864DlChannelReq
uint8_t RegionRU864DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
LoRaMacStatus_t
enum eLoRaMacStatus LoRaMacStatus_t
sTxConfigParams
Definition: Region.h:999
InitType_t
enum eInitType InitType_t
sSetBandTxDoneParams
Definition: Region.h:832
sRxParamSetupReqParams
Definition: Region.h:1065
uVerifyParams
Definition: Region.h:850
sRxConfigParams
Definition: Region.h:948
RegionRU864InitDefaults
void RegionRU864InitDefaults(InitType_t type)
Initializes the channels masks and the channels.
RegionRU864RxConfig
bool RegionRU864RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
sAlternateDrParams
Definition: Region.h:1133
RegionRU864ApplyCFList
void RegionRU864ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
sNewChannelReqParams
Definition: Region.h:1084
sContinuousWaveParams
Definition: Region.h:1228
sAdrNextParams
Definition: Region.h:917
RegionRU864NewChannelReq
uint8_t RegionRU864NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
EffectiveRx1DrOffsetRU864
static const int8_t EffectiveRx1DrOffsetRU864[]
Definition: RegionRU864.h:273
sCalcBackOffParams
Definition: Region.h:1144
RegionRU864ChannelsRemove
bool RegionRU864ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.
MaxPayloadOfDatarateRepeaterRU864
static const uint8_t MaxPayloadOfDatarateRepeaterRU864[]
Definition: RegionRU864.h:268
DataratesRU864
static const uint8_t DataratesRU864[]
Definition: RegionRU864.h:250
sApplyCFListParams
Definition: Region.h:887
sTxParamSetupReqParams
Definition: Region.h:1099
RegionRU864Verify
bool RegionRU864Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
sChanMaskSetParams
Definition: Region.h:902
RegionRU864ComputeRxWindowParameters
void RegionRU864ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
sLinkAdrReqParams
Definition: Region.h:1030
RegionRU864LinkAdrReq
uint8_t RegionRU864LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed)
The function processes a Link ADR Request.
RegionRU864SetVersion
bool RegionRU864SetVersion(uint8_t version)
Adjust frequency band to RU864-1, RU864-2, RU864-3.
sNextChanParams
Definition: Region.h:1175
RegionRU864RxParamSetupReq
uint8_t RegionRU864RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
uPhyParam
Definition: Region.h:780
RegionRU864TxParamSetupReq
int8_t RegionRU864TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
RegionRU864ApplyDrOffset
uint8_t RegionRU864ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
RegionRU864TxConfig
bool RegionRU864TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
sChannelAddParams
Definition: Region.h:1202
BandwidthsRU864
static const uint32_t BandwidthsRU864[]
Definition: RegionRU864.h:255
sDlChannelReqParams
Definition: Region.h:1118
sGetPhyParams
Definition: Region.h:803
RegionRU864AlternateDr
int8_t RegionRU864AlternateDr(AlternateDrParams_t *alternateDr)
Alternates the datarate of the channel for the join request.
RegionRU864SetContinuousWave
void RegionRU864SetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
RegionRU864SetBandTxDone
void RegionRU864SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
RegionRU864ChanMaskSet
bool RegionRU864ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
PhyAttribute_t
enum ePhyAttribute PhyAttribute_t
TimerTime_t
uint32_t TimerTime_t
Timer time variable definition.
Definition: timer.h:69
RegionRU864NextChannel
bool RegionRU864NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
RegionRU864CalcBackOff
void RegionRU864CalcBackOff(CalcBackOffParams_t *calcBackOff)
Calculates the back-off time.