SX126x-Arduino  1.2.1
RegionAS923.h
Go to the documentation of this file.
1 
35 #ifndef __REGION_AS923_H__
36 #define __REGION_AS923_H__
37 
38 extern "C"
39 {
40 
44 #define AS923_MAX_NB_CHANNELS 16
45 
49 #define AS923_NUMB_DEFAULT_CHANNELS 8
50 
54 #define AS923_NUMB_CHANNELS_CF_LIST 5
55 
59 #define AS923_TX_MIN_DATARATE DR_0
60 
64 #define AS923_TX_MAX_DATARATE DR_7
65 
69 #define AS923_RX_MIN_DATARATE DR_0
70 
74 #define AS923_RX_MAX_DATARATE DR_7
75 
79 #define AS923_DEFAULT_DATARATE DR_2
80 
85 #define AS923_DWELL_LIMIT_DATARATE DR_2
86 
90 #define AS923_MIN_RX1_DR_OFFSET 0
91 
95 #define AS923_MAX_RX1_DR_OFFSET 7
96 
100 #define AS923_DEFAULT_RX1_DR_OFFSET 0
101 
105 #define AS923_MIN_TX_POWER TX_POWER_7
106 
110 #define AS923_MAX_TX_POWER TX_POWER_0
111 
115 #define AS923_DEFAULT_TX_POWER TX_POWER_0
116 
120 #define AS923_DEFAULT_UPLINK_DWELL_TIME 1
121 
125 #define AS923_DEFAULT_DOWNLINK_DWELL_TIME 1
126 
130 #define AS923_DEFAULT_MAX_EIRP 16.0f
131 
135 #define AS923_DEFAULT_ANTENNA_GAIN 2.15f
136 
140 #define AS923_ADR_ACK_LIMIT 64
141 
145 #define AS923_ADR_ACK_DELAY 32
146 
150 #define AS923_DUTY_CYCLE_ENABLED 0
151 
155 #define AS923_MAX_RX_WINDOW 3000
156 
160 #define AS923_RECEIVE_DELAY1 1000
161 
165 #define AS923_RECEIVE_DELAY2 2000
166 
170 #define AS923_JOIN_ACCEPT_DELAY1 5000
171 
175 #define AS923_JOIN_ACCEPT_DELAY2 6000
176 
180 #define AS923_MAX_FCNT_GAP 16384
181 
185 #define AS923_ACKTIMEOUT 2000
186 
190 #define AS923_ACK_TIMEOUT_RND 1000
191 
192 #if (AS923_DEFAULT_DATARATE > DR_5)
193 #error "A default DR higher than DR_5 may lead to connectivity loss."
194 #endif
195 
199 #define AS923_RX_WND_2_FREQ 923200000
200 
204 #define AS923_RX_WND_2_DR DR_2
205 
209 #define AS923_MAX_NB_BANDS 1
210 
215 #define AS923_BAND0 \
216  { \
217  100, AS923_MAX_TX_POWER, 0, 0, 0 \
218  } // 1.0 %
219 
220 #if AS923_DEFAULT_UPLINK_DWELL_TIME
221 
225 #define AS923_LC1 \
226  { \
227  923200000, 0, {((DR_5 << 4) | DR_2)}, 0 \
228  }
229 
234 #define AS923_LC2 \
235  { \
236  923400000, 0, {((DR_5 << 4) | DR_2)}, 0 \
237  }
238 #define AS923_LC3 \
239  { \
240  923600000, 0, {((DR_5 << 4) | DR_2)}, 0 \
241  }
242 #define AS923_LC4 \
243  { \
244  923800000, 0, {((DR_5 << 4) | DR_2)}, 0 \
245  }
246 #define AS923_LC5 \
247  { \
248  924000000, 0, {((DR_5 << 4) | DR_2)}, 0 \
249  }
250 #define AS923_LC6 \
251  { \
252  924200000, 0, {((DR_5 << 4) | DR_2)}, 0 \
253  }
254 #define AS923_LC7 \
255  { \
256  924400000, 0, {((DR_5 << 4) | DR_2)}, 0 \
257  }
258 #define AS923_LC8 \
259  { \
260  924600000, 0, {((DR_5 << 4) | DR_2)}, 0 \
261  }
262 #else
263 
267 #define AS923_LC1 \
268  { \
269  923200000, 0, {((DR_5 << 4) | DR_0)}, 0 \
270  }
271 
276 #define AS923_LC2 \
277  { \
278  923400000, 0, {((DR_5 << 4) | DR_0)}, 0 \
279  }
280 #define AS923_LC3 \
281  { \
282  923600000, 0, {((DR_5 << 4) | DR_0)}, 0 \
283  }
284 #define AS923_LC4 \
285  { \
286  923800000, 0, {((DR_5 << 4) | DR_0)}, 0 \
287  }
288 #define AS923_LC5 \
289  { \
290  924000000, 0, {((DR_5 << 4) | DR_0)}, 0 \
291  }
292 #define AS923_LC6 \
293  { \
294  924200000, 0, {((DR_5 << 4) | DR_0)}, 0 \
295  }
296 #define AS923_LC7 \
297  { \
298  924400000, 0, {((DR_5 << 4) | DR_0)}, 0 \
299  }
300 #define AS923_LC8 \
301  { \
302  924600000, 0, {((DR_5 << 4) | DR_0)}, 0 \
303  }
304 #endif
305 
309 #define AS923_JOIN_CHANNELS (uint16_t)(LC(1) | LC(2) | LC(3) | LC(4) | LC(5) | LC(6) | LC(7) | LC(8))
310 
314 #define AS923_RSSI_FREE_TH -85
315 
319 #define AS923_CARRIER_SENSE_TIME 6
320 
324  static const uint8_t DataratesAS923[] = {12, 11, 10, 9, 8, 7, 7, 50};
325 
329  static const uint32_t BandwidthsAS923[] = {125000, 125000, 125000, 125000, 125000, 125000, 250000, 0};
330 
335  // static const uint8_t MaxPayloadOfDatarateDwell0AS923[] = { 51, 51, 51, 115, 242, 242, 242, 242 };
336  static const uint8_t MaxPayloadOfDatarateDwell0AS923[] = {59, 59, 59, 123, 230, 230, 230, 230};
337 
343  // static const uint8_t MaxPayloadOfDatarateRepeaterDwell0AS923[] = { 51, 51, 51, 115, 222, 222, 222, 222 };
344  static const uint8_t MaxPayloadOfDatarateRepeaterDwell0AS923[] = {59, 59, 59, 123, 250, 250, 250, 250};
345 
350  // static const uint8_t MaxPayloadOfDatarateDwell1UpAS923[] = { 0, 0, 11, 53, 125, 242, 242, 242 };
351  static const uint8_t MaxPayloadOfDatarateDwell1UpAS923[] = {0, 0, 19, 61, 133, 250, 250, 250};
352 
357  // static const uint8_t MaxPayloadOfDatarateDwell1DownAS923[] = { 0, 0, 11, 53, 126, 242, 242, 242 };
358  static const uint8_t MaxPayloadOfDatarateDwell1DownAS923[] = {0, 0, 19, 61, 133, 250, 250, 250};
359 
363  static const int8_t EffectiveRx1DrOffsetAS923[] = {0, 1, 2, 3, 4, 5, -1, -2};
364 
373 
380 
387 
397  bool RegionAS923Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute);
398 
406 
415 
429  bool RegionAS923AdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter);
430 
444  void RegionAS923ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams);
445 
455  bool RegionAS923RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate);
456 
468  bool RegionAS923TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir);
469 
485  uint8_t RegionAS923LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed);
486 
495 
504 
515 
524 
533 
540 
555  bool RegionAS923NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff);
556 
565 
574 
581 
593  uint8_t RegionAS923ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset);
594 
596 };
597 #endif // __REGION_AS923_H__
RegionAS923DlChannelReq
uint8_t RegionAS923DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
sChannelRemoveParams
Definition: Region.h:1134
RegionAS923RxParamSetupReq
uint8_t RegionAS923RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
RegionAS923ChannelAdd
LoRaMacStatus_t RegionAS923ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
LoRaMacStatus_t
enum eLoRaMacStatus LoRaMacStatus_t
MaxPayloadOfDatarateDwell1UpAS923
static const uint8_t MaxPayloadOfDatarateDwell1UpAS923[]
Definition: RegionAS923.h:351
sTxConfigParams
Definition: Region.h:916
InitType_t
enum eInitType InitType_t
sSetBandTxDoneParams
Definition: Region.h:749
sRxParamSetupReqParams
Definition: Region.h:982
uVerifyParams
Definition: Region.h:767
sRxConfigParams
Definition: Region.h:865
RegionAS923GetPhyParam
PhyParam_t RegionAS923GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
BandwidthsAS923
static const uint32_t BandwidthsAS923[]
Definition: RegionAS923.h:329
RegionAS923NewChannelReq
uint8_t RegionAS923NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
RegionAS923ApplyCFList
void RegionAS923ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
sAlternateDrParams
Definition: Region.h:1050
sNewChannelReqParams
Definition: Region.h:1001
sContinuousWaveParams
Definition: Region.h:1145
RegionAS923NextChannel
bool RegionAS923NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
sAdrNextParams
Definition: Region.h:834
RegionAS923SetBandTxDone
void RegionAS923SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
sCalcBackOffParams
Definition: Region.h:1061
RegionAS923Verify
bool RegionAS923Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
sApplyCFListParams
Definition: Region.h:804
sTxParamSetupReqParams
Definition: Region.h:1016
sChanMaskSetParams
Definition: Region.h:819
RegionAS923ApplyDrOffset
uint8_t RegionAS923ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
RegionAS923SetContinuousWave
void RegionAS923SetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
RegionAS923AlternateDr
int8_t RegionAS923AlternateDr(AlternateDrParams_t *alternateDr)
Alternates the datarate of the channel for the join request.
RegionAS923CalcBackOff
void RegionAS923CalcBackOff(CalcBackOffParams_t *calcBackOff)
Calculates the back-off time.
RegionAS923InitDefaults
void RegionAS923InitDefaults(InitType_t type)
Initializes the channels masks and the channels.
DataratesAS923
static const uint8_t DataratesAS923[]
Definition: RegionAS923.h:324
RegionAS923AdrNext
bool RegionAS923AdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter)
Calculates the next datarate to set, when ADR is on or off.
MaxPayloadOfDatarateRepeaterDwell0AS923
static const uint8_t MaxPayloadOfDatarateRepeaterDwell0AS923[]
Definition: RegionAS923.h:344
sNextChanParams
Definition: Region.h:1092
EffectiveRx1DrOffsetAS923
static const int8_t EffectiveRx1DrOffsetAS923[]
Definition: RegionAS923.h:363
uPhyParam
Definition: Region.h:697
MaxPayloadOfDatarateDwell1DownAS923
static const uint8_t MaxPayloadOfDatarateDwell1DownAS923[]
Definition: RegionAS923.h:358
sChannelAddParams
Definition: Region.h:1119
RegionAS923TxParamSetupReq
int8_t RegionAS923TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
RegionAS923ChannelsRemove
bool RegionAS923ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.
sDlChannelReqParams
Definition: Region.h:1035
sGetPhyParams
Definition: Region.h:720
RegionAS923RxConfig
bool RegionAS923RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
RegionAS923ComputeRxWindowParameters
void RegionAS923ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
RegionAS923ChanMaskSet
bool RegionAS923ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
RegionAS923TxConfig
bool RegionAS923TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
MaxPayloadOfDatarateDwell0AS923
static const uint8_t MaxPayloadOfDatarateDwell0AS923[]
Definition: RegionAS923.h:336
RegionAS923LinkAdrReq
uint8_t RegionAS923LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed)
The function processes a Link ADR Request.
PhyAttribute_t
enum ePhyAttribute PhyAttribute_t
TimerTime_t
uint32_t TimerTime_t
Timer time variable definition.
Definition: timer.h:68