SX126x-Arduino
|
Region independent implementations which are common to all regions. More...
Classes | |
struct | sRegionCommonLinkAdrParams |
struct | sRegionCommonLinkAdrReqVerifyParams |
struct | sRegionCommonCalcBackOffParams |
Typedefs | |
typedef struct sRegionCommonLinkAdrParams | RegionCommonLinkAdrParams_t |
typedef struct sRegionCommonLinkAdrReqVerifyParams | RegionCommonLinkAdrReqVerifyParams_t |
typedef struct sRegionCommonCalcBackOffParams | RegionCommonCalcBackOffParams_t |
Functions | |
uint16_t | RegionCommonGetJoinDc (TimerTime_t elapsedTime) |
Calculates the join duty cycle. This is a generic function and valid for all regions. More... | |
uint8_t | RegionCommonValueInRange (int8_t value, int8_t min, int8_t max) |
Verifies, if a value is in a given range. This is a generic function and valid for all regions. More... | |
bool | RegionCommonChanVerifyDr (uint8_t nbChannels, uint16_t *channelsMask, int8_t dr, int8_t minDr, int8_t maxDr, ChannelParams_t *channels) |
Verifies, if a datarate is available on an active channel. This is a generic function and valid for all regions. More... | |
bool | RegionCommonChanDisable (uint16_t *channelsMask, uint8_t id, uint8_t maxChannels) |
Disables a channel in a given channels mask. This is a generic function and valid for all regions. More... | |
uint8_t | RegionCommonCountChannels (uint16_t *channelsMask, uint8_t startIdx, uint8_t stopIdx) |
Counts the number of active channels in a given channels mask. This is a generic function and valid for all regions. More... | |
void | RegionCommonChanMaskCopy (uint16_t *channelsMaskDest, uint16_t *channelsMaskSrc, uint8_t len) |
Copy a channels mask. This is a generic function and valid for all regions. More... | |
void | RegionCommonSetBandTxDone (bool joined, Band_t *band, TimerTime_t lastTxDone) |
Sets the last tx done property. This is a generic function and valid for all regions. More... | |
TimerTime_t | RegionCommonUpdateBandTimeOff (bool joined, bool dutyCycle, Band_t *bands, uint8_t nbBands) |
Updates the time-offs of the bands. This is a generic function and valid for all regions. More... | |
uint8_t | RegionCommonParseLinkAdrReq (uint8_t *payload, RegionCommonLinkAdrParams_t *parseLinkAdr) |
Parses the parameter of an LinkAdrRequest. This is a generic function and valid for all regions. More... | |
uint8_t | RegionCommonLinkAdrReqVerifyParams (RegionCommonLinkAdrReqVerifyParams_t *verifyParams, int8_t *dr, int8_t *txPow, uint8_t *nbRep) |
Verifies and updates the datarate, the TX power and the number of repetitions of a LinkAdrRequest. This depends on the configuration of ADR also. More... | |
double | RegionCommonComputeSymbolTimeLoRa (uint8_t phyDr, uint32_t bandwidth) |
Computes the symbol time for LoRa modulation. More... | |
double | RegionCommonComputeSymbolTimeFsk (uint8_t phyDr) |
Computes the symbol time for FSK modulation. More... | |
void | RegionCommonComputeRxWindowParameters (double tSymbol, uint8_t minRxSymbols, uint32_t rxError, uint32_t wakeUpTime, uint32_t *windowTimeout, int32_t *windowOffset) |
Computes the RX window timeout and the RX window offset. More... | |
int8_t | RegionCommonComputeTxPower (int8_t txPowerIndex, float maxEirp, float antennaGain) |
Computes the txPower, based on the max EIRP and the antenna gain. More... | |
void | RegionCommonCalcBackOff (RegionCommonCalcBackOffParams_t *calcBackOffParams) |
Calculates the duty cycle for the current band. More... | |
Region independent implementations which are common to all regions.
typedef struct sRegionCommonLinkAdrParams RegionCommonLinkAdrParams_t |
typedef struct sRegionCommonCalcBackOffParams RegionCommonCalcBackOffParams_t |
uint16_t RegionCommonGetJoinDc | ( | TimerTime_t | elapsedTime | ) |
Calculates the join duty cycle. This is a generic function and valid for all regions.
[IN] | elapsedTime Elapsed time since the start of the device. |
Duty | cycle restriction. |
uint8_t RegionCommonValueInRange | ( | int8_t | value, |
int8_t | min, | ||
int8_t | max | ||
) |
Verifies, if a value is in a given range. This is a generic function and valid for all regions.
[IN] | value Value to verify, if it is in range. |
[IN] | min Minimum possible value. |
[IN] | max Maximum possible value. |
Returns | 1 if the value is in range, otherwise 0. |
bool RegionCommonChanVerifyDr | ( | uint8_t | nbChannels, |
uint16_t * | channelsMask, | ||
int8_t | dr, | ||
int8_t | minDr, | ||
int8_t | maxDr, | ||
ChannelParams_t * | channels | ||
) |
Verifies, if a datarate is available on an active channel. This is a generic function and valid for all regions.
[IN] | nbChannels Number of channels. |
[IN] | channelsMask The channels mask of the region. |
[IN] | dr The datarate to verify. |
[IN] | minDr Minimum datarate. |
[IN] | maxDr Maximum datarate. |
[IN] | channels The channels of the region. |
Returns | true if the datarate is supported, false if not. |
bool RegionCommonChanDisable | ( | uint16_t * | channelsMask, |
uint8_t | id, | ||
uint8_t | maxChannels | ||
) |
Disables a channel in a given channels mask. This is a generic function and valid for all regions.
[IN] | channelsMask The channels mask of the region. |
[IN] | id The id of the channels mask to disable. |
[IN] | maxChannels Maximum number of channels. |
Returns | true if the channel could be disabled, false if not. |
uint8_t RegionCommonCountChannels | ( | uint16_t * | channelsMask, |
uint8_t | startIdx, | ||
uint8_t | stopIdx | ||
) |
Counts the number of active channels in a given channels mask. This is a generic function and valid for all regions.
[IN] | channelsMask The channels mask of the region. |
[IN] | startIdx Start index. |
[IN] | stopIdx Stop index ( the channels of this index will not be counted ). |
Returns | the number of active channels. |
void RegionCommonChanMaskCopy | ( | uint16_t * | channelsMaskDest, |
uint16_t * | channelsMaskSrc, | ||
uint8_t | len | ||
) |
Copy a channels mask. This is a generic function and valid for all regions.
[IN] | channelsMaskDest The destination channels mask. |
[IN] | channelsMaskSrc The source channels mask. |
[IN] | len The index length to copy. |
void RegionCommonSetBandTxDone | ( | bool | joined, |
Band_t * | band, | ||
TimerTime_t | lastTxDone | ||
) |
Sets the last tx done property. This is a generic function and valid for all regions.
[IN] | joined Set to true, if the node has joined the network |
[IN] | band The band to be updated. |
[IN] | lastTxDone The time of the last TX done. |
TimerTime_t RegionCommonUpdateBandTimeOff | ( | bool | joined, |
bool | dutyCycle, | ||
Band_t * | bands, | ||
uint8_t | nbBands | ||
) |
Updates the time-offs of the bands. This is a generic function and valid for all regions.
[IN] | joined Set to true, if the node has joined the network |
[IN] | dutyCycle Set to true, if the duty cycle is enabled. |
[IN] | bands A pointer to the bands. |
[IN] | nbBands The number of bands available. |
Returns | the time which must be waited to perform the next uplink. |
uint8_t RegionCommonParseLinkAdrReq | ( | uint8_t * | payload, |
RegionCommonLinkAdrParams_t * | parseLinkAdr | ||
) |
Parses the parameter of an LinkAdrRequest. This is a generic function and valid for all regions.
[IN] | payload Pointer to the payload containing the MAC commands. The payload must contain the CMD identifier, following by the parameters. |
[OUT] | parseLinkAdr The function fills the structure with the ADR parameters. |
Returns | the length of the ADR request, if a request was found. Otherwise, the function returns 0. |
uint8_t RegionCommonLinkAdrReqVerifyParams | ( | RegionCommonLinkAdrReqVerifyParams_t * | verifyParams, |
int8_t * | dr, | ||
int8_t * | txPow, | ||
uint8_t * | nbRep | ||
) |
Verifies and updates the datarate, the TX power and the number of repetitions of a LinkAdrRequest. This depends on the configuration of ADR also.
[IN] | verifyParams Pointer to a structure containing input parameters. |
[OUT] | dr The updated datarate. |
[OUT] | txPow The updated TX power. |
[OUT] | nbRep The updated number of repetitions. |
Returns | the status according to the LinkAdrRequest definition. |
double RegionCommonComputeSymbolTimeLoRa | ( | uint8_t | phyDr, |
uint32_t | bandwidth | ||
) |
Computes the symbol time for LoRa modulation.
[IN] | phyDr Physical datarate to use. |
[IN] | bandwidth Bandwidth to use. |
Returns | the symbol time. |
double RegionCommonComputeSymbolTimeFsk | ( | uint8_t | phyDr | ) |
Computes the symbol time for FSK modulation.
[IN] | phyDr Physical datarate to use. |
[IN] | bandwidth Bandwidth to use. |
Returns | the symbol time. |
void RegionCommonComputeRxWindowParameters | ( | double | tSymbol, |
uint8_t | minRxSymbols, | ||
uint32_t | rxError, | ||
uint32_t | wakeUpTime, | ||
uint32_t * | windowTimeout, | ||
int32_t * | windowOffset | ||
) |
Computes the RX window timeout and the RX window offset.
[IN] | tSymbol Symbol timeout. |
[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. |
[IN] | wakeUpTime Wakeup time of the system. |
[OUT] | windowTimeout RX window timeout. |
[OUT] | windowOffset RX window time offset to be applied to the RX delay. |
int8_t RegionCommonComputeTxPower | ( | int8_t | txPowerIndex, |
float | maxEirp, | ||
float | antennaGain | ||
) |
Computes the txPower, based on the max EIRP and the antenna gain.
[IN] | txPower TX power index. |
[IN] | maxEirp Maximum EIRP. |
[IN] | antennaGain Antenna gain. |
Returns | the physical TX power. |
void RegionCommonCalcBackOff | ( | RegionCommonCalcBackOffParams_t * | calcBackOffParams | ) |
Calculates the duty cycle for the current band.
[IN] | calcBackOffParams A pointer to the input parameters. |