LoRaMAC  4.6.0
Documentation of the API
RegionCN470.h
Go to the documentation of this file.
1 
37 #ifndef __REGION_CN470_H__
38 #define __REGION_CN470_H__
39 
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44 
45 #include "region/Region.h"
46 
50 #define CN470_MAX_NB_CHANNELS 96
51 
55 #define CN470_TX_MIN_DATARATE DR_1
56 
60 #define CN470_TX_MAX_DATARATE DR_5
61 
65 #define CN470_RX_MIN_DATARATE DR_1
66 
70 #define CN470_RX_MAX_DATARATE DR_5
71 
75 #define CN470_DEFAULT_DATARATE DR_1
76 
80 #define CN470_MIN_RX1_DR_OFFSET 0
81 
85 #define CN470_MAX_RX1_DR_OFFSET 5
86 
90 #define CN470_MIN_TX_POWER TX_POWER_7
91 
95 #define CN470_MAX_TX_POWER TX_POWER_0
96 
100 #define CN470_DEFAULT_TX_POWER TX_POWER_0
101 
105 #define CN470_DEFAULT_MAX_EIRP 19.15f
106 
110 #define CN470_DEFAULT_ANTENNA_GAIN 2.15f
111 
115 #define CN470_DUTY_CYCLE_ENABLED 0
116 
120 #define CN470_MAX_RX_WINDOW 3000
121 
125 #define CN470_RX_WND_2_DR DR_1
126 
130 #define CN470_DEFAULT_UPLINK_DWELL_TIME 0
131 
132 /*
133  * CLASS B
134  */
135 
139 #define CN470_BEACON_SIZE 19
140 
144 #define CN470_RFU1_SIZE 2
145 
149 #define CN470_RFU2_SIZE 1
150 
154 #define CN470_BEACON_CHANNEL_DR DR_2
155 
159 #define CN470_BEACON_CHANNEL_BW 0
160 
164 #define CN470_PING_SLOT_CHANNEL_DR DR_2
165 
169 #define CN470_MAX_NB_BANDS 1
170 
175 #define CN470_BAND0 { 1, CN470_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 100.0 %
176 
180 #define CN470_FIRST_RX1_CHANNEL ( (uint32_t) 500300000 )
181 
185 #define CN470_LAST_RX1_CHANNEL ( (uint32_t) 509700000 )
186 
190 #define CN470_STEPWIDTH_RX1_CHANNEL ( (uint32_t) 200000 )
191 
192 #define CN470_DEFAULT_DR_RANGE { .Value = ( CN470_TX_MAX_DATARATE << 4 ) | CN470_TX_MIN_DATARATE }
193 
194 #define CN470_COMMON_JOIN_CHANNELS \
195 { \
196  { .Frequency = 470900000, .Rx1Frequency = 484500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
197  { .Frequency = 472500000, .Rx1Frequency = 486100000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
198  { .Frequency = 474100000, .Rx1Frequency = 487700000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
199  { .Frequency = 475700000, .Rx1Frequency = 489300000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
200  { .Frequency = 504100000, .Rx1Frequency = 490900000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
201  { .Frequency = 505700000, .Rx1Frequency = 492500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
202  { .Frequency = 507300000, .Rx1Frequency = 494100000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
203  { .Frequency = 508900000, .Rx1Frequency = 495700000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
204 \
205  { .Frequency = 479900000, .Rx1Frequency = 479900000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
206  { .Frequency = 499900000, .Rx1Frequency = 499900000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
207 \
208  { .Frequency = 470300000, .Rx1Frequency = 492500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
209  { .Frequency = 472300000, .Rx1Frequency = 492500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
210  { .Frequency = 474300000, .Rx1Frequency = 492500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
211  { .Frequency = 476300000, .Rx1Frequency = 492500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
212  { .Frequency = 478300000, .Rx1Frequency = 492500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
213 \
214  { .Frequency = 480300000, .Rx1Frequency = 502500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
215  { .Frequency = 482300000, .Rx1Frequency = 502500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
216  { .Frequency = 484300000, .Rx1Frequency = 502500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
217  { .Frequency = 486300000, .Rx1Frequency = 502500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
218  { .Frequency = 488300000, .Rx1Frequency = 502500000, CN470_DEFAULT_DR_RANGE, .Band = 0 }, \
219 }
220 
221 #define CN470_COMMON_JOIN_CHANNELS_SIZE 20
222 
223 #define CN470_JOIN_CHANNELS { 0xFFFF, 0x000F }
224 
228 static const uint8_t DataratesCN470[] = { 12, 11, 10, 9, 8, 7, 7, 50 };
229 
233 static const uint32_t BandwidthsCN470[] = { 125000, 125000, 125000, 125000, 125000, 125000, 500000, 0 };
234 
238 static const int8_t DatarateOffsetsCN470[8][6] =
239 {
240  { DR_0, DR_0, DR_0, DR_0, DR_0, DR_0 }, // DR_0
241  { DR_1, DR_1, DR_1, DR_1, DR_1, DR_1 }, // DR_1
242  { DR_2, DR_1, DR_1, DR_1, DR_1, DR_1 }, // DR_2
243  { DR_3, DR_2, DR_1, DR_1, DR_1, DR_1 }, // DR_3
244  { DR_4, DR_3, DR_2, DR_1, DR_1, DR_1 }, // DR_4
245  { DR_5, DR_4, DR_3, DR_2, DR_1, DR_1 }, // DR_5
246  { DR_6, DR_5, DR_4, DR_3, DR_2, DR_1 }, // DR_6
247  { DR_7, DR_6, DR_5, DR_4, DR_3, DR_2 }, // DR_7
248 };
249 
253 static const uint8_t MaxPayloadOfDatarateCN470[] = { 0, 23, 86, 184, 242, 242, 242, 242 };
254 
263 
270 
277 
287 bool RegionCN470Verify( VerifyParams_t* verify, PhyAttribute_t phyAttribute );
288 
295 void RegionCN470ApplyCFList( ApplyCFListParams_t* applyCFList );
296 
304 bool RegionCN470ChanMaskSet( ChanMaskSetParams_t* chanMaskSet );
305 
319 void RegionCN470ComputeRxWindowParameters( int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams );
320 
330 bool RegionCN470RxConfig( RxConfigParams_t* rxConfig, int8_t* datarate );
331 
343 bool RegionCN470TxConfig( TxConfigParams_t* txConfig, int8_t* txPower, TimerTime_t* txTimeOnAir );
344 
352 uint8_t RegionCN470LinkAdrReq( LinkAdrReqParams_t* linkAdrReq, int8_t* drOut, int8_t* txPowOut, uint8_t* nbRepOut, uint8_t* nbBytesParsed );
353 
361 uint8_t RegionCN470RxParamSetupReq( RxParamSetupReqParams_t* rxParamSetupReq );
362 
370 int8_t RegionCN470NewChannelReq( NewChannelReqParams_t* newChannelReq );
371 
381 int8_t RegionCN470TxParamSetupReq( TxParamSetupReqParams_t* txParamSetupReq );
382 
390 int8_t RegionCN470DlChannelReq( DlChannelReqParams_t* dlChannelReq );
391 
399 int8_t RegionCN470AlternateDr( int8_t currentDr, AlternateDrType_t type );
400 
413 LoRaMacStatus_t RegionCN470NextChannel( NextChanParams_t* nextChanParams, uint8_t* channel, TimerTime_t* time, TimerTime_t* aggregatedTimeOff );
414 
423 
431 bool RegionCN470ChannelsRemove( ChannelRemoveParams_t* channelRemove );
432 
444 uint8_t RegionCN470ApplyDrOffset( uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset );
445 
451  void RegionCN470RxBeaconSetup( RxBeaconSetup_t* rxBeaconSetup, uint8_t* outDr );
452 
455 #ifdef __cplusplus
456 }
457 #endif
458 
459 #endif // __REGION_CN470_H__
RegionCN470ComputeRxWindowParameters
void RegionCN470ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
AlternateDrType_t
AlternateDrType_t
Definition: Region.h:756
Region.h
Region implementation.
GetPhyParams_t
Definition: Region.h:409
DR_6
#define DR_6
Definition: LoRaMacTypes.h:173
LoRaMacStatus_t
LoRaMacStatus_t
Definition: LoRaMac.h:2345
RegionCN470RxBeaconSetup
void RegionCN470RxBeaconSetup(RxBeaconSetup_t *rxBeaconSetup, uint8_t *outDr)
Sets the radio into beacon reception mode.
RegionCN470TxParamSetupReq
int8_t RegionCN470TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
RegionCN470NewChannelReq
int8_t RegionCN470NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
DR_2
#define DR_2
Definition: LoRaMacTypes.h:109
RegionCN470SetBandTxDone
void RegionCN470SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
DR_1
#define DR_1
Definition: LoRaMacTypes.h:93
ChanMaskSetParams_t
Definition: Region.h:549
RegionCN470AlternateDr
int8_t RegionCN470AlternateDr(int8_t currentDr, AlternateDrType_t type)
Alternates the datarate of the channel for the join request.
NextChanParams_t
Definition: Region.h:771
RxBeaconSetup_t
Definition: Region.h:836
RegionCN470ChanMaskSet
bool RegionCN470ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
NewChannelReqParams_t
Definition: Region.h:707
RegionCN470Verify
bool RegionCN470Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
RegionCN470RxParamSetupReq
uint8_t RegionCN470RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
TxParamSetupReqParams_t
Definition: Region.h:722
DR_4
#define DR_4
Definition: LoRaMacTypes.h:141
RegionCN470ChannelAdd
LoRaMacStatus_t RegionCN470ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
DR_5
#define DR_5
Definition: LoRaMacTypes.h:157
PhyAttribute_t
PhyAttribute_t
Definition: Region.h:85
DR_3
#define DR_3
Definition: LoRaMacTypes.h:125
RegionCN470TxConfig
bool RegionCN470TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
RegionCN470DlChannelReq
int8_t RegionCN470DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
ChannelAddParams_t
Definition: Region.h:810
RegionCN470InitDefaults
void RegionCN470InitDefaults(InitDefaultsParams_t *params)
Initializes the channels masks and the channels.
RegionCN470LinkAdrReq
uint8_t RegionCN470LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed)
The function processes a Link ADR Request.
RxConfigParams_t
Definition: Region.h:564
RegionCN470ApplyCFList
void RegionCN470ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
DR_0
#define DR_0
Definition: LoRaMacTypes.h:77
ApplyCFListParams_t
Definition: Region.h:533
DlChannelReqParams_t
Definition: Region.h:741
RegionCN470GetPhyParam
PhyParam_t RegionCN470GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
TxConfigParams_t
Definition: Region.h:618
DR_7
#define DR_7
Definition: LoRaMacTypes.h:189
InitDefaultsParams_t
Definition: Region.h:473
SetBandTxDoneParams_t
Definition: Region.h:446
RxParamSetupReqParams_t
Definition: Region.h:688
VerifyParams_t
Definition: Region.h:496
PhyParam_t
Definition: Region.h:378
RegionCN470RxConfig
bool RegionCN470RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
RegionCN470NextChannel
LoRaMacStatus_t RegionCN470NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
RegionCN470ApplyDrOffset
uint8_t RegionCN470ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
ChannelRemoveParams_t
Definition: Region.h:825
RegionCN470ChannelsRemove
bool RegionCN470ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.