ot::Radio::EnergyScan() method

Begins the energy scan sequence on the radio. Is used when radio provides OT_RADIO_CAPS_ENERGY_SCAN capability.

Syntax

Show:

Summary

Declaration

Definition

from radio.hpp:599

Error EnergyScan(uint8_t aScanChannel, uint16_t aScanDuration);

Implemented in radio.hpp:960

Arguments

Argument

Description

aScanChannel

The channel to perform the energy scan on.

aScanDuration

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

Return value

kErrorNone Successfully started scanning the channel. kErrorBusy The radio is performing energy scanning. kErrorNotImplemented The radio doesn't support energy scanning.

References

Code

Location

inline Error Radio::EnergyScan(uint8_t aScanChannel, uint16_t aScanDuration)

radio.hpp:960

inline Error Radio::EnergyScan(uint8_t, uint16_t) { return kErrorNotImplemented; }

radio.hpp:1073

Error EnergyScan(uint8_t aScanChannel, uint16_t aScanDuration);

radio.hpp:599

Call Tree

ot::Radio::EnergyScan() calls 2 functions:

ot::Radio::EnergyScan()

otPlatRadioEnergyScan()

ot::Radio::GetInstancePtr() const

Data Use

ot::Radio::EnergyScan() reads 1 variable:

ot::kErrorNotImplemented

ot::Radio::EnergyScan()

Class Tree

All items filtered out

Override Tree

All items filtered out

Implementations

All items filtered out

Instances

Lifecycle

All items filtered out