Skip to content

Commit

Permalink
regenerate tables
Browse files Browse the repository at this point in the history
  • Loading branch information
@cecille
cecille committed Jan 23, 2024
1 parent 5f863fd commit 09dec0f
Show file tree
Hide file tree
Showing 2 changed files with 101 additions and 37 deletions.
44 changes: 34 additions & 10 deletions docs/testing/yaml_pseudocluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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<br />payload<br />discoverOnce|node_id<br />char_string<br />boolean|false<br />false<br />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<br />nodeId|octet_string<br />node_id|false<br />false|
|IssueNocChainResponse|NOC<br />ICAC<br />RCAC<br />IPK|octet_string<br />octet_string<br />octet_string<br />octet_string|false<br />false<br />false<br />false|

DelayCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|

DelayCommands
|command|args|arg type| arg optional|
|:---|:---|:---|:---|
|WaitForCommissioning||||
|WaitForCommissionee|nodeId<br />expireExistingSession|node_id<br />bool|false<br />true|
|WaitForMs|ms|int16u|false|
|WaitForMessage|registerKey<br />message|char_string<br />char_string|false<br />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<br />instanceName<br />longDiscriminator<br />shortDiscriminator<br />vendorId<br />productId<br />commissioningMode<br />deviceType<br />deviceName<br />rotatingId<br />rotatingIdLen<br />pairingHint<br />pairingInstruction<br />supportsTcp<br />numIPs<br />port<br />mrpRetryIntervalIdle<br />mrpRetryIntervalActive<br />mrpRetryActiveThreshold<br />isICDOperatingAsLIT|char_string<br />char_string<br />int16u<br />int16u<br />vendor_id<br />int16u<br />int8u<br />devtype_id<br />char_string<br />octet_string<br />int64u<br />int16u<br />char_string<br />boolean<br />int8u<br />int16u<br />int32u<br />int32u<br />int16u<br />boolean|false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />false<br />true<br />true<br />true<br />true|

EqualityCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|

EqualityCommands
|command|args|arg type| arg optional|
|:---|:---|:---|:---|
|BooleanEquals|Value1<br />Value2|boolean<br />boolean|false<br />false|
|SignedNumberEquals|Value1<br />Value2|int64s<br />int64s|false<br />false|
|UnsignedNumberEquals|Value1<br />Value2|int64u<br />int64u|false<br />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<br />expectedValue|char_string<br />char_string|false<br />true|

SystemCommands |command|args|arg type| arg optional| |:---|:---|:---|:---|
|Start|registerKey<br />discriminator<br />port<br />minCommissioningTimeout<br />kvs<br />filepath<br />otaDownloadPath|char_string<br />int16u<br />int16u<br />int16u<br />char_string<br />char_string<br />char_string|true<br />true<br />true<br />true<br />true<br />true<br />true|
|Stop|registerKey|char_string|true| |Reboot|registerKey|char_string|true|

SystemCommands
|command|args|arg type| arg optional|
|:---|:---|:---|:---|
|Start|registerKey<br />discriminator<br />port<br />minCommissioningTimeout<br />kvs<br />filepath<br />otaDownloadPath<br />endUserSupportLogPath<br />networkDiagnosticsLogPath<br />crashLogPath|char_string<br />int16u<br />int16u<br />int16u<br />char_string<br />char_string<br />char_string<br />char_string<br />char_string<br />char_string|true<br />true<br />true<br />true<br />true<br />true<br />true<br />true<br />true<br />true|
|Stop|registerKey|char_string|true|
|Reboot|registerKey|char_string|true|
|FactoryReset|registerKey|char_string|true|
|CreateOtaImage|otaImageFilePath<br />rawImageFilePath<br />rawImageContent|char_string<br />char_string<br />char_string|false<br />false<br />false|
|CompareFiles|file1<br />file2|char_string<br />char_string|false<br />false|
|CreateFile|filePath<br />fileContent|char_string<br />char_string|false<br />false|
|DeleteFile|filePath|char_string|false|
94 changes: 67 additions & 27 deletions docs/testing/yaml_schema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,70 @@ Script: generate_yaml_doc_tables.py

# YAML Schema

YAML schema |key | type| supports variables |:---|:---|:---| |name |str|| |PICS
|str,list|| |config | | | |&emsp; nodeId |int|| |&emsp; cluster |str|| |&emsp;
endpoint |int|| |&emsp; _variableName_ | | | |&emsp; &emsp; type |type|| |&emsp;
&emsp; defaultValue |Any|| |tests | | | |&emsp; label |str|| |&emsp; identity
|str|| |&emsp; nodeId |int|Y| |&emsp; runIf |str|| |&emsp; groupId |int|Y|
|&emsp; endpoint |int|Y| |&emsp; cluster |str|| |&emsp; attribute |str|| |&emsp;
command |str|| |&emsp; event |str|| |&emsp; eventNumber |int|Y| |&emsp; disabled
|bool|| |&emsp; fabricFiltered |bool|| |&emsp; verification |str|| |&emsp; PICS
|str|| |&emsp; arguments | | | |&emsp; &emsp; values | | | |&emsp; &emsp; &emsp;
value |NoneType,bool,int,float,dict,list|Y| |&emsp; &emsp; &emsp; name |str||
|&emsp; &emsp; value |NoneType,bool,int,float,dict,list|Y| |&emsp; response | |Y
| |&emsp; &emsp; value |NoneType,bool,int,float,dict,list|Y| |&emsp; &emsp; name
|str|| |&emsp; &emsp; error |str|| |&emsp; &emsp; clusterError |int|| |&emsp;
&emsp; constraints | | | |&emsp; &emsp; &emsp; hasValue |bool|| |&emsp; &emsp;
&emsp; type |str|| |&emsp; &emsp; &emsp; minLength |int|| |&emsp; &emsp; &emsp;
maxLength |int|| |&emsp; &emsp; &emsp; isHexString |bool|| |&emsp; &emsp; &emsp;
startsWith |str|| |&emsp; &emsp; &emsp; endsWith |str|| |&emsp; &emsp; &emsp;
isUpperCase |bool|| |&emsp; &emsp; &emsp; isLowerCase |bool|| |&emsp; &emsp;
&emsp; minValue |int,float|Y| |&emsp; &emsp; &emsp; maxValue |int,float|Y|
|&emsp; &emsp; &emsp; contains |list|| |&emsp; &emsp; &emsp; excludes |list||
|&emsp; &emsp; &emsp; hasMasksSet |list|| |&emsp; &emsp; &emsp; hasMasksClear
|list|| |&emsp; &emsp; &emsp; notValue |NoneType,bool,int,float,list,dict|Y|
|&emsp; &emsp; &emsp; anyOf |list|| |&emsp; &emsp; saveAs |str|| |&emsp; &emsp;
saveDataVersschemaionAs |str|| |&emsp; saveResponseAs |str|| |&emsp; minInterval
|int|| |&emsp; maxInterval |int|| |&emsp; keepSubscriptions |bool|| |&emsp;
timeout |int|| |&emsp; timedInteractionTimeoutMs |int|| |&emsp; dataVersion
|list,int|Y| |&emsp; busyWaitMs |int|| |&emsp; wait |str||
YAML schema
|key | type| supports variables
|:---|:---|:---|
|name |str||
|PICS |str,list||
|config | | |
|&emsp; nodeId |int||
|&emsp; cluster |str||
|&emsp; endpoint |int||
|&emsp; _variableName_ | | |
|&emsp; &emsp; type |type||
|&emsp; &emsp; defaultValue |Any||
|tests | | |
|&emsp; label |str||
|&emsp; identity |str||
|&emsp; nodeId |int|Y|
|&emsp; runIf |str||
|&emsp; groupId |int|Y|
|&emsp; endpoint |int|Y|
|&emsp; cluster |str||
|&emsp; attribute |str||
|&emsp; command |str||
|&emsp; event |str||
|&emsp; eventNumber |int|Y|
|&emsp; disabled |bool||
|&emsp; fabricFiltered |bool||
|&emsp; verification |str||
|&emsp; PICS |str||
|&emsp; arguments | | |
|&emsp; &emsp; values | | |
|&emsp; &emsp; &emsp; value |NoneType,bool,int,float,dict,list|Y|
|&emsp; &emsp; &emsp; name |str||
|&emsp; &emsp; value |NoneType,bool,int,float,dict,list|Y|
|&emsp; response | |Y |
|&emsp; &emsp; value |NoneType,bool,int,float,dict,list|Y|
|&emsp; &emsp; name |str||
|&emsp; &emsp; error |str||
|&emsp; &emsp; clusterError |int||
|&emsp; &emsp; constraints | | |
|&emsp; &emsp; &emsp; hasValue |bool||
|&emsp; &emsp; &emsp; type |str||
|&emsp; &emsp; &emsp; minLength |int||
|&emsp; &emsp; &emsp; maxLength |int||
|&emsp; &emsp; &emsp; isHexString |bool||
|&emsp; &emsp; &emsp; startsWith |str||
|&emsp; &emsp; &emsp; endsWith |str||
|&emsp; &emsp; &emsp; isUpperCase |bool||
|&emsp; &emsp; &emsp; isLowerCase |bool||
|&emsp; &emsp; &emsp; minValue |int,float|Y|
|&emsp; &emsp; &emsp; maxValue |int,float|Y|
|&emsp; &emsp; &emsp; contains |list||
|&emsp; &emsp; &emsp; excludes |list||
|&emsp; &emsp; &emsp; hasMasksSet |list||
|&emsp; &emsp; &emsp; hasMasksClear |list||
|&emsp; &emsp; &emsp; notValue |NoneType,bool,int,float,list,dict|Y|
|&emsp; &emsp; &emsp; anyOf |list||
|&emsp; &emsp; saveAs |str||
|&emsp; &emsp; saveDataVersschemaionAs |str||
|&emsp; saveResponseAs |str||
|&emsp; minInterval |int||
|&emsp; maxInterval |int||
|&emsp; keepSubscriptions |bool||
|&emsp; timeout |int||
|&emsp; timedInteractionTimeoutMs |int||
|&emsp; dataVersion |list,int|Y|
|&emsp; busyWaitMs |int||
|&emsp; wait |str||

0 comments on commit 09dec0f

Please sign in to comment.