LoRaMAC  4.4.5
Documentation of the API
RegionCN779.h
Go to the documentation of this file.
1 
37 #ifndef __REGION_CN779_H__
38 #define __REGION_CN779_H__
39 
40 #ifdef __cplusplus
41 extern "C"
42 {
43 #endif
44 
45 #include "region/Region.h"
46 
50 #define CN779_MAX_NB_CHANNELS 16
51 
55 #define CN779_NUMB_DEFAULT_CHANNELS 3
56 
60 #define CN779_NUMB_CHANNELS_CF_LIST 5
61 
65 #define CN779_TX_MIN_DATARATE DR_0
66 
70 #define CN779_TX_MAX_DATARATE DR_7
71 
75 #define CN779_RX_MIN_DATARATE DR_0
76 
80 #define CN779_RX_MAX_DATARATE DR_7
81 
85 #define CN779_DEFAULT_DATARATE DR_0
86 
90 #define CN779_MIN_RX1_DR_OFFSET 0
91 
95 #define CN779_MAX_RX1_DR_OFFSET 5
96 
100 #define CN779_MIN_TX_POWER TX_POWER_5
101 
105 #define CN779_MAX_TX_POWER TX_POWER_0
106 
110 #define CN779_DEFAULT_TX_POWER TX_POWER_0
111 
115 #define CN779_DEFAULT_MAX_EIRP 12.15f
116 
120 #define CN779_DEFAULT_ANTENNA_GAIN 2.15f
121 
125 #define CN779_DUTY_CYCLE_ENABLED 1
126 
130 #define CN779_MAX_RX_WINDOW 3000
131 
135 #if ( CN779_DEFAULT_DATARATE > DR_5 )
136 #error "A default DR higher than DR_5 may lead to connectivity loss."
137 #endif
138 
142 #define CN779_RX_WND_2_FREQ 786000000
143 
147 #define CN779_RX_WND_2_DR DR_0
148 
152 #define CN779_DEFAULT_UPLINK_DWELL_TIME 0
153 
154 /*
155  * CLASS B
156  */
160 #define CN779_BEACON_CHANNEL_FREQ 785000000
161 
165 #define CN779_PING_SLOT_CHANNEL_FREQ 785000000
166 
170 #define CN779_BEACON_SIZE 17
171 
175 #define CN779_RFU1_SIZE 2
176 
180 #define CN779_RFU2_SIZE 0
181 
185 #define CN779_BEACON_CHANNEL_DR DR_3
186 
190 #define CN779_BEACON_CHANNEL_BW 0
191 
195 #define CN779_PING_SLOT_CHANNEL_DR DR_3
196 
200 #define CN779_MAX_NB_BANDS 1
201 
206 #define CN779_BAND0 { 100, CN779_MAX_TX_POWER, 0, 0, 0, 0, 0 } // 1.0 %
207 
212 #define CN779_LC1 { 779500000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
213 
217 #define CN779_LC2 { 779700000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
218 
223 #define CN779_LC3 { 779900000, 0, { ( ( DR_5 << 4 ) | DR_0 ) }, 0 }
224 
228 #define CN779_JOIN_CHANNELS ( uint16_t )( LC( 1 ) | LC( 2 ) | LC( 3 ) )
229 
233 static const uint8_t DataratesCN779[] = { 12, 11, 10, 9, 8, 7, 7, 50 };
234 
238 static const uint32_t BandwidthsCN779[] = { 125000, 125000, 125000, 125000, 125000, 125000, 250000, 0 };
239 
243 static const uint8_t MaxPayloadOfDatarateCN779[] = { 51, 51, 51, 115, 242, 242, 242, 242 };
244 
253 
260 
267 
275 void* RegionCN779GetNvmCtx( GetNvmCtxParams_t* params );
276 
286 bool RegionCN779Verify( VerifyParams_t* verify, PhyAttribute_t phyAttribute );
287 
294 void RegionCN779ApplyCFList( ApplyCFListParams_t* applyCFList );
295 
303 bool RegionCN779ChanMaskSet( ChanMaskSetParams_t* chanMaskSet );
304 
318 void RegionCN779ComputeRxWindowParameters( int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams );
319 
329 bool RegionCN779RxConfig( RxConfigParams_t* rxConfig, int8_t* datarate );
330 
342 bool RegionCN779TxConfig( TxConfigParams_t* txConfig, int8_t* txPower, TimerTime_t* txTimeOnAir );
343 
351 uint8_t RegionCN779LinkAdrReq( LinkAdrReqParams_t* linkAdrReq, int8_t* drOut, int8_t* txPowOut, uint8_t* nbRepOut, uint8_t* nbBytesParsed );
352 
360 uint8_t RegionCN779RxParamSetupReq( RxParamSetupReqParams_t* rxParamSetupReq );
361 
369 uint8_t RegionCN779NewChannelReq( NewChannelReqParams_t* newChannelReq );
370 
380 int8_t RegionCN779TxParamSetupReq( TxParamSetupReqParams_t* txParamSetupReq );
381 
389 uint8_t RegionCN779DlChannelReq( DlChannelReqParams_t* dlChannelReq );
390 
398 int8_t RegionCN779AlternateDr( int8_t currentDr, AlternateDrType_t type );
399 
412 LoRaMacStatus_t RegionCN779NextChannel( NextChanParams_t* nextChanParams, uint8_t* channel, TimerTime_t* time, TimerTime_t* aggregatedTimeOff );
413 
422 
430 bool RegionCN779ChannelsRemove( ChannelRemoveParams_t* channelRemove );
431 
438 
450 uint8_t RegionCN779ApplyDrOffset( uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset );
451 
457  void RegionCN779RxBeaconSetup( RxBeaconSetup_t* rxBeaconSetup, uint8_t* outDr );
458 
461 #ifdef __cplusplus
462 }
463 #endif
464 
465 #endif // __REGION_CN779_H__
AlternateDrType_t
AlternateDrType_t
Definition: Region.h:1264
Region.h
Region implementation.
GetPhyParams_t
Definition: Region.h:921
LoRaMacStatus_t
LoRaMacStatus_t
Definition: LoRaMac.h:2153
RegionCN779ApplyDrOffset
uint8_t RegionCN779ApplyDrOffset(uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset)
Computes new datarate according to the given offset.
RegionCN779RxConfig
bool RegionCN779RxConfig(RxConfigParams_t *rxConfig, int8_t *datarate)
Configuration of the RX windows.
RegionCN779AlternateDr
int8_t RegionCN779AlternateDr(int8_t currentDr, AlternateDrType_t type)
Alternates the datarate of the channel for the join request.
RegionCN779SetContinuousWave
void RegionCN779SetContinuousWave(ContinuousWaveParams_t *continuousWave)
Sets the radio into continuous wave mode.
ChanMaskSetParams_t
Definition: Region.h:1064
ContinuousWaveParams_t
Definition: Region.h:1344
NextChanParams_t
Definition: Region.h:1279
RxBeaconSetup_t
Definition: Region.h:1375
RegionCN779RxParamSetupReq
uint8_t RegionCN779RxParamSetupReq(RxParamSetupReqParams_t *rxParamSetupReq)
The function processes a RX Parameter Setup Request.
NewChannelReqParams_t
Definition: Region.h:1215
RegionCN779ChanMaskSet
bool RegionCN779ChanMaskSet(ChanMaskSetParams_t *chanMaskSet)
Sets a channels mask.
TxParamSetupReqParams_t
Definition: Region.h:1230
PhyAttribute_t
PhyAttribute_t
Definition: Region.h:589
RegionCN779Verify
bool RegionCN779Verify(VerifyParams_t *verify, PhyAttribute_t phyAttribute)
Verifies a parameter.
GetNvmCtxParams_t
Definition: Region.h:1000
RegionCN779ChannelAdd
LoRaMacStatus_t RegionCN779ChannelAdd(ChannelAddParams_t *channelAdd)
Adds a channel.
ChannelAddParams_t
Definition: Region.h:1318
RegionCN779ChannelsRemove
bool RegionCN779ChannelsRemove(ChannelRemoveParams_t *channelRemove)
Removes a channel.
RegionCN779NextChannel
LoRaMacStatus_t RegionCN779NextChannel(NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff)
Searches and set the next random available channel.
RegionCN779SetBandTxDone
void RegionCN779SetBandTxDone(SetBandTxDoneParams_t *txDone)
Updates the last TX done parameters of the current channel.
RxConfigParams_t
Definition: Region.h:1079
RegionCN779TxParamSetupReq
int8_t RegionCN779TxParamSetupReq(TxParamSetupReqParams_t *txParamSetupReq)
The function processes a TX ParamSetup Request.
RegionCN779GetNvmCtx
void * RegionCN779GetNvmCtx(GetNvmCtxParams_t *params)
Returns a pointer to the internal context and its size.
RegionCN779TxConfig
bool RegionCN779TxConfig(TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir)
TX configuration.
ApplyCFListParams_t
Definition: Region.h:1049
DlChannelReqParams_t
Definition: Region.h:1249
RegionCN779GetPhyParam
PhyParam_t RegionCN779GetPhyParam(GetPhyParams_t *getPhy)
The function gets a value of a specific phy attribute.
TxConfigParams_t
Definition: Region.h:1126
RegionCN779InitDefaults
void RegionCN779InitDefaults(InitDefaultsParams_t *params)
Initializes the channels masks and the channels.
RegionCN779LinkAdrReq
uint8_t RegionCN779LinkAdrReq(LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed)
The function processes a Link ADR Request.
RegionCN779DlChannelReq
uint8_t RegionCN779DlChannelReq(DlChannelReqParams_t *dlChannelReq)
The function processes a DlChannel Request.
InitDefaultsParams_t
Definition: Region.h:985
RegionCN779RxBeaconSetup
void RegionCN779RxBeaconSetup(RxBeaconSetup_t *rxBeaconSetup, uint8_t *outDr)
Sets the radio into beacon reception mode.
RegionCN779ComputeRxWindowParameters
void RegionCN779ComputeRxWindowParameters(int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams)
SetBandTxDoneParams_t
Definition: Region.h:958
RxParamSetupReqParams_t
Definition: Region.h:1196
VerifyParams_t
Definition: Region.h:1012
PhyParam_t
Definition: Region.h:890
RegionCN779NewChannelReq
uint8_t RegionCN779NewChannelReq(NewChannelReqParams_t *newChannelReq)
The function processes a Channel Request.
RegionCN779ApplyCFList
void RegionCN779ApplyCFList(ApplyCFListParams_t *applyCFList)
The function parses the input buffer and sets up the channels of the CF list.
ChannelRemoveParams_t
Definition: Region.h:1333