Symbols ![]()
loading...
Files ![]()
loading...
ot::LinkQualityInfo class
Encapsulates/stores all relevant information about quality of a link, including average received signal strength (RSS), last RSS, link margin, and link quality.
Syntax
class LinkQualityInfo : public InstanceLocatorInit
{
friend LinkQuality LinkQualityForLinkMargin(uint8_t aLinkMargin);
friend int8_t GetTypicalRssForLinkQuality(int8_t aNoiseFloor, LinkQuality aLinkQuality);
public:
static constexpr uint16_t kInfoStringSize = 50;
typedef String<kInfoStringSize> InfoString;
void Init(Instance &aInstance) { InstanceLocatorInit::Init(aInstance); }
void Clear(void);
void ClearAverageRss(void) { mRssAverager.Clear(); }
void AddRss(int8_t aRss);
int8_t GetAverageRss(void) const { return mRssAverager.GetAverage(); }
uint16_t GetAverageRssRaw(void) const { return mRssAverager.GetRaw(); }
InfoString ToInfoString(void) const;
uint8_t GetLinkMargin(void) const;
LinkQuality GetLinkQuality(void) const { return mLinkQuality; }
int8_t GetLastRss(void) const { return mLastRss; }
void AddFrameTxStatus(bool aTxStatus)
{
mFrameErrorRate.AddSample(aTxStatus, OPENTHREAD_CONFIG_FRAME_TX_ERR_RATE_AVERAGING_WINDOW);
}
void AddMessageTxStatus(bool aTxStatus)
{
mMessageErrorRate.AddSample(aTxStatus, OPENTHREAD_CONFIG_IPV6_TX_ERR_RATE_AVERAGING_WINDOW);
}
uint16_t GetFrameErrorRate(void) const { return mFrameErrorRate.GetFailureRate(); }
uint16_t GetMessageErrorRate(void) const { return mMessageErrorRate.GetFailureRate(); }
private:
static constexpr uint8_t kThreshold3 = 20;
static constexpr uint8_t kThreshold2 = 10;
static constexpr uint8_t kThreshold1 = 2;
static constexpr uint8_t kHysteresisThreshold = 2;
static constexpr int8_t kLinkQuality3LinkMargin = 50;
static constexpr int8_t kLinkQuality2LinkMargin = 15;
static constexpr int8_t kLinkQuality1LinkMargin = 5;
static constexpr int8_t kLinkQuality0LinkMargin = 0;
static constexpr uint8_t kNoLinkQuality = 0xff;
void SetLinkQuality(LinkQuality aLinkQuality) { mLinkQuality = aLinkQuality; }
static LinkQuality CalculateLinkQuality(uint8_t aLinkMargin, uint8_t aLastLinkQuality);
RssAverager mRssAverager;
LinkQuality mLinkQuality;
int8_t mLastRss;
SuccessRateTracker mFrameErrorRate;
SuccessRateTracker mMessageErrorRate;
};
Fields
Field
Declared as