ot::RssAverager class

Implements a Received Signal Strength (RSS) averager. The average is maintained using an adaptive exponentially weighted moving filter.

Syntax

Show:

Summary

Declaration

from link_quality.hpp:101

class RssAverager : public Clearable<RssAverager> { public: static constexpr uint16_t kStringSize = 10; typedef String<kStringSize> InfoString; bool HasAverage(void) const { return (mCount != 0); } Error Add(int8_t aRss); int8_t GetAverage(void) const; uint16_t GetRaw(void) const { return mAverage; } InfoString ToString(void) const; private: static constexpr uint8_t kPrecisionBitShift = 3; static constexpr uint8_t kPrecision = (1 << kPrecisionBitShift); static constexpr uint8_t kPrecisionBitMask = (kPrecision - 1); static constexpr uint8_t kCoeffBitShift = 3; uint16_t mAverage : 11; uint16_t mCount : 5; };

Fields

Field

Declared as

ot::RssAverager::kStringSize

ot::RssAverager::kPrecisionBitShift

ot::RssAverager::kPrecision

ot::RssAverager::kPrecisionBitMask

ot::RssAverager::kCoeffBitShift

ot::RssAverager::mAverage

uint16_t : 11

ot::RssAverager::mCount

uint16_t : 5

Methods

HasAverage() const

Indicates whether the averager contains an average (i.e., at least one RSS value has been added).

Add()

Adds a received signal strength (RSS) value to the average. If @p aRss is `Radio::kInvalidRssi`, it is ignored and error status kErrorInvalidArgs is returned. The value of RSS is capped at 0dBm (i.e., for any given RSS value higher than 0dBm, 0dBm is used instead).

GetAverage() const

Returns the current average signal strength value maintained by the averager.

GetRaw() const

Returns an raw/encoded version of current average signal strength value. The raw value is the average multiplied by a precision factor (currently set as -8).