Symbols

Files

SourceVuESP-IDF Framework and ExamplesESP-IDFot::Cli::Dataset

ot::Cli::Dataset class

Implements the Dataset CLI interpreter.

Syntax

Show:

Summary

Declaration

from cli_dataset.hpp:51

Fields

Field

ot::Cli::Dataset::sDatasetTlvs

Methods

OutputActiveTimestamp()

@cli dataset activetimestamp (get, set)

 dataset activetimestamp
 123456789
 Done
 

 dataset activetimestamp 123456789
 Done
 

@cparam dataset activetimestamp [@ca{timestamp}] Pass the optional `timestamp` argument to set the active timestamp. @par Gets or sets #otOperationalDataset::mActiveTimestamp.

OutputChannel()

@cli dataset channel (get,set)

 dataset channel
 12
 Done
 

 dataset channel 12
 Done
 

@cparam dataset channel [@ca{channel-num}] Use the optional `channel-num` argument to set the channel. @par Gets or sets #otOperationalDataset::mChannel.

OutputWakeupChannel()

@cli dataset wakeupchannel (get,set)

 dataset wakeupchannel
 13
 Done
 

 dataset wakeupchannel 13
 Done
 

@cparam dataset wakeupchannel [@ca{channel-num}] Use the optional `channel-num` argument to set the wake-up channel. @par Gets or sets #otOperationalDataset::mWakeupChannel.

OutputChannelMask()

@cli dataset channelmask (get,set)

 dataset channelmask
 0x07fff800
 Done
 

 dataset channelmask 0x07fff800
 Done
 

@cparam dataset channelmask [@ca{channel-mask}] Use the optional `channel-mask` argument to set the channel mask. @par Gets or sets #otOperationalDataset::mChannelMask.

OutputDelay()

@cli dataset delay (get,set)

 dataset delay
 1000
 Done
 

 dataset delay 1000
 Done
 

@cparam dataset delay [@ca{delay}] Use the optional `delay` argument to set the delay timer value. @par Gets or sets #otOperationalDataset::mDelay. @sa otDatasetSetDelayTimerMinimal.

OutputExtendedPanId()

@cli dataset extpanid (get,set)

 dataset extpanid
 000db80123456789
 Done
 

 dataset extpanid 000db80123456789
 Done
 

@cparam dataset extpanid [@ca{extpanid}] Use the optional `extpanid` argument to set the Extended Personal Area Network ID. @par Gets or sets #otOperationalDataset::mExtendedPanId.

OutputMeshLocalPrefix()

@cli dataset meshlocalprefix (get,set)

 dataset meshlocalprefix
 fd00:db8:0:0::/64
 Done
 

 dataset meshlocalprefix fd00:db8:0:0::
 Done
 

@cparam dataset meshlocalprefix [@ca{meshlocalprefix}] Use the optional `meshlocalprefix` argument to set the Mesh-Local Prefix. @par Gets or sets #otOperationalDataset::mMeshLocalPrefix.

OutputNetworkKey()

@cli dataset networkkey (get,set)

 dataset networkkey
 00112233445566778899aabbccddeeff
 Done
 

 dataset networkkey 00112233445566778899aabbccddeeff
 Done
 

@cparam dataset networkkey [@ca{key}] Use the optional `key` argument to set the Network Key. @par Gets or sets #otOperationalDataset::mNetworkKey.

OutputNetworkName()

@cli dataset networkname (get,set)

 dataset networkname
 OpenThread
 Done
 

 dataset networkname OpenThread
 Done
 

@cparam dataset networkname [@ca{name}] Use the optional `name` argument to set the Network Name. @par Gets or sets #otOperationalDataset::mNetworkName.

OutputPanId()

@cli dataset panid (get,set)

 dataset panid
 0x1234
 Done
 

 dataset panid 0x1234
 Done
 

@cparam dataset panid [@ca{panid}] Use the optional `panid` argument to set the PAN ID. @par Gets or sets #otOperationalDataset::mPanId.

OutputPendingTimestamp()

@cli dataset pendingtimestamp (get,set)

 dataset pendingtimestamp
 123456789
 Done
 

 dataset pendingtimestamp 123456789
 Done
 

@cparam dataset pendingtimestamp [@ca{timestamp}] Use the optional `timestamp` argument to set the pending timestamp seconds. @par Gets or sets #otOperationalDataset::mPendingTimestamp.

OutputPskc()

@cli dataset pskc (get,set)

 dataset pskc
 67c0c203aa0b042bfb5381c47aef4d9e
 Done
 

 dataset pskc -p 123456
 Done
 

 dataset pskc 67c0c203aa0b042bfb5381c47aef4d9e
 Done
 

@cparam dataset pskc [@ca{-p} @ca{passphrase}] | [@ca{key}] For FTD only, use `-p` with the `passphrase` argument. `-p` generates a pskc from the UTF-8 encoded `passphrase` that you provide, together with the network name and extended PAN ID. If set, `-p` uses the dataset buffer; otherwise, it uses the current stack. Alternatively, you can set pskc as `key` (hex format). @par Gets or sets #otOperationalDataset::mPskc.

OutputSecurityPolicy()

@cli dataset securitypolicy (get,set)

 dataset securitypolicy
 672 onrc
 Done
 

 dataset securitypolicy 672 onrc
 Done
 

@cparam dataset securitypolicy [@ca{rotationtime} [@ca{onrcCepR}]] * Use `rotationtime` for `thrKeyRotation`, in units of hours. * Security Policy commands use the `onrcCepR` argument mappings to get and set #otSecurityPolicy members, for example `o` represents #otSecurityPolicy::mObtainNetworkKeyEnabled. @moreinfo{@dataset}. @par Gets or sets the %Dataset security policy.

ParseActiveTimestamp()

ParseChannel()

ParseWakeupChannel()

ParseChannelMask()

ParseDelay()

ParseExtendedPanId()

ParseMeshLocalPrefix()

ParseNetworkKey()

ParseNetworkName()

ParsePanId()

ParsePendingTimestamp()

ParsePskc()

ParseSecurityPolicy()

ParseTlvs()

ProcessCommand()

Process()

@cli dataset tlvs

 dataset tlvs
 0e080000000000010000000300001635060004001fffe0020...f7f8
 Done
 

@par api_copy #otDatasetConvertToTlvs.

Print()

OutputSecurityPolicy()

@cli dataset securitypolicy (get,set)

 dataset securitypolicy
 672 onrc
 Done
 

 dataset securitypolicy 672 onrc
 Done
 

ot::Cli::Dataset class

Syntax

Fields

Methods

OutputActiveTimestamp()

OutputChannel()

OutputWakeupChannel()

OutputChannelMask()

OutputDelay()

OutputExtendedPanId()

OutputMeshLocalPrefix()

OutputNetworkKey()

OutputNetworkName()

OutputPanId()

OutputPendingTimestamp()

OutputPskc()

OutputSecurityPolicy()

ParseActiveTimestamp()

ParseChannel()

ParseWakeupChannel()

ParseChannelMask()

ParseDelay()

ParseExtendedPanId()

ParseMeshLocalPrefix()

ParseNetworkKey()

ParseNetworkName()

ParsePanId()

ParsePendingTimestamp()

ParsePskc()

ParseSecurityPolicy()

ParseTlvs()

ProcessCommand()

Process()

Print()

OutputSecurityPolicy()

ParseSecurityPolicy()

LookupMapper() const

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle