| SX126x-Arduino 1.3.0

RegionUS915-Hybrid.h
Go to the documentation of this file.
1
35 #ifndef __REGION_US915_HYBRID_H__
36 #define __REGION_US915_HYBRID_H__
37
38 extern "C"
39 {
40
44 #define US915_HYBRID_MAX_NB_CHANNELS 72
45
49 #define US915_HYBRID_TX_MIN_DATARATE DR_0
50
54 #define US915_HYBRID_TX_MAX_DATARATE DR_4
55
59 #define US915_HYBRID_RX_MIN_DATARATE DR_8
60
64 #define US915_HYBRID_RX_MAX_DATARATE DR_13
65
69 #define US915_HYBRID_DEFAULT_DATARATE DR_0
70
74 #define US915_HYBRID_MIN_RX1_DR_OFFSET 0
75
79 #define US915_HYBRID_MAX_RX1_DR_OFFSET 3
80
84 #define US915_HYBRID_DEFAULT_RX1_DR_OFFSET 0
85
89 #define US915_HYBRID_MIN_TX_POWER TX_POWER_10
90
94 #define US915_HYBRID_MAX_TX_POWER TX_POWER_0
95
99 #define US915_HYBRID_DEFAULT_TX_POWER TX_POWER_0
100
104 #define US915_HYBRID_DEFAULT_MAX_ERP 30.0f
105
109 #define US915_HYBRID_ADR_ACK_LIMIT 64
110
114 #define US915_HYBRID_ADR_ACK_DELAY 32
115
119 #define US915_HYBRID_DUTY_CYCLE_ENABLED 0
120
124 #define US915_HYBRID_MAX_RX_WINDOW 3000
125
129 #define US915_HYBRID_RECEIVE_DELAY1 1000
130
134 #define US915_HYBRID_RECEIVE_DELAY2 2000
135
139 #define US915_HYBRID_JOIN_ACCEPT_DELAY1 5000
140
144 #define US915_HYBRID_JOIN_ACCEPT_DELAY2 6000
145
149 #define US915_HYBRID_MAX_FCNT_GAP 16384
150
154 #define US915_HYBRID_ACKTIMEOUT 2000
155
159 #define US915_HYBRID_ACK_TIMEOUT_RND 1000
160
164 #define US915_HYBRID_RX_WND_2_FREQ 923300000
165
169 #define US915_HYBRID_RX_WND_2_DR DR_8
170
174 #define US915_HYBRID_MAX_NB_BANDS 1
175
180 #define US915_HYBRID_BAND0 \
181 { \
182 1, US915_HYBRID_MAX_TX_POWER, 0, 0 \
183 } // 100.0 %
184
188 #define US915_HYBRID_FIRST_RX1_CHANNEL ((uint32_t)923300000)
189
193 #define US915_HYBRID_LAST_RX1_CHANNEL ((uint32_t)927500000)
194
198 #define US915_HYBRID_STEPWIDTH_RX1_CHANNEL ((uint32_t)600000)
199
203 static const uint8_t DataratesUS915_HYBRID[] = {10, 9, 8, 7, 8, 0, 0, 0, 12, 11, 10, 9, 8, 7, 0, 0};
204
208 static const uint32_t BandwidthsUS915_HYBRID[] = {125000, 125000, 125000, 125000, 500000, 0, 0, 0, 500000, 500000, 500000, 500000, 500000, 500000, 0, 0};
209
213 static const int8_t DatarateOffsetsUS915_HYBRID[5][4] =
214 {
215 {DR_10, DR_9, DR_8, DR_8}, // DR_0
216 {DR_11, DR_10, DR_9, DR_8}, // DR_1
217 {DR_12, DR_11, DR_10, DR_9}, // DR_2
218 {DR_13, DR_12, DR_11, DR_10}, // DR_3
219 {DR_13, DR_13, DR_12, DR_11}, // DR_4
220 };
221
225 static const uint8_t MaxPayloadOfDatarateUS915_HYBRID[] = {11, 53, 125, 242, 242, 0, 0, 0, 53, 129, 242, 242, 242, 242, 0, 0};
226
230 static const uint8_t MaxPayloadOfDatarateRepeaterUS915_HYBRID[] = {11, 53, 125, 242, 242, 0, 0, 0, 33, 109, 222, 222, 222, 222, 0, 0};
231
239 PhyParam_t RegionUS915HybridGetPhyParam(GetPhyParams_t *getPhy);
240
246 void RegionUS915HybridSetBandTxDone(SetBandTxDoneParams_t *txDone);
247
253 void RegionUS915HybridInitDefaults(InitType_t type);
254
264 bool RegionUS915HybridVerify(VerifyParams_t *verify, PhyAttribute_t phyAttribute);
265
272 void RegionUS915HybridApplyCFList(ApplyCFListParams_t *applyCFList);
273
281 bool RegionUS915HybridChanMaskSet(ChanMaskSetParams_t *chanMaskSet);
282
296 bool RegionUS915HybridAdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter);
297
311 void RegionUS915HybridComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams);
312
322 bool RegionUS915HybridRxConfig(RxConfigParams_t *rxConfig, int8_t *datarate);
323
335 bool RegionUS915HybridTxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir);
336
352 uint8_t RegionUS915HybridLinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed);
353
361 uint8_t RegionUS915HybridRxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq);
362
370 uint8_t RegionUS915HybridNewChannelReq(NewChannelReqParams_t *newChannelReq);
371
381 int8_t RegionUS915HybridTxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq);
382
390 uint8_t RegionUS915HybridDlChannelReq(DlChannelReqParams_t *dlChannelReq);
391
399 int8_t RegionUS915HybridAlternateDr(AlternateDrParams_t *alternateDr);
400
406 void RegionUS915HybridCalcBackOff(CalcBackOffParams_t *calcBackOff);
407
422 bool RegionUS915HybridNextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff);
423
431 LoRaMacStatus_t RegionUS915HybridChannelAdd(ChannelAddParams_t *channelAdd);
432
440 bool RegionUS915HybridChannelsRemove(ChannelRemoveParams_t *channelRemove);
441
447 void RegionUS915HybridSetContinuousWave(ContinuousWaveParams_t *continuousWave);
448
460 uint8_t RegionUS915HybridApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset);
461
463 };
464 #endif // __REGION_US915_HYBRID_H__
RegionUS915HybridLinkAdrReq
uint8_t RegionUS915HybridLinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed)
The function processes a Link ADR Request.
RegionUS915HybridTxParamSetupReq
int8_t RegionUS915HybridTxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
sChannelRemoveParams
Definition: Region.h:1134
RegionUS915HybridComputeRxWindowParameters
void RegionUS915HybridComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
RegionUS915HybridAlternateDr
int8_t RegionUS915HybridAlternateDr(AlternateDrParams_t *alternateDr)
Alternates the datarate of the channel for the join request.
DR_8
#define DR_8
Definition: Region.h:207
LoRaMacStatus_t
enum eLoRaMacStatus LoRaMacStatus_t
sTxConfigParams
Definition: Region.h:916
InitType_t
enum eInitType InitType_t
sSetBandTxDoneParams
Definition: Region.h:749
DatarateOffsetsUS915_HYBRID
static const int8_t DatarateOffsetsUS915_HYBRID[5][4]
Definition: RegionUS915-Hybrid.h:213
RegionUS915HybridChannelsRemove
bool RegionUS915HybridChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.
sRxParamSetupReqParams
Definition: Region.h:982
uVerifyParams
Definition: Region.h:767
sRxConfigParams
Definition: Region.h:865
sAlternateDrParams
Definition: Region.h:1050
sNewChannelReqParams
Definition: Region.h:1001
RegionUS915HybridCalcBackOff
void RegionUS915HybridCalcBackOff(CalcBackOffParams_t *calcBackOff)
Calculates the back-off time.
sContinuousWaveParams
Definition: Region.h:1145
sAdrNextParams
Definition: Region.h:834
RegionUS915HybridTxConfig
bool RegionUS915HybridTxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
sCalcBackOffParams
Definition: Region.h:1061
DR_13
#define DR_13
Definition: Region.h:287
DataratesUS915_HYBRID
static const uint8_t DataratesUS915_HYBRID[]
Definition: RegionUS915-Hybrid.h:203
RegionUS915HybridRxConfig
bool RegionUS915HybridRxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
sApplyCFListParams
Definition: Region.h:804
RegionUS915HybridInitDefaults
void RegionUS915HybridInitDefaults(InitType_t type)
Initializes the channels masks and the channels.
sTxParamSetupReqParams
Definition: Region.h:1016
RegionUS915HybridApplyCFList
void RegionUS915HybridApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
DR_9
#define DR_9
Definition: Region.h:223
sChanMaskSetParams
Definition: Region.h:819
RegionUS915HybridChanMaskSet
bool RegionUS915HybridChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
sLinkAdrReqParams
Definition: Region.h:947
RegionUS915HybridNextChannel
bool RegionUS915HybridNextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
DR_10
#define DR_10
Definition: Region.h:239
DR_11
#define DR_11
Definition: Region.h:255
RegionUS915HybridRxParamSetupReq
uint8_t RegionUS915HybridRxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
RegionUS915HybridNewChannelReq
uint8_t RegionUS915HybridNewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
RegionUS915HybridApplyDrOffset
uint8_t RegionUS915HybridApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
sNextChanParams
Definition: Region.h:1092
MaxPayloadOfDatarateUS915_HYBRID
static const uint8_t MaxPayloadOfDatarateUS915_HYBRID[]
Definition: RegionUS915-Hybrid.h:225
uPhyParam
Definition: Region.h:697
RegionUS915HybridAdrNext
bool RegionUS915HybridAdrNext(AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter)
Calculates the next datarate to set, when ADR is on or off.
sChannelAddParams
Definition: Region.h:1119
RegionUS915HybridVerify
bool RegionUS915HybridVerify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
RegionUS915HybridDlChannelReq
uint8_t RegionUS915HybridDlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
MaxPayloadOfDatarateRepeaterUS915_HYBRID
static const uint8_t MaxPayloadOfDatarateRepeaterUS915_HYBRID[]
Definition: RegionUS915-Hybrid.h:230
sDlChannelReqParams
Definition: Region.h:1035
sGetPhyParams
Definition: Region.h:720
RegionUS915HybridChannelAdd
LoRaMacStatus_t RegionUS915HybridChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
RegionUS915HybridSetBandTxDone
void RegionUS915HybridSetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
RegionUS915HybridSetContinuousWave
void RegionUS915HybridSetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
PhyAttribute_t
enum ePhyAttribute PhyAttribute_t
TimerTime_t
uint32_t TimerTime_t
Timer time variable definition.
Definition: timer.h:68
RegionUS915HybridGetPhyParam
PhyParam_t RegionUS915HybridGetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
DR_12
#define DR_12
Definition: Region.h:271
BandwidthsUS915_HYBRID
static const uint32_t BandwidthsUS915_HYBRID[]
Definition: RegionUS915-Hybrid.h:208