SX126x-Arduino
|
Implementation according to LoRaWAN Specification v1.0.2. More...
Functions | |
PhyParam_t | RegionUS915GetPhyParam (GetPhyParams_t *getPhy) |
The function gets a value of a specific phy attribute. More... | |
void | RegionUS915SetBandTxDone (SetBandTxDoneParams_t *txDone) |
Updates the last TX done parameters of the current channel. More... | |
void | RegionUS915InitDefaults (InitType_t type) |
Initializes the channels masks and the channels. More... | |
bool | RegionUS915Verify (VerifyParams_t *verify, PhyAttribute_t phyAttribute) |
Verifies a parameter. More... | |
void | RegionUS915ApplyCFList (ApplyCFListParams_t *applyCFList) |
The function parses the input buffer and sets up the channels of the CF list. More... | |
bool | RegionUS915ChanMaskSet (ChanMaskSetParams_t *chanMaskSet) |
Sets a channels mask. More... | |
bool | RegionUS915AdrNext (AdrNextParams_t *adrNext, int8_t *drOut, int8_t *txPowOut, uint32_t *adrAckCounter) |
Calculates the next datarate to set, when ADR is on or off. More... | |
void | RegionUS915ComputeRxWindowParameters (int8_t datarate, uint8_t minRxSymbols, uint32_t rxError, RxConfigParams_t *rxConfigParams) |
bool | RegionUS915RxConfig (RxConfigParams_t *rxConfig, int8_t *datarate) |
Configuration of the RX windows. More... | |
bool | RegionUS915TxConfig (TxConfigParams_t *txConfig, int8_t *txPower, TimerTime_t *txTimeOnAir) |
TX configuration. More... | |
uint8_t | RegionUS915LinkAdrReq (LinkAdrReqParams_t *linkAdrReq, int8_t *drOut, int8_t *txPowOut, uint8_t *nbRepOut, uint8_t *nbBytesParsed) |
The function processes a Link ADR Request. More... | |
uint8_t | RegionUS915RxParamSetupReq (RxParamSetupReqParams_t *rxParamSetupReq) |
The function processes a RX Parameter Setup Request. More... | |
uint8_t | RegionUS915NewChannelReq (NewChannelReqParams_t *newChannelReq) |
The function processes a Channel Request. More... | |
int8_t | RegionUS915TxParamSetupReq (TxParamSetupReqParams_t *txParamSetupReq) |
The function processes a TX ParamSetup Request. More... | |
uint8_t | RegionUS915DlChannelReq (DlChannelReqParams_t *dlChannelReq) |
The function processes a DlChannel Request. More... | |
int8_t | RegionUS915AlternateDr (AlternateDrParams_t *alternateDr) |
Alternates the datarate of the channel for the join request. More... | |
void | RegionUS915CalcBackOff (CalcBackOffParams_t *calcBackOff) |
Calculates the back-off time. More... | |
bool | RegionUS915NextChannel (NextChanParams_t *nextChanParams, uint8_t *channel, TimerTime_t *time, TimerTime_t *aggregatedTimeOff) |
Searches and set the next random available channel. More... | |
LoRaMacStatus_t | RegionUS915ChannelAdd (ChannelAddParams_t *channelAdd) |
Adds a channel. More... | |
bool | RegionUS915ChannelsRemove (ChannelRemoveParams_t *channelRemove) |
Removes a channel. More... | |
void | RegionUS915SetContinuousWave (ContinuousWaveParams_t *continuousWave) |
Sets the radio into continuous wave mode. More... | |
uint8_t | RegionUS915ApplyDrOffset (uint8_t downlinkDwellTime, int8_t dr, int8_t drOffset) |
Computes new datarate according to the given offset. More... | |
Variables | |
static const uint8_t | DataratesUS915 [] = {10, 9, 8, 7, 8, 0, 0, 0, 12, 11, 10, 9, 8, 7, 0, 0} |
static const uint32_t | BandwidthsUS915 [] = {125000, 125000, 125000, 125000, 500000, 0, 0, 0, 500000, 500000, 500000, 500000, 500000, 500000, 0, 0} |
static const int8_t | DatarateOffsetsUS915 [5][4] |
static const uint8_t | MaxPayloadOfDatarateUS915 [] = {11, 53, 125, 242, 242, 0, 0, 0, 53, 129, 242, 242, 242, 242, 0, 0} |
static const uint8_t | MaxPayloadOfDatarateRepeaterUS915 [] = {11, 53, 125, 242, 242, 0, 0, 0, 33, 109, 222, 222, 222, 222, 0, 0} |
Implementation according to LoRaWAN Specification v1.0.2.
#define US915_MAX_NB_CHANNELS 72 |
LoRaMac maximum number of channels
#define US915_TX_MIN_DATARATE DR_0 |
Minimal datarate that can be used by the node
#define US915_TX_MAX_DATARATE DR_4 |
Maximal datarate that can be used by the node
#define US915_RX_MIN_DATARATE DR_8 |
Minimal datarate that can be used by the node
#define US915_RX_MAX_DATARATE DR_13 |
Maximal datarate that can be used by the node
#define US915_DEFAULT_DATARATE DR_0 |
Default datarate used by the node
#define US915_MIN_RX1_DR_OFFSET 0 |
Minimal Rx1 receive datarate offset
#define US915_MAX_RX1_DR_OFFSET 3 |
Maximal Rx1 receive datarate offset
#define US915_DEFAULT_RX1_DR_OFFSET 0 |
Default Rx1 receive datarate offset
#define US915_MIN_TX_POWER TX_POWER_10 |
Minimal Tx output power that can be used by the node
#define US915_MAX_TX_POWER TX_POWER_0 |
Maximal Tx output power that can be used by the node
#define US915_DEFAULT_TX_POWER TX_POWER_0 |
Default Tx output power used by the node
#define US915_DEFAULT_MAX_ERP 30.0f |
Default Max ERP
#define US915_ADR_ACK_LIMIT 64 |
ADR Ack limit
#define US915_ADR_ACK_DELAY 32 |
ADR Ack delay
#define US915_DUTY_CYCLE_ENABLED 0 |
Enabled or disabled the duty cycle
#define US915_MAX_RX_WINDOW 3000 |
Maximum RX window duration
#define US915_RECEIVE_DELAY1 1000 |
Receive delay 1
#define US915_RECEIVE_DELAY2 2000 |
Receive delay 2
#define US915_JOIN_ACCEPT_DELAY1 5000 |
Join accept delay 1
#define US915_JOIN_ACCEPT_DELAY2 6000 |
Join accept delay 2
#define US915_MAX_FCNT_GAP 16384 |
Maximum frame counter gap
#define US915_ACKTIMEOUT 2000 |
Ack timeout
#define US915_ACK_TIMEOUT_RND 1000 |
Random ack timeout limits
#define US915_RX_WND_2_FREQ 923300000 |
Second reception window channel frequency definition.
#define US915_RX_WND_2_DR DR_8 |
Second reception window channel datarate definition.
#define US915_MAX_NB_BANDS 1 |
LoRaMac maximum number of bands
#define US915_BAND0 |
Band 0 definition { DutyCycle, TxMaxPower, LastTxDoneTime, TimeOff }
#define US915_FIRST_RX1_CHANNEL ((uint32_t)923300000) |
Defines the first channel for RX window 1 for US band
#define US915_LAST_RX1_CHANNEL ((uint32_t)927500000) |
Defines the last channel for RX window 1 for US band
#define US915_STEPWIDTH_RX1_CHANNEL ((uint32_t)600000) |
Defines the step width of the channels for RX window 1
PhyParam_t RegionUS915GetPhyParam | ( | GetPhyParams_t * | getPhy | ) |
The function gets a value of a specific phy attribute.
[IN] | getPhy Pointer to the function parameters. |
Returns | a structure containing the PHY parameter. |
void RegionUS915SetBandTxDone | ( | SetBandTxDoneParams_t * | txDone | ) |
Updates the last TX done parameters of the current channel.
[IN] | txDone Pointer to the function parameters. |
void RegionUS915InitDefaults | ( | InitType_t | type | ) |
Initializes the channels masks and the channels.
[IN] | type Sets the initialization type. |
bool RegionUS915Verify | ( | VerifyParams_t * | verify, |
PhyAttribute_t | phyAttribute | ||
) |
Verifies a parameter.
[IN] | verify Pointer to the function parameters. |
[IN] | type Sets the initialization type. |
Returns | true, if the parameter is valid. |
void RegionUS915ApplyCFList | ( | ApplyCFListParams_t * | applyCFList | ) |
The function parses the input buffer and sets up the channels of the CF list.
[IN] | applyCFList Pointer to the function parameters. |
bool RegionUS915ChanMaskSet | ( | ChanMaskSetParams_t * | chanMaskSet | ) |
Sets a channels mask.
[IN] | chanMaskSet Pointer to the function parameters. |
Returns | true, if the channels mask could be set. |
bool RegionUS915AdrNext | ( | AdrNextParams_t * | adrNext, |
int8_t * | drOut, | ||
int8_t * | txPowOut, | ||
uint32_t * | adrAckCounter | ||
) |
Calculates the next datarate to set, when ADR is on or off.
[IN] | adrNext Pointer to the function parameters. |
[OUT] | drOut The calculated datarate for the next TX. |
[OUT] | txPowOut The TX power for the next TX. |
[OUT] | adrAckCounter The calculated ADR acknowledgement counter. |
Returns | true, if an ADR request should be performed. |
void RegionUS915ComputeRxWindowParameters | ( | int8_t | datarate, |
uint8_t | minRxSymbols, | ||
uint32_t | rxError, | ||
RxConfigParams_t * | rxConfigParams | ||
) |
Computes the Rx window timeout and offset.
[IN] | datarate Rx window datarate index to be used |
[IN] | minRxSymbols Minimum required number of symbols to detect an Rx frame. |
[IN] | rxError System maximum timing error of the receiver. In milliseconds The receiver will turn on in a [-rxError : +rxError] ms interval around RxOffset |
[OUT]rxConfigParams | Returns updated WindowTimeout and WindowOffset fields. |
bool RegionUS915RxConfig | ( | RxConfigParams_t * | rxConfig, |
int8_t * | datarate | ||
) |
Configuration of the RX windows.
[IN] | rxConfig Pointer to the function parameters. |
[OUT] | datarate The datarate index which was set. |
Returns | true, if the configuration was applied successfully. |
bool RegionUS915TxConfig | ( | TxConfigParams_t * | txConfig, |
int8_t * | txPower, | ||
TimerTime_t * | txTimeOnAir | ||
) |
TX configuration.
[IN] | txConfig Pointer to the function parameters. |
[OUT] | txPower The tx power index which was set. |
[OUT] | txTimeOnAir The time-on-air of the frame. |
Returns | true, if the configuration was applied successfully. |
uint8_t RegionUS915LinkAdrReq | ( | LinkAdrReqParams_t * | linkAdrReq, |
int8_t * | drOut, | ||
int8_t * | txPowOut, | ||
uint8_t * | nbRepOut, | ||
uint8_t * | nbBytesParsed | ||
) |
The function processes a Link ADR Request.
[IN] | linkAdrReq Pointer to the function parameters. |
Returns | the status of the operation, according to the LoRaMAC specification. |
uint8_t RegionUS915RxParamSetupReq | ( | RxParamSetupReqParams_t * | rxParamSetupReq | ) |
The function processes a RX Parameter Setup Request.
[IN] | rxParamSetupReq Pointer to the function parameters. |
Returns | the status of the operation, according to the LoRaMAC specification. |
uint8_t RegionUS915NewChannelReq | ( | NewChannelReqParams_t * | newChannelReq | ) |
The function processes a Channel Request.
[IN] | newChannelReq Pointer to the function parameters. |
Returns | the status of the operation, according to the LoRaMAC specification. |
int8_t RegionUS915TxParamSetupReq | ( | TxParamSetupReqParams_t * | txParamSetupReq | ) |
The function processes a TX ParamSetup Request.
[IN] | txParamSetupReq Pointer to the function parameters. |
Returns | the status of the operation, according to the LoRaMAC specification. Returns -1, if the functionality is not implemented. In this case, the end node shall not process the command. |
uint8_t RegionUS915DlChannelReq | ( | DlChannelReqParams_t * | dlChannelReq | ) |
The function processes a DlChannel Request.
[IN] | dlChannelReq Pointer to the function parameters. |
Returns | the status of the operation, according to the LoRaMAC specification. |
int8_t RegionUS915AlternateDr | ( | AlternateDrParams_t * | alternateDr | ) |
Alternates the datarate of the channel for the join request.
[IN] | alternateDr Pointer to the function parameters. |
Datarate | to apply. |
void RegionUS915CalcBackOff | ( | CalcBackOffParams_t * | calcBackOff | ) |
Calculates the back-off time.
[IN] | calcBackOff Pointer to the function parameters. |
bool RegionUS915NextChannel | ( | NextChanParams_t * | nextChanParams, |
uint8_t * | channel, | ||
TimerTime_t * | time, | ||
TimerTime_t * | aggregatedTimeOff | ||
) |
Searches and set the next random available channel.
[OUT] | channel Next channel to use for TX. |
[OUT] | time Time to wait for the next transmission according to the duty cycle. |
[OUT] | aggregatedTimeOff Updates the aggregated time off. |
Function | status [1: OK, 0: Unable to find a channel on the current datarate] |
LoRaMacStatus_t RegionUS915ChannelAdd | ( | ChannelAddParams_t * | channelAdd | ) |
Adds a channel.
[IN] | channelAdd Pointer to the function parameters. |
Status | of the operation. |
bool RegionUS915ChannelsRemove | ( | ChannelRemoveParams_t * | channelRemove | ) |
Removes a channel.
[IN] | channelRemove Pointer to the function parameters. |
Returns | true, if the channel was removed successfully. |
void RegionUS915SetContinuousWave | ( | ContinuousWaveParams_t * | continuousWave | ) |
Sets the radio into continuous wave mode.
[IN] | continuousWave Pointer to the function parameters. |
uint8_t RegionUS915ApplyDrOffset | ( | uint8_t | downlinkDwellTime, |
int8_t | dr, | ||
int8_t | drOffset | ||
) |
Computes new datarate according to the given offset.
[IN] | downlinkDwellTime Downlink dwell time configuration. 0: No limit, 1: 400ms |
[IN] | dr Current datarate |
[IN] | drOffset Offset to be applied |
newDr | Computed datarate. |
|
static |
Data rates table definition
|
static |
Bandwidths table definition in Hz
|
static |
|
static |
Maximum payload with respect to the datarate index. Cannot operate with repeater.
|
static |
Maximum payload with respect to the datarate index. Can operate with repeater.