Symbols

loading (4/5)...

Files

loading (4/5)...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Radio

ot::Radio class

Represents an OpenThread radio abstraction.

Syntax

Show:

Summary

Declaration

from radio.hpp:138

class Radio : public InstanceLocator, private NonCopyable { friend class Instance; public: static constexpr uint32_t kSymbolTime = OT_RADIO_SYMBOL_TIME; static constexpr uint8_t kSymbolsPerOctet = OT_RADIO_SYMBOLS_PER_OCTET; static constexpr uint32_t kPhyUsPerByte = kSymbolsPerOctet * kSymbolTime; static constexpr uint8_t kChannelPage0 = OT_RADIO_CHANNEL_PAGE_0; static constexpr uint8_t kChannelPage2 = OT_RADIO_CHANNEL_PAGE_2; #if (OPENTHREAD_CONFIG_RADIO_2P4GHZ_OQPSK_SUPPORT && OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT) static constexpr uint16_t kNumChannelPages = 2; static constexpr uint32_t kSupportedChannels = OT_RADIO_915MHZ_OQPSK_CHANNEL_MASK | OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MASK; static constexpr uint8_t kChannelMin = OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN; static constexpr uint8_t kChannelMax = OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MAX; #elif OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT static constexpr uint16_t kNumChannelPages = 1; static constexpr uint32_t kSupportedChannels = OT_RADIO_915MHZ_OQPSK_CHANNEL_MASK; static constexpr uint8_t kChannelMin = OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN; static constexpr uint8_t kChannelMax = OT_RADIO_915MHZ_OQPSK_CHANNEL_MAX; #elif OPENTHREAD_CONFIG_RADIO_2P4GHZ_OQPSK_SUPPORT static constexpr uint16_t kNumChannelPages = 1; static constexpr uint32_t kSupportedChannels = OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MASK; static constexpr uint8_t kChannelMin = OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MIN; static constexpr uint8_t kChannelMax = OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MAX; #elif OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_SUPPORT static constexpr uint16_t kNumChannelPages = 1; static constexpr uint32_t kSupportedChannels = OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MASK; static constexpr uint8_t kChannelMin = OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MIN; static constexpr uint8_t kChannelMax = OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MAX; #endif static const uint8_t kSupportedChannelPages[kNumChannelPages]; static constexpr int8_t kInvalidRssi = OT_RADIO_RSSI_INVALID; static constexpr int8_t kDefaultReceiveSensitivity = -110; static_assert((OPENTHREAD_CONFIG_RADIO_2P4GHZ_OQPSK_SUPPORT || OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT || OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_SUPPORT), "OPENTHREAD_CONFIG_RADIO_2P4GHZ_OQPSK_SUPPORT " "or OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT " "or OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_SUPPORT " "must be set to 1 to specify the radio mode"); class Callbacks : public InstanceLocator { friend class Radio; public: void HandleReceiveDone(Mac::RxFrame *aFrame, Error aError); void HandleTransmitStarted(Mac::TxFrame &aFrame); void HandleTransmitDone(Mac::TxFrame &aFrame, Mac::RxFrame *aAckFrame, Error aError); void HandleEnergyScanDone(int8_t aMaxRssi); void HandleBusLatencyChanged(void); #if OPENTHREAD_CONFIG_DIAG_ENABLE void HandleDiagsReceiveDone(Mac::RxFrame *aFrame, Error aError); void HandleDiagsTransmitDone(Mac::TxFrame &aFrame, Error aError); #endif private: explicit Callbacks(Instance &aInstance) : InstanceLocator(aInstance) { } }; explicit Radio(Instance &aInstance) : InstanceLocator(aInstance) , mCallbacks(aInstance) { } const char *GetVersionString(void); void GetIeeeEui64(Mac::ExtAddress &aIeeeEui64); otRadioCaps GetCaps(void); int8_t GetReceiveSensitivity(void) const; #if OPENTHREAD_RADIO void Init(void); #endif void SetPanId(Mac::PanId aPanId); void SetExtendedAddress(const Mac::ExtAddress &aExtAddress); void SetShortAddress(Mac::ShortAddress aShortAddress); void SetMacKey(uint8_t aKeyIdMode, uint8_t aKeyId, const Mac::KeyMaterial &aPrevKey, const Mac::KeyMaterial &aCurrKey, const Mac::KeyMaterial &aNextKey); void SetMacFrameCounter(uint32_t aMacFrameCounter) { otPlatRadioSetMacFrameCounter(GetInstancePtr(), aMacFrameCounter); } void SetMacFrameCounterIfLarger(uint32_t aMacFrameCounter) { otPlatRadioSetMacFrameCounterIfLarger(GetInstancePtr(), aMacFrameCounter); } Error GetTransmitPower(int8_t &aPower); Error SetTransmitPower(int8_t aPower); Error GetCcaEnergyDetectThreshold(int8_t &aThreshold); Error SetCcaEnergyDetectThreshold(int8_t aThreshold); bool GetPromiscuous(void); void SetPromiscuous(bool aEnable); void SetRxOnWhenIdle(bool aEnable); otRadioState GetState(void); Error Enable(void); Error Disable(void); bool IsEnabled(void); Error Sleep(void); Error Receive(uint8_t aChannel); #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE || OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE Error ReceiveAt(uint8_t aChannel, uint32_t aStart, uint32_t aDuration); #endif #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE void UpdateCslSampleTime(uint32_t aCslSampleTime); Error EnableCsl(uint32_t aCslPeriod, otShortAddress aShortAddr, const otExtAddress *aExtAddr); Error ResetCsl(void); #endif #if OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE || OPENTHREAD_CONFIG_MAC_CSL_TRANSMITTER_ENABLE || \ OPENTHREAD_CONFIG_TIME_SYNC_ENABLE uint64_t GetNow(void); uint8_t GetCslAccuracy(void); uint8_t GetCslUncertainty(void); #endif Mac::TxFrame &GetTransmitBuffer(void); Error Transmit(Mac::TxFrame &aFrame); int8_t GetRssi(void); Error EnergyScan(uint8_t aScanChannel, uint16_t aScanDuration); void EnableSrcMatch(bool aEnable); Error AddSrcMatchShortEntry(Mac::ShortAddress aShortAddress); Error AddSrcMatchExtEntry(const Mac::ExtAddress &aExtAddress); Error ClearSrcMatchShortEntry(Mac::ShortAddress aShortAddress); Error ClearSrcMatchExtEntry(const Mac::ExtAddress &aExtAddress); void ClearSrcMatchShortEntries(void); void ClearSrcMatchExtEntries(void); uint32_t GetSupportedChannelMask(void); uint32_t GetPreferredChannelMask(void); #if OPENTHREAD_CONFIG_MLE_LINK_METRICS_SUBJECT_ENABLE Error ConfigureEnhAckProbing(otLinkMetrics aLinkMetrics, const Mac::ShortAddress &aShortAddress, const Mac::ExtAddress &aExtAddress) { return otPlatRadioConfigureEnhAckProbing(GetInstancePtr(), aLinkMetrics, aShortAddress, &aExtAddress); } #endif static bool IsCslChannelValid(uint8_t aCslChannel) { return ((aCslChannel == 0) || ((kChannelMin == aCslChannel) || ((kChannelMin < aCslChannel) && (aCslChannel <= kChannelMax)))); } Error SetRegion(uint16_t aRegionCode) { return otPlatRadioSetRegion(GetInstancePtr(), aRegionCode); } Error GetRegion(uint16_t &aRegionCode) const { return otPlatRadioGetRegion(GetInstancePtr(), &aRegionCode); } static constexpr bool SupportsChannelPage(uint8_t aChannelPage) { #if OPENTHREAD_CONFIG_RADIO_2P4GHZ_OQPSK_SUPPORT && OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT return (aChannelPage == kChannelPage0) || (aChannelPage == kChannelPage2); #elif OPENTHREAD_CONFIG_RADIO_2P4GHZ_OQPSK_SUPPORT return (aChannelPage == kChannelPage0); #elif OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT return (aChannelPage == kChannelPage2); #elif OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_SUPPORT return (aChannelPage == OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_PAGE); #endif } static uint32_t ChannelMaskForPage(uint8_t aChannelPage) { uint32_t mask = 0; #if OPENTHREAD_CONFIG_RADIO_2P4GHZ_OQPSK_SUPPORT if (aChannelPage == kChannelPage0) { mask = OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MASK; } #endif #if OPENTHREAD_CONFIG_RADIO_915MHZ_OQPSK_SUPPORT if (aChannelPage == kChannelPage1) { mask = OT_RADIO_915MHZ_OQPSK_CHANNEL_MASK; } #endif #if OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_SUPPORT if (aChannelPage == OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_PAGE) { mask = OPENTHREAD_CONFIG_PLATFORM_RADIO_PROPRIETARY_CHANNEL_MASK; } #endif return mask; } private: otInstance *GetInstancePtr(void) const { return reinterpret_cast<otInstance *>(&InstanceLocator::GetInstance()); } Callbacks mCallbacks; #if OPENTHREAD_CONFIG_RADIO_STATS_ENABLE && (OPENTHREAD_FTD || OPENTHREAD_MTD) RadioStatistics mRadioStatistics; #endif };

Fields

Field

Declared as

ot::Radio::kSymbolTime

ot::Radio::kSymbolsPerOctet

ot::Radio::kPhyUsPerByte

ot::Radio::kChannelPage0

ot::Radio::kChannelPage2

ot::Radio::kNumChannelPages

ot::Radio::kSupportedChannels

ot::Radio::kChannelMin

ot::Radio::kChannelMax

ot::Radio::kSupportedChannelPages

ot::Radio::kInvalidRssi

ot::Radio::kDefaultReceiveSensitivity

ot::Radio::mCallbacks

Callbacks

Methods

GetVersionString()

Gets the radio version string.

GetIeeeEui64()

Gets the factory-assigned IEEE EUI-64 for the device.

GetCaps()

Gets the radio capabilities.

GetReceiveSensitivity() const

Gets the radio receive sensitivity value.

Init()

Initializes the states of the Thread radio.

SetPanId()

Sets the PAN ID for address filtering.

SetExtendedAddress()

Sets the Extended Address for address filtering.

SetShortAddress()

Sets the Short Address for address filtering.

SetMacKey()

Sets MAC key and key ID.

SetMacFrameCounter()

Sets the current MAC Frame Counter value.

SetMacFrameCounterIfLarger()

Sets the current MAC Frame Counter value only if the new given value is larger than the current value.

GetTransmitPower()

Gets the radio's transmit power in dBm.

SetTransmitPower()

Sets the radio's transmit power in dBm.

GetCcaEnergyDetectThreshold()

Gets the radio's CCA ED threshold in dBm.

SetCcaEnergyDetectThreshold()

Sets the radio's CCA ED threshold in dBm.

GetPromiscuous()

Gets the status of promiscuous mode.

SetPromiscuous()

Enables or disables promiscuous mode.

SetRxOnWhenIdle()

Indicates whether radio should stay in Receive or Sleep during idle periods.

GetState()

Returns the current state of the radio. Is not required by OpenThread. It may be used for debugging and/or application-specific purposes.

Enable()

Enables the radio.

Disable()

Disables the radio.

IsEnabled()

Indicates whether radio is enabled or not.

Sleep()

Transitions the radio from Receive to Sleep (turn off the radio).

Receive()

Transitions the radio from Sleep to Receive (turn on the radio).

GetNow()

Get the current radio time in microseconds referenced to a continuous monotonic local radio clock (64 bits width).

GetCslAccuracy()

Get the current accuracy, in units of ± ppm, of the clock used for scheduling CSL operations.

GetCslUncertainty()

Get the fixed uncertainty of the Device for scheduling CSL operations in units of 10 microseconds.

GetTransmitBuffer()

Gets the radio transmit frame buffer. OpenThread forms the IEEE 802.15.4 frame in this buffer then calls `Transmit()` to request transmission.

Transmit()

Starts the transmit sequence on the radio. The caller must form the IEEE 802.15.4 frame in the buffer provided by `GetTransmitBuffer()` before requesting transmission. The channel and transmit power are also included in the frame.

GetRssi()

Gets the most recent RSSI measurement.

EnergyScan()

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

EnableSrcMatch()

Enables/disables source address match feature. The source address match feature controls how the radio layer decides the "frame pending" bit for acks sent in response to data request commands from children. If disabled, the radio layer must set the "frame pending" on all acks to data request commands. If enabled, the radio layer uses the source address match table to determine whether to set or clear the "frame pending" bit in an ack to a data request command. The source address match table provides the list of children for which there is a pending frame. Either a short address or an extended/long address can be added to the source address match table.

ot::Radio class

Syntax

Fields

Methods

GetVersionString()

GetIeeeEui64()

GetCaps()

GetReceiveSensitivity() const

Init()

SetPanId()

SetExtendedAddress()

SetShortAddress()

SetMacKey()

SetMacFrameCounter()

SetMacFrameCounterIfLarger()

GetTransmitPower()

SetTransmitPower()

GetCcaEnergyDetectThreshold()

SetCcaEnergyDetectThreshold()

GetPromiscuous()

SetPromiscuous()

SetRxOnWhenIdle()

GetState()

Enable()

Disable()

IsEnabled()

Sleep()

Receive()

GetNow()

GetCslAccuracy()

GetCslUncertainty()

GetTransmitBuffer()

Transmit()

GetRssi()

EnergyScan()

EnableSrcMatch()

AddSrcMatchShortEntry()

AddSrcMatchExtEntry()

ClearSrcMatchShortEntry()

ClearSrcMatchExtEntry()

ClearSrcMatchShortEntries()

ClearSrcMatchExtEntries()

GetSupportedChannelMask()

GetPreferredChannelMask()

IsCslChannelValid()

SetRegion()

GetRegion() const

SupportsChannelPage()

ChannelMaskForPage()

GetInstancePtr() const

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle