Symbols

loading...

Files

loading...

Summary Syntax Arguments References Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFot::RssAverager::Add()

ot::RssAverager::Add() method

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).

Syntax

Show:

Summary

Declaration

Definition

from link_quality.hpp:130

Error Add(int8_t aRss);

Implemented in link_quality.cpp:57

Arguments

Argument

Description

aRss

Received signal strength value (in dBm) to be added to the average.

Return value

kErrorNone New RSS value added to average successfully. kErrorInvalidArgs Value of @p aRss is `Radio::kInvalidRssi`.

References

Code

Location

Error RssAverager::Add(int8_t aRss)

link_quality.cpp:57

Error Add(int8_t aRss);

link_quality.hpp:130

Call Tree

All items filtered out

All items filtered out

Data Use

ot::RssAverager::Add() reads 7 variables and writes 2 variables:

ot::RssAverager::kPrecisionBitShift

ot::RssAverager::kCoeffBitShift

ot::RssAverager::mAverage

ot::RssAverager::mCount

ot::kErrorInvalidArgs

ot::Radio::kInvalidRssi

ot::RssAverager::Add()

ot::RssAverager::mAverage

ot::RssAverager::mCount

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Lifecycle

All items filtered out

All items filtered out