Back to Connectedhomeip

YAML Pseudo-clusters

docs/testing/yaml_pseudocluster.md

1.5.1.03.9 KB
Original Source
<!--- This file is automatically generated by a script. DO NOT HAND-EDIT THIS FILE. Script: generate_pseudo_cluster_doc_tables.py -->

YAML Pseudo-clusters

CommissionerCommands

commandargsarg typearg optional
PairWithCodenodeId
payload
discoverOncenode_id
char_string
booleanfalse
false
true
UnpairnodeIdnode_idfalse
GetCommissionerNodeId
GetCommissionerNodeIdResponsenodeIdnode_idfalse
GetCommissionerRootCertificate
GetCommissionerRootCertificateResponseRCACOCTET_STRINGfalse
IssueNocChainElements
nodeIdoctet_string
node_idfalse
false
IssueNocChainResponseNOC
ICAC
RCAC
IPKoctet_string
octet_string
octet_string
octet_stringfalse
false
false
false

DelayCommands

commandargsarg typearg optional
WaitForCommissioning
WaitForCommissioneenodeId
expireExistingSessionnode_id
boolfalse
true
WaitForMsmsint16ufalse
WaitForMessageregisterKey
messagechar_string
char_stringfalse
false

DiscoveryCommands

commandargsarg typearg optional
FindCommissionable
FindCommissionableByShortDiscriminatorvalueint16ufalse
FindCommissionableByLongDiscriminatorvalueint16ufalse
FindCommissionableByCommissioningMode
FindCommissionableByVendorIdvaluevendor_idfalse
FindCommissionableByDeviceTypevaluedevtype_idfalse
FindCommissioner
FindCommissionerByVendorIdvaluevendor_idfalse
FindCommissionerByDeviceTypevaluedevtype_idfalse
FindResponsehostName
instanceName
longDiscriminator
shortDiscriminator
vendorId
productId
commissioningMode
deviceType
deviceName
rotatingId
rotatingIdLen
pairingHint
pairingInstruction
supportsTcp
numIPs
port
mrpRetryIntervalIdle
mrpRetryIntervalActive
mrpRetryActiveThreshold
isICDOperatingAsLITchar_string
char_string
int16u
int16u
vendor_id
int16u
int8u
devtype_id
char_string
octet_string
int64u
int16u
char_string
boolean
int8u
int16u
int32u
int32u
int16u
booleanfalse
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
true
true
true
true

EqualityCommands

commandargsarg typearg optional
BooleanEqualsValue1
Value2boolean
booleanfalse
false
SignedNumberEqualsValue1
Value2int64s
int64sfalse
false
UnsignedNumberEqualsValue1
Value2int64u
int64ufalse
false
EqualityResponseEqualsboolfalse

LogCommands

commandargsarg typearg optional
Logmessagechar_stringfalse
UserPromptmessage
expectedValuechar_string
char_stringfalse
true

SystemCommands

commandargsarg typearg optional
StartregisterKey
discriminator
port
minCommissioningTimeout
kvs
filepath
otaDownloadPath
endUserSupportLogPath
networkDiagnosticsLogPath
crashLogPathchar_string
int16u
int16u
int16u
char_string
char_string
char_string
char_string
char_string
char_stringtrue
true
true
true
true
true
true
true
true
true
StopregisterKeychar_stringtrue
RebootregisterKeychar_stringtrue
FactoryResetregisterKeychar_stringtrue
CreateOtaImageotaImageFilePath
rawImageFilePath
rawImageContentchar_string
char_string
char_stringfalse
false
false
CompareFilesfile1
file2char_string
char_stringfalse
false
CreateFilefilePath
fileContentchar_string
char_stringfalse
false
DeleteFilefilePathchar_stringfalse