Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PICS documentation - moved from SDK #39

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

cecille
Copy link
Contributor

@cecille cecille commented Jan 31, 2025

No description provided.

Copy link

github-actions bot commented Feb 11, 2025

Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-39

Copy link

Preview deployed at https://d2doqw88td69eq.cloudfront.net/pr-39

@Vyrastas
Copy link
Contributor

I will do an editorial review of this

Copy link
Contributor

@Vyrastas Vyrastas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the delay in review

Comment on lines +32 to +33
| ANC.S.C00.Rsp | Device accepts ANC command 0x00 on the ANC server cluster |
| ANC.S.C01.Rsp | Device accepts ANC command 0x00 on the ANC server cluster |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These 2 are the same description?

Comment on lines +37 to +38
| ANC.C.F00 | Device ANC client is capable of understanding the feature with bit 0 |
| ANC.C.F01 | Device ANC client is capable of understanding the feature with bit 0 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same description?


Additionally, there are node-level PICS, which appear as a part of the MCORE
PICS set. These PICS codes describe node level support such as the radio,
whether the device is commissionable, whether the device comes with a QR code
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
whether the device is commissionable, whether the device comes with a QR code
whether the device is commissionable, whether the device comes with a QR code,

to manually set all the PICS codes for a device. The PICS XML files and the PICS
tool are distributed as part of the official specification release package and
are available on
[Causeway](https://groups.csa-iot.org/wg/members-all/document/folder/2269).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a public document, do we want to be clear that this requires a CSA member login?

present for the endpoint being described. Documentation on how to use the PICS
tool can be found in the PICS tool readme in the tool menu.

Some of of the full-node MCORE elements really only apply to the root node,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Some of of the full-node MCORE elements really only apply to the root node,
Some of the full-node MCORE elements really only apply to the root node,

Comment on lines +114 to +117
are exposed directly on the device. For example, cluster presence is determined
from the server list on an endpoint, feature maps, attribute and command lists
correspond directly to the PICS.S.Fxx, PICS.S.Axxxx and PICS.S.Cxx.Xx PICS
codes. The Matter SDK provides a tool to pre-fill these values in the PICS XML
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
are exposed directly on the device. For example, cluster presence is determined
from the server list on an endpoint, feature maps, attribute and command lists
correspond directly to the PICS.S.Fxx, PICS.S.Axxxx and PICS.S.Cxx.Xx PICS
codes. The Matter SDK provides a tool to pre-fill these values in the PICS XML
are exposed directly on the device. For example, cluster presence is determined
from the server list on an endpoint. Feature maps and attribute and command lists
correspond directly to the PICS.S.Fxx, PICS.S.Axxxx and PICS.S.Cxx.Xx PICS
codes. The Matter SDK provides a tool to pre-fill these values in the PICS XML

- MCORE (base.xml) PICS
- Manual or other non-element PICS
- PICS describing whether optionally-writable attributes are writable
- any other non-element PICS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- any other non-element PICS
- Any other non-element PICS

PICS files should validate properly. This will also generate the list of test
cases.

Note that the TH will also guide test selection by pre-selecting the required
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume TH = Test Harness, can we use TH (Test Harness)?

Comment on lines +184 to +201
Placeholder for more information coming in a subsequent PR. Needs to cover

- formatting (link out to test plans doc)
- requirement to have all the elements listed
- how to do conformance in a way the PICS tool can handle - (note - special
attention to choice conformance, otherwise conformance)
- why you shouldn't use PICS values in tests other than at the top level

## Using PICS in test scripts

Placeholder for more information coming in a subsequent PR. Needs to cover
top-level and step-wise pics in yaml and python and also where they should NOT
be used.

## CI PICS format

Placeholder for information about the CI PICS format, CI-only PICS and the
gotchas there.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should leave placeholders out of published docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants