diff --git a/docs/testing/yaml_pseudocluster.md b/docs/testing/yaml_pseudocluster.md index d6296e986d7934..49946187aa39b9 100644 --- a/docs/testing/yaml_pseudocluster.md +++ b/docs/testing/yaml_pseudocluster.md @@ -6,45 +6,69 @@ Script: generate_pseudo_cluster_doc_tables.py # YAML Pseudo-clusters -CommissionerCommands |command|args|arg type| arg optional| |:---|:---|:---|:---| + + +CommissionerCommands +|command|args|arg type| arg optional| +|:---|:---|:---|:---| |PairWithCode|nodeId
payload
discoverOnce|node_id
char_string
boolean|false
false
true| -|Unpair|nodeId|node_id|false| |GetCommissionerNodeId|||| +|Unpair|nodeId|node_id|false| +|GetCommissionerNodeId|||| |GetCommissionerNodeIdResponse|nodeId|node_id|false| |GetCommissionerRootCertificate|||| |GetCommissionerRootCertificateResponse|RCAC|OCTET_STRING|false| |IssueNocChain|Elements
nodeId|octet_string
node_id|false
false| |IssueNocChainResponse|NOC
ICAC
RCAC
IPK|octet_string
octet_string
octet_string
octet_string|false
false
false
false| -DelayCommands |command|args|arg type| arg optional| |:---|:---|:---|:---| + +DelayCommands +|command|args|arg type| arg optional| +|:---|:---|:---|:---| |WaitForCommissioning|||| |WaitForCommissionee|nodeId
expireExistingSession|node_id
bool|false
true| |WaitForMs|ms|int16u|false| |WaitForMessage|registerKey
message|char_string
char_string|false
false| -DiscoveryCommands |command|args|arg type| arg optional| |:---|:---|:---|:---| + +DiscoveryCommands +|command|args|arg type| arg optional| +|:---|:---|:---|:---| |FindCommissionable|||| |FindCommissionableByShortDiscriminator|value|int16u|false| |FindCommissionableByLongDiscriminator|value|int16u|false| |FindCommissionableByCommissioningMode|||| |FindCommissionableByVendorId|value|vendor_id|false| -|FindCommissionableByDeviceType|value|devtype_id|false| |FindCommissioner|||| +|FindCommissionableByDeviceType|value|devtype_id|false| +|FindCommissioner|||| |FindCommissionerByVendorId|value|vendor_id|false| |FindCommissionerByDeviceType|value|devtype_id|false| |FindResponse|hostName
instanceName
longDiscriminator
shortDiscriminator
vendorId
productId
commissioningMode
deviceType
deviceName
rotatingId
rotatingIdLen
pairingHint
pairingInstruction
supportsTcp
numIPs
port
mrpRetryIntervalIdle
mrpRetryIntervalActive
mrpRetryActiveThreshold
isICDOperatingAsLIT|char_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
boolean|false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
false
true
true
true
true| -EqualityCommands |command|args|arg type| arg optional| |:---|:---|:---|:---| + +EqualityCommands +|command|args|arg type| arg optional| +|:---|:---|:---|:---| |BooleanEquals|Value1
Value2|boolean
boolean|false
false| |SignedNumberEquals|Value1
Value2|int64s
int64s|false
false| |UnsignedNumberEquals|Value1
Value2|int64u
int64u|false
false| |EqualityResponse|Equals|bool|false| -LogCommands |command|args|arg type| arg optional| |:---|:---|:---|:---| + +LogCommands +|command|args|arg type| arg optional| +|:---|:---|:---|:---| |Log|message|char_string|false| |UserPrompt|message
expectedValue|char_string
char_string|false
true| -SystemCommands |command|args|arg type| arg optional| |:---|:---|:---|:---| -|Start|registerKey
discriminator
port
minCommissioningTimeout
kvs
filepath
otaDownloadPath|char_string
int16u
int16u
int16u
char_string
char_string
char_string|true
true
true
true
true
true
true| -|Stop|registerKey|char_string|true| |Reboot|registerKey|char_string|true| + +SystemCommands +|command|args|arg type| arg optional| +|:---|:---|:---|:---| +|Start|registerKey
discriminator
port
minCommissioningTimeout
kvs
filepath
otaDownloadPath
endUserSupportLogPath
networkDiagnosticsLogPath
crashLogPath|char_string
int16u
int16u
int16u
char_string
char_string
char_string
char_string
char_string
char_string|true
true
true
true
true
true
true
true
true
true| +|Stop|registerKey|char_string|true| +|Reboot|registerKey|char_string|true| |FactoryReset|registerKey|char_string|true| |CreateOtaImage|otaImageFilePath
rawImageFilePath
rawImageContent|char_string
char_string
char_string|false
false
false| |CompareFiles|file1
file2|char_string
char_string|false
false| +|CreateFile|filePath
fileContent|char_string
char_string|false
false| +|DeleteFile|filePath|char_string|false| diff --git a/docs/testing/yaml_schema.md b/docs/testing/yaml_schema.md index 9a3ee96fa2959b..8a4846bde5e4f1 100644 --- a/docs/testing/yaml_schema.md +++ b/docs/testing/yaml_schema.md @@ -6,30 +6,70 @@ Script: generate_yaml_doc_tables.py # YAML Schema -YAML schema |key | type| supports variables |:---|:---|:---| |name |str|| |PICS -|str,list|| |config | | | |  nodeId |int|| |  cluster |str|| |  -endpoint |int|| |  _variableName_ | | | |    type |type|| |  -  defaultValue |Any|| |tests | | | |  label |str|| |  identity -|str|| |  nodeId |int|Y| |  runIf |str|| |  groupId |int|Y| -|  endpoint |int|Y| |  cluster |str|| |  attribute |str|| |  -command |str|| |  event |str|| |  eventNumber |int|Y| |  disabled -|bool|| |  fabricFiltered |bool|| |  verification |str|| |  PICS -|str|| |  arguments | | | |    values | | | |      -value |NoneType,bool,int,float,dict,list|Y| |      name |str|| -|    value |NoneType,bool,int,float,dict,list|Y| |  response | |Y -| |    value |NoneType,bool,int,float,dict,list|Y| |    name -|str|| |    error |str|| |    clusterError |int|| |  -  constraints | | | |      hasValue |bool|| |    -  type |str|| |      minLength |int|| |      -maxLength |int|| |      isHexString |bool|| |      -startsWith |str|| |      endsWith |str|| |      -isUpperCase |bool|| |      isLowerCase |bool|| |    -  minValue |int,float|Y| |      maxValue |int,float|Y| -|      contains |list|| |      excludes |list|| -|      hasMasksSet |list|| |      hasMasksClear -|list|| |      notValue |NoneType,bool,int,float,list,dict|Y| -|      anyOf |list|| |    saveAs |str|| |    -saveDataVersschemaionAs |str|| |  saveResponseAs |str|| |  minInterval -|int|| |  maxInterval |int|| |  keepSubscriptions |bool|| |  -timeout |int|| |  timedInteractionTimeoutMs |int|| |  dataVersion -|list,int|Y| |  busyWaitMs |int|| |  wait |str|| +YAML schema +|key | type| supports variables +|:---|:---|:---| +|name |str|| +|PICS |str,list|| +|config | | | +|  nodeId |int|| +|  cluster |str|| +|  endpoint |int|| +|  _variableName_ | | | +|    type |type|| +|    defaultValue |Any|| +|tests | | | +|  label |str|| +|  identity |str|| +|  nodeId |int|Y| +|  runIf |str|| +|  groupId |int|Y| +|  endpoint |int|Y| +|  cluster |str|| +|  attribute |str|| +|  command |str|| +|  event |str|| +|  eventNumber |int|Y| +|  disabled |bool|| +|  fabricFiltered |bool|| +|  verification |str|| +|  PICS |str|| +|  arguments | | | +|    values | | | +|      value |NoneType,bool,int,float,dict,list|Y| +|      name |str|| +|    value |NoneType,bool,int,float,dict,list|Y| +|  response | |Y | +|    value |NoneType,bool,int,float,dict,list|Y| +|    name |str|| +|    error |str|| +|    clusterError |int|| +|    constraints | | | +|      hasValue |bool|| +|      type |str|| +|      minLength |int|| +|      maxLength |int|| +|      isHexString |bool|| +|      startsWith |str|| +|      endsWith |str|| +|      isUpperCase |bool|| +|      isLowerCase |bool|| +|      minValue |int,float|Y| +|      maxValue |int,float|Y| +|      contains |list|| +|      excludes |list|| +|      hasMasksSet |list|| +|      hasMasksClear |list|| +|      notValue |NoneType,bool,int,float,list,dict|Y| +|      anyOf |list|| +|    saveAs |str|| +|    saveDataVersschemaionAs |str|| +|  saveResponseAs |str|| +|  minInterval |int|| +|  maxInterval |int|| +|  keepSubscriptions |bool|| +|  timeout |int|| +|  timedInteractionTimeoutMs |int|| +|  dataVersion |list,int|Y| +|  busyWaitMs |int|| +|  wait |str||