LoRaMAC  4.6.0
Documentation of the API
RegionIN865.h
Go to the documentation of this file.
1 
37 #ifndef __REGION_IN865_H__
38 #define __REGION_IN865_H__
39 
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44 
45 #include "region/Region.h"
46 
50 #define IN865_MAX_NB_CHANNELS 16
51 
55 #define IN865_NUMB_DEFAULT_CHANNELS 3
56 
60 #define IN865_NUMB_CHANNELS_CF_LIST 5
61 
65 #define IN865_TX_MIN_DATARATE DR_0
66 
70 #define IN865_TX_MAX_DATARATE DR_7
71 
75 #define IN865_RX_MIN_DATARATE DR_0
76 
80 #define IN865_RX_MAX_DATARATE DR_7
81 
85 #define IN865_DEFAULT_DATARATE DR_0
86 
90 #define IN865_MIN_RX1_DR_OFFSET 0
91 
95 #define IN865_MAX_RX1_DR_OFFSET 7
96 
100 #define IN865_MIN_TX_POWER TX_POWER_10
101 
105 #define IN865_MAX_TX_POWER TX_POWER_0
106 
110 #define IN865_DEFAULT_TX_POWER TX_POWER_0
111 
115 #define IN865_DEFAULT_MAX_EIRP 30.0f
116 
120 #define IN865_DEFAULT_ANTENNA_GAIN 2.15f
121 
125 #define IN865_DUTY_CYCLE_ENABLED 0
126 
130 #define IN865_MAX_RX_WINDOW 3000
131 
132 #if ( IN865_DEFAULT_DATARATE > DR_5 )
133 #error "A default DR higher than DR_5 may lead to connectivity loss."
134 #endif
135 
139 #define IN865_RX_WND_2_FREQ 866550000
140 
144 #define IN865_RX_WND_2_DR DR_2
145 
149 #define IN865_DEFAULT_UPLINK_DWELL_TIME 0
150 
151 /*
152  * CLASS B
153  */
157 #define IN865_BEACON_CHANNEL_FREQ 866550000
158 
162 #define IN865_PING_SLOT_CHANNEL_FREQ 866550000
163 
167 #define IN865_BEACON_SIZE 19
168 
172 #define IN865_RFU1_SIZE 0
173 
177 #define IN865_RFU2_SIZE 3
178 
182 #define IN865_BEACON_CHANNEL_DR DR_4
183 
187 #define IN865_BEACON_CHANNEL_BW 0
188 
192 #define IN865_PING_SLOT_CHANNEL_DR DR_4
193 
197 #define IN865_MAX_NB_BANDS 1
198 
203 #define IN865_BAND0 { 1 , IN865_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 100.0 %
204 
209 #define IN865_LC1 { 865062500, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
210 
215 #define IN865_LC2 { 865402500, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
216 
221 #define IN865_LC3 { 865985000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
222 
226 #define IN865_JOIN_CHANNELS ( uint16_t )( LC( 1 ) | LC( 2 ) | LC( 3 ) )
227 
231 #define IN865_DR_RFU_VALUE { 0, 0, 0, 0, 0, 0, 0, 0 }
232 
236 static const uint8_t DataratesIN865[] = { 12, 11, 10, 9, 8, 7, 7, 50 };
237 
241 static const uint32_t BandwidthsIN865[] = { 125000, 125000, 125000, 125000, 125000, 125000, 250000, 0 };
242 
246 static const uint8_t MaxPayloadOfDatarateIN865[] = { 51, 51, 51, 115, 242, 242, 242, 242 };
247 
251 static const int8_t EffectiveRx1DrOffsetIN865[8][8] =
252 {
253  { DR_0 , DR_0 , DR_0 , DR_0 , DR_0 , DR_0 , DR_1 , DR_2 }, // DR_0
254  { DR_1 , DR_0 , DR_0 , DR_0 , DR_0 , DR_0 , DR_2 , DR_3 }, // DR_1
255  { DR_2 , DR_1 , DR_0 , DR_0 , DR_0 , DR_0 , DR_3 , DR_4 }, // DR_2
256  { DR_3 , DR_2 , DR_1 , DR_0 , DR_0 , DR_0 , DR_4 , DR_5 }, // DR_3
257  { DR_4 , DR_3 , DR_2 , DR_1 , DR_0 , DR_0 , DR_5 , DR_5 }, // DR_4
258  { DR_5 , DR_4 , DR_3 , DR_2 , DR_1 , DR_0 , DR_5 , DR_7 }, // DR_5
259  IN865_DR_RFU_VALUE , // DR_6
260  { DR_7 , DR_5 , DR_5 , DR_4 , DR_3 , DR_2 , DR_7 , DR_7 }, // DR_7
261 };
262 
271 
278 
285 
295 bool RegionIN865Verify( VerifyParams_t* verify, PhyAttribute_t phyAttribute );
296 
303 void RegionIN865ApplyCFList( ApplyCFListParams_t* applyCFList );
304 
312 bool RegionIN865ChanMaskSet( ChanMaskSetParams_t* chanMaskSet );
313 
327 void RegionIN865ComputeRxWindowParameters( int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams );
328 
338 bool RegionIN865RxConfig( RxConfigParams_t* rxConfig, int8_t* datarate );
339 
351 bool RegionIN865TxConfig( TxConfigParams_t* txConfig, int8_t* txPower, TimerTime_t* txTimeOnAir );
352 
360 uint8_t RegionIN865LinkAdrReq( LinkAdrReqParams_t* linkAdrReq, int8_t* drOut, int8_t* txPowOut, uint8_t* nbRepOut, uint8_t* nbBytesParsed );
361 
369 uint8_t RegionIN865RxParamSetupReq( RxParamSetupReqParams_t* rxParamSetupReq );
370 
378 int8_t RegionIN865NewChannelReq( NewChannelReqParams_t* newChannelReq );
379 
389 int8_t RegionIN865TxParamSetupReq( TxParamSetupReqParams_t* txParamSetupReq );
390 
398 int8_t RegionIN865DlChannelReq( DlChannelReqParams_t* dlChannelReq );
399 
407 int8_t RegionIN865AlternateDr( int8_t currentDr, AlternateDrType_t type );
408 
421 LoRaMacStatus_t RegionIN865NextChannel( NextChanParams_t* nextChanParams, uint8_t* channel, TimerTime_t* time, TimerTime_t* aggregatedTimeOff );
422 
431 
439 bool RegionIN865ChannelsRemove( ChannelRemoveParams_t* channelRemove );
440 
452 uint8_t RegionIN865ApplyDrOffset( uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset );
453 
459  void RegionIN865RxBeaconSetup( RxBeaconSetup_t* rxBeaconSetup, uint8_t* outDr );
460 
463 #ifdef __cplusplus
464 }
465 #endif
466 
467 #endif // __REGION_IN865_H__
AlternateDrType_t
AlternateDrType_t
Definition: Region.h:756
Region.h
Region implementation.
GetPhyParams_t
Definition: Region.h:409
LoRaMacStatus_t
LoRaMacStatus_t
Definition: LoRaMac.h:2345
DR_2
#define DR_2
Definition: LoRaMacTypes.h:109
RegionIN865LinkAdrReq
uint8_t RegionIN865LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed)
The function processes a Link ADR Request.
DR_1
#define DR_1
Definition: LoRaMacTypes.h:93
ChanMaskSetParams_t
Definition: Region.h:549
NextChanParams_t
Definition: Region.h:771
RegionIN865ChannelAdd
LoRaMacStatus_t RegionIN865ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
RxBeaconSetup_t
Definition: Region.h:836
IN865_DR_RFU_VALUE
#define IN865_DR_RFU_VALUE
Definition: RegionIN865.h:231
RegionIN865NewChannelReq
int8_t RegionIN865NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
RegionIN865ChanMaskSet
bool RegionIN865ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
RegionIN865DlChannelReq
int8_t RegionIN865DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
RegionIN865AlternateDr
int8_t RegionIN865AlternateDr(int8_t currentDr, AlternateDrType_t type)
Alternates the datarate of the channel for the join request.
NewChannelReqParams_t
Definition: Region.h:707
RegionIN865InitDefaults
void RegionIN865InitDefaults(InitDefaultsParams_t *params)
Initializes the channels masks and the channels.
TxParamSetupReqParams_t
Definition: Region.h:722
RegionIN865GetPhyParam
PhyParam_t RegionIN865GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
DR_4
#define DR_4
Definition: LoRaMacTypes.h:141
DR_5
#define DR_5
Definition: LoRaMacTypes.h:157
PhyAttribute_t
PhyAttribute_t
Definition: Region.h:85
RegionIN865SetBandTxDone
void RegionIN865SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
DR_3
#define DR_3
Definition: LoRaMacTypes.h:125
RegionIN865NextChannel
LoRaMacStatus_t RegionIN865NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
ChannelAddParams_t
Definition: Region.h:810
RegionIN865TxParamSetupReq
int8_t RegionIN865TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
RxConfigParams_t
Definition: Region.h:564
DR_0
#define DR_0
Definition: LoRaMacTypes.h:77
ApplyCFListParams_t
Definition: Region.h:533
DlChannelReqParams_t
Definition: Region.h:741
RegionIN865RxParamSetupReq
uint8_t RegionIN865RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
TxConfigParams_t
Definition: Region.h:618
RegionIN865ComputeRxWindowParameters
void RegionIN865ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
RegionIN865RxBeaconSetup
void RegionIN865RxBeaconSetup(RxBeaconSetup_t *rxBeaconSetup, uint8_t *outDr)
Sets the radio into beacon reception mode.
DR_7
#define DR_7
Definition: LoRaMacTypes.h:189
RegionIN865TxConfig
bool RegionIN865TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
RegionIN865ApplyCFList
void RegionIN865ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
RegionIN865Verify
bool RegionIN865Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
InitDefaultsParams_t
Definition: Region.h:473
SetBandTxDoneParams_t
Definition: Region.h:446
RegionIN865ApplyDrOffset
uint8_t RegionIN865ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
RxParamSetupReqParams_t
Definition: Region.h:688
VerifyParams_t
Definition: Region.h:496
PhyParam_t
Definition: Region.h:378
RegionIN865ChannelsRemove
bool RegionIN865ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.
RegionIN865RxConfig
bool RegionIN865RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
ChannelRemoveParams_t
Definition: Region.h:825