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.

Examples

References

from examples

ot::Radio::EnergyScan() method

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle