Symbols

loading...

Files

loading...

Summary Syntax Methods References Class Tree Instances

SourceVuESP-IDF Framework and ExamplesESP-IDFot::FactoryDiags::Diags

ot::FactoryDiags::Diags class

Syntax

Show:

Summary

Declaration

from factory_diags.hpp:55

class Diags : public InstanceLocator, private NonCopyable { public: explicit Diags(Instance &aInstance); Error ProcessLine(const char *aString); Error ProcessCmd(uint8_t aArgsLength, char *aArgs[]); bool IsEnabled(void); void AlarmFired(void); void ReceiveDone(otRadioFrame *aFrame, Error aError); void TransmitDone(Error aError); void SetOutputCallback(otDiagOutputCallback aCallback, void *aContext); private: static constexpr uint8_t kMaxArgs = OPENTHREAD_CONFIG_DIAG_CMD_LINE_ARGS_MAX; struct Command { const char *mName; Error (Diags::*mCommand)(uint8_t aArgsLength, char *aArgs[]); }; struct Stats : public Clearable<Stats> { uint32_t mReceivedPackets; uint32_t mSentPackets; int8_t mFirstRssi; uint8_t mFirstLqi; int8_t mLastRssi; uint8_t mLastLqi; }; struct RawPowerSetting { static constexpr uint16_t kMaxDataSize = OPENTHREAD_CONFIG_POWER_CALIBRATION_RAW_POWER_SETTING_SIZE; static constexpr uint16_t kInfoStringSize = kMaxDataSize * 2 + 1; typedef String<kInfoStringSize> InfoString; InfoString ToString(void) const { InfoString string; string.AppendHexBytes(mData, mLength); return string; } bool operator!=(const RawPowerSetting &aOther) const { return (mLength != aOther.mLength) || (memcmp(mData, aOther.mData, mLength) != 0); } uint8_t mData[kMaxDataSize]; uint16_t mLength; }; struct PowerSettings { bool operator!=(const PowerSettings &aOther) const { return (mTargetPower != aOther.mTargetPower) || (mActualPower != aOther.mActualPower) || (mRawPowerSetting != aOther.mRawPowerSetting); } int16_t mTargetPower; int16_t mActualPower; RawPowerSetting mRawPowerSetting; }; Error ParseCmd(char *aString, uint8_t &aArgsLength, char *aArgs[]); Error ProcessChannel(uint8_t aArgsLength, char *aArgs[]); Error ProcessFrame(uint8_t aArgsLength, char *aArgs[]); Error ProcessContinuousWave(uint8_t aArgsLength, char *aArgs[]); Error ProcessGpio(uint8_t aArgsLength, char *aArgs[]); Error ProcessPower(uint8_t aArgsLength, char *aArgs[]); Error ProcessRadio(uint8_t aArgsLength, char *aArgs[]); Error ProcessRepeat(uint8_t aArgsLength, char *aArgs[]); Error ProcessPowerSettings(uint8_t aArgsLength, char *aArgs[]); Error ProcessRawPowerSetting(uint8_t aArgsLength, char *aArgs[]); Error ProcessSend(uint8_t aArgsLength, char *aArgs[]); Error ProcessStart(uint8_t aArgsLength, char *aArgs[]); Error ProcessStats(uint8_t aArgsLength, char *aArgs[]); Error ProcessStop(uint8_t aArgsLength, char *aArgs[]); Error ProcessStream(uint8_t aArgsLength, char *aArgs[]); #if OPENTHREAD_RADIO && !OPENTHREAD_RADIO_CLI Error ProcessEcho(uint8_t aArgsLength, char *aArgs[]); #endif Error GetRawPowerSetting(RawPowerSetting &aRawPowerSetting); Error GetPowerSettings(uint8_t aChannel, PowerSettings &aPowerSettings); void TransmitPacket(void); void Output(const char *aFormat, ...); void AppendErrorResult(Error aError); void ResetTxPacket(void); static Error ParseLong(char *aString, long &aLong); static Error ParseBool(char *aString, bool &aBool); static const struct Command sCommands[]; #if OPENTHREAD_FTD || OPENTHREAD_MTD || (OPENTHREAD_RADIO && OPENTHREAD_RADIO_CLI) Stats mStats; otRadioFrame *mTxPacket; uint32_t mTxPeriod; uint32_t mTxPackets; uint8_t mChannel; int8_t mTxPower; uint8_t mTxLen; bool mIsTxPacketSet; bool mRepeatActive; bool mDiagSendOn; #endif otDiagOutputCallback mOutputCallback; void *mOutputContext; };

Fields

Field

Declared as

ot::FactoryDiags::Diags::kMaxArgs

ot::FactoryDiags::Diags::sCommands

ot::FactoryDiags::Diags::mStats

ot::FactoryDiags::Diags::mTxPacket

ot::FactoryDiags::Diags::mTxPeriod

uint32_t

ot::FactoryDiags::Diags::mTxPackets

uint32_t

ot::FactoryDiags::Diags::mChannel

uint8_t

ot::FactoryDiags::Diags::mTxPower

int8_t

ot::FactoryDiags::Diags::mTxLen

uint8_t

ot::FactoryDiags::Diags::mIsTxPacketSet

bool

ot::FactoryDiags::Diags::mRepeatActive

bool

ot::FactoryDiags::Diags::mDiagSendOn

bool

ot::FactoryDiags::Diags::mOutputCallback

otDiagOutputCallback

ot::FactoryDiags::Diags::mOutputContext

void *

Methods

ProcessLine()

Processes a factory diagnostics command line.

ProcessCmd()

Processes a factory diagnostics command line.

IsEnabled()

Indicates whether or not the factory diagnostics mode is enabled.

AlarmFired()

The platform driver calls this method to notify OpenThread diagnostics module that the alarm has fired.

ReceiveDone()

The radio driver calls this method to notify OpenThread diagnostics module of a received frame.

TransmitDone()

The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed.

SetOutputCallback()

Sets the diag output callback.

ParseCmd()

ProcessChannel()

ProcessFrame()

ProcessContinuousWave()

ProcessGpio()

ProcessPower()

ProcessRadio()

ProcessRepeat()

ProcessPowerSettings()

ProcessRawPowerSetting()

ProcessSend()

ProcessStart()

ProcessStats()

ProcessStop()

ProcessStream()

GetRawPowerSetting()

GetPowerSettings()

TransmitPacket()

Output()

AppendErrorResult()

ResetTxPacket()

ParseLong()

ParseBool()

References

Code

Location

Scope

Referrer

class Diags : public InstanceLocator, private NonCopyable

factory_diags.hpp:55

return AsCoreType(aInstance).Get<FactoryDiags::Diags>().ProcessLine(aString);

diags_api.cpp:46

otDiagProcessCmdLine()

return AsCoreType(aInstance).Get<FactoryDiags::Diags>().ProcessCmd(aArgsLength, aArgs);

diags_api.cpp:51

otDiagProcessCmd()

bool otDiagIsEnabled(otInstance *aInstance) { return AsCoreType(aInstance).Get<FactoryDiags::Diags>().IsEnabled(); }

diags_api.cpp:54

otDiagIsEnabled()

AsCoreType(aInstance).Get<FactoryDiags::Diags>().SetOutputCallback(aCallback, aContext);

diags_api.cpp:58

otDiagSetOutputCallback()

const struct Diags::Command Diags::sCommands[] = {

factory_diags.cpp:180

{"channel", &Diags::ProcessChannel},

factory_diags.cpp:181

{"cw", &Diags::ProcessContinuousWave},

factory_diags.cpp:182

{"frame", &Diags::ProcessFrame},

factory_diags.cpp:183

{"gpio", &Diags::ProcessGpio},

factory_diags.cpp:184

{"power", &Diags::ProcessPower},

factory_diags.cpp:185

{"powersettings", &Diags::ProcessPowerSettings},

factory_diags.cpp:186

{"rawpowersetting", &Diags::ProcessRawPowerSetting},

factory_diags.cpp:187

{"radio", &Diags::ProcessRadio},

factory_diags.cpp:188

{"repeat", &Diags::ProcessRepeat},

factory_diags.cpp:189

{"send", &Diags::ProcessSend},

factory_diags.cpp:190

{"start", &Diags::ProcessStart},

factory_diags.cpp:191

{"stats", &Diags::ProcessStats},

factory_diags.cpp:192

{"stop", &Diags::ProcessStop},

factory_diags.cpp:193

{"stream", &Diags::ProcessStream},

factory_diags.cpp:194

Diags::Diags(Instance &aInstance)

factory_diags.cpp:197

ot::FactoryDiags::Diags::Diags()

void Diags::ResetTxPacket(void)

factory_diags.cpp:214

ot::FactoryDiags::Diags::ResetTxPacket()

Error Diags::ProcessFrame(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:229

ot::FactoryDiags::Diags::ProcessFrame()

Error Diags::ProcessChannel(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:285

ot::FactoryDiags::Diags::ProcessChannel()

Error Diags::ProcessPower(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:314

ot::FactoryDiags::Diags::ProcessPower()

Error Diags::ProcessRepeat(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:342

ot::FactoryDiags::Diags::ProcessRepeat()

Error Diags::ProcessSend(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:394

ot::FactoryDiags::Diags::ProcessSend()

Error Diags::ProcessStart(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:432

ot::FactoryDiags::Diags::ProcessStart()

Error Diags::ProcessStats(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:460

ot::FactoryDiags::Diags::ProcessStats()

Error Diags::ProcessStop(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:487

ot::FactoryDiags::Diags::ProcessStop()

void Diags::TransmitPacket(void)

factory_diags.cpp:513

ot::FactoryDiags::Diags::TransmitPacket()

Error Diags::ProcessRadio(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:532

ot::FactoryDiags::Diags::ProcessRadio()

extern "C" void otPlatDiagAlarmFired(otInstance *aInstance) { AsCoreType(aInstance).Get<Diags>().AlarmFired(); }

factory_diags.cpp:588

ot::FactoryDiags::otPlatDiagAlarmFired()

void Diags::AlarmFired(void)

factory_diags.cpp:590

ot::FactoryDiags::Diags::AlarmFired()

void Diags::ReceiveDone(otRadioFrame *aFrame, Error aError)

factory_diags.cpp:605

ot::FactoryDiags::Diags::ReceiveDone()

void Diags::TransmitDone(Error aError)

factory_diags.cpp:625

ot::FactoryDiags::Diags::TransmitDone()

Error Diags::ProcessContinuousWave(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:653

ot::FactoryDiags::Diags::ProcessContinuousWave()

Error Diags::ProcessStream(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:674

ot::FactoryDiags::Diags::ProcessStream()

Error Diags::GetPowerSettings(uint8_t aChannel, PowerSettings &aPowerSettings)

factory_diags.cpp:695

ot::FactoryDiags::Diags::GetPowerSettings()

Error Diags::ProcessPowerSettings(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:703

ot::FactoryDiags::Diags::ProcessPowerSettings()

Error Diags::GetRawPowerSetting(RawPowerSetting &aRawPowerSetting)

factory_diags.cpp:757

ot::FactoryDiags::Diags::GetRawPowerSetting()

Error Diags::ProcessRawPowerSetting(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:763

ot::FactoryDiags::Diags::ProcessRawPowerSetting()

Error Diags::ProcessGpio(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:795

ot::FactoryDiags::Diags::ProcessGpio()

void Diags::AppendErrorResult(Error aError)

factory_diags.cpp:849

ot::FactoryDiags::Diags::AppendErrorResult()

Error Diags::ParseLong(char *aString, long &aLong)

factory_diags.cpp:857

ot::FactoryDiags::Diags::ParseLong()

Error Diags::ParseBool(char *aString, bool &aBool)

factory_diags.cpp:864

ot::FactoryDiags::Diags::ParseBool()

Error Diags::ParseCmd(char *aString, uint8_t &aArgsLength, char *aArgs[])

factory_diags.cpp:877

ot::FactoryDiags::Diags::ParseCmd()

Error Diags::ProcessLine(const char *aString)

factory_diags.cpp:890

ot::FactoryDiags::Diags::ProcessLine()

Error Diags::ProcessCmd(uint8_t aArgsLength, char *aArgs[])

factory_diags.cpp:928

ot::FactoryDiags::Diags::ProcessCmd()

void Diags::SetOutputCallback(otDiagOutputCallback aCallback, void *aContext)

factory_diags.cpp:970

ot::FactoryDiags::Diags::SetOutputCallback()

void Diags::Output(const char *aFormat, ...)

factory_diags.cpp:978

ot::FactoryDiags::Diags::Output()

bool Diags::IsEnabled(void) { return otPlatDiagModeGet(); }

factory_diags.cpp:992

ot::FactoryDiags::Diags::IsEnabled()

FactoryDiags::Diags mDiags;

instance.hpp:726

ot::Instance::mDiags

template <> inline FactoryDiags::Diags &Instance::Get(void) { return mDiags; }

instance.hpp:1106

ot::Instance::Get()

Get<FactoryDiags::Diags>().ReceiveDone(aFrame, aError);

radio_callbacks.cpp:74

ot::Radio::Callbacks::HandleDiagsReceiveDone()

Get<FactoryDiags::Diags>().TransmitDone(aError);

radio_callbacks.cpp:85

ot::Radio::Callbacks::HandleDiagsTransmitDone()

Call Tree

All items filtered out

All items filtered out

Data Use

All items filtered out

All items filtered out

Class Tree

ot::FactoryDiags::Diags is inherited by 2 classess:

ot::FactoryDiags::Diags

ot::NonCopyable

ot::InstanceLocator

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Instance

Scope

Location

Project

ot::Instance::mDiags

instance.hpp:726

return

ot::Instance::Get()

instance.hpp:1106

Lifecycle

All items filtered out

All items filtered out