ot::Mac::LinkRaw::EnergyScan() method

Starts a (single) Energy Scan on the link-layer.

Syntax

Show:

Summary

Declaration

Definition

from link_raw.hpp:160

Error EnergyScan(uint8_t aScanChannel, uint16_t aScanDuration, otLinkRawEnergyScanDone aCallback);

Implemented in link_raw.cpp:210

Arguments

Argument

Description

aScanChannel

The channel to perform the energy scan on.

aScanDuration

The duration, in milliseconds, for the channel to be scanned.

aCallback

A pointer to a function called on completion of a scanned channel.

Return value

kErrorNone Successfully started scanning the channel. kErrorBusy The radio is performing energy scanning. kErrorNotImplemented The radio doesn't support energy scanning. kErrorInvalidState If the raw link-layer isn't enabled.

References

Code

Location

Error LinkRaw::EnergyScan(uint8_t aScanChannel, uint16_t aScanDuration, otLinkRawEnergyScanDone aCallback)

link_raw.cpp:210

Error EnergyScan(uint8_t aScanChannel, uint16_t aScanDuration, otLinkRawEnergyScanDone aCallback);

link_raw.hpp:160

Call Tree

ot::Mac::LinkRaw::EnergyScan() calls 1 function:

ot::Mac::LinkRaw::EnergyScan()

ot::Mac::LinkRaw::IsEnabled() const

Data Use

ot::Mac::LinkRaw::EnergyScan() reads 2 variables and writes 1 variable:

ot::kErrorNone

ot::kErrorInvalidState

ot::Mac::LinkRaw::EnergyScan()

ot::Mac::LinkRaw::mEnergyScanDoneCallback

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out