×

PICS Comparison

Original PICS:

Δ Compare Against

New PICS:

Select an original and new PICS to compare.

🔝 Go To Top

↩ Return to PICS Tool

×

PICS Editor

✏

PICS Filename (Click Above to Change)

Cluster Details (Optional)

Name: Cluster ID: PICS Root:

To use the generalPICS XML schema, leave all cluster fields blank throughout the form.

Status Flags (Optional)

O.1

Flagging a status will change its validation behavior from any-of to one-of.

+ New PICS Group

⮪ Test in PICS Tool 💾︎ Save XML ↻ Reset PICS Editor

PICS Editor Usage Instructions

Getting Started:

Enter the new XML filename by typing in the top yellow box, to the right of the pencil icon.
If this is a Cluster PICS, enter the cluster name, ID and PICS root details.

If no cluster details are entered, the GeneralPICS XML schema will be used.

If optional status groups (O.1, O.2, etc.) will be used, validation behavior can be changed from any-of to one-of by flagging the status.

Additional flag options will appear as new status options are created through usage.

Click on + New PICS Group to add your first PICS group to the form.

PICS Groups:

By default, groups are created in PICS item mode. To specify PIXIT items instead, use the radio button selector.
Specify an optional group label (e.g. Zigbee Logical Device Type).
If this group will contain Cluster PICS items, select one of the preset XML tag sections:

Usage
Server Attributes
Server Commands Generated
Server Commands Received
Client Attributes
Client Commands Generated
Client Commands Received
If a cluster section is not selected, the default PICS or PIXIT group XML tags will be used.

Use the Move Up and Move Down buttons to reposition PICS groups within the document.
To remove an entire group and all PICS items contained within, use the Delete Group button.
Click on + New PICS Item to add your first PICS item to the group.

PICS Items:

Specify the PICS Item Number – this should be used only once within the document and not used in any other approved PICS templates.
Include an optional description of the technology specification feature.
Include an optional section, paragraph or table reference from the specification document (comma, space or semicolon separated).
Declare the item status. Multiple status fields can be added or deleted.

By default, items are set to (M) MANDATORY status.
(O) OPTIONAL
(X) UNSUPPORTED or DEPRECATED
(O.X) GROUPED OPTIONAL

O.X status selection will automatically create the next number as an option (e.g. selecting O.1 will create O.2).
Each O.X status can be flagged to validate in one-of mode from the menu at the top of the PICS editor form.

Specify an optional status condition. Examples:

ZLT1 (Evaluates if ZLT1 is materially supported)
NOT(ZLT1) (Evaluates if ZLT1 is materially unsupported)
ZLT1 == false (Evaluates ZLT1 as a string)
ZLT1 == 2 (Evaluates ZLT1 as a number)
ZLT1 < 2 (Evaluates ZLT1 as less-than a number)
ZLT1 > 2 (Evaluates ZLT1 as greater-than a number)
ZLT1 AND ZLT2 (Multiple conditions with AND operator)
ZLT1 OR ZLT2 (Multiple conditions with OR operator)
(ZLT1 OR ZLT2) AND (GRC4 OR GRC5) (Nested conditions with OR operator)
(ZLT1 OR (ZLT2 AND GRC4) OR GRC5) (Nested conditions with AND operator)
ZLT1 AND NOT(ZLT2 OR ZLT3) (Using the NOT operator with a nested condition)

Specify an optional default support value. (Useful for some PIXIT items)
Use the Move Up and Move Down buttons to reposition PICS items within the group.
To remove a PICS item and all fields contained within, use the Delete Item button.

Testing and Downloading:

To complete and validate your created PICS in the PICS editor, click Test in PICS Editor
To only download the PICS XML, click 💾︎ Save XML
XML PICS can also be downloaded from the PICS editor after testing

All draft XML PICS templates require Author Mode to be enabled in the PICS Tool first before loading.

After closing the PICS editor and returning to the PICS Tool, all data will remain in the PICS editor.

PICS editor data will remain until it has been overwritten, or the PICS Tool has been closed or reloaded.
Click on Reset PICS Editor to manually clear the PICS form.

To access the PICS editor after returning to the PICS Tool, click on the hamburger (☰) menu icon in the top right of the PICS Tool.
Clicking the Edit PICS button from the PICS Tool will overwrite any existing work in the PICS editor with PICS from the opened file.

↩ Return to PICS Tool

×

PICS Tool – Release Notes

v1.6.4

Official support for Matter PICS
Test Case mapping for Matter. After validating all PICS, a list of test cases is displayed at the top

v1.6.3

Beta support of Matter PICS
Matter PICS XML rev0.13 27 Sep 2022

v1.6.2

Updated PICS XML files with duplicated PICS Id issue resolved
Updated CCB

v1.6.1

Added Compact Mode
Added Compare PICS autoselection
Improved support for conditional status items
Improved layout responsiveness for smaller screens
User guide editorial updates

v1.6

Added CCB references for BDB and ZCL items

See readme for a full list of supported CCBs

Added universal click‐to‐fill for PIXIT items
Added (<) and (>) support for conditional status items
Added high‐contrast mode (toggled by 🔆︎ button)
Added PICS filters for validation status
Added JSON open and save support for author mode
Added menu link to report a bug
Added browser back button support and permalinks for:

User Guide
Release Notes
Compare PICS
PICS Editor

Improved support for unrecognized PICS templates
Improved support for duplicate PICS items and templates
Improved layout responsiveness for smaller screens
Improved error messages for client and server items
Improved error messages for annotated O.x status items
Improved bookmarks for renamed files
Renamed Download XML buttons to Save XML
Moved window navigation buttons to the bottom of the screen
Moved Compare PICS report to main menu
Fixed PICS Editor issue relating to client commandsReceived

v1.5

Added navigation menu
Updated note tag support for O.X items
Updated approved PICS templates for BDB 3.0.1 and ZCL8

See readme for a full list of supported templates

v1.4

Added PICS editor to create and modify XML PICS files
Added search filter for PICS item numbers
Added browse button to open PICS files
Added XML PICS comparison reporting
Added ability to rename opened XML files
Added XML <note> tag support
Added Cluster XML <name>, <clusterId> and <picsRoot> tag support
Improved validation error messages
Improved O.x status validation
Improved PICS template validation – See readme for a full list of supported templates
Moved PICS action buttons to the top of PICS tables
Changed display order of conditional status items
CSS and JavaScript optimization
User guide editorial updates

v1.3.1

Updated PICS Download links

v1.3

Added Release Notes Section
Added Author Mode for PICS template testing
Added PICS item completeness check
Added Reset PICS Button
Added Close All, Reset All and Page Refresh Buttons
Added confirmation messages for Close, Reset and Refresh Buttons
Added support for XML reference tag and additional cluster side label tags
Updated PICS template allowlist

See readme for a full list of supported templates

v1.2

Editorial updates to User Guide

v1.1

Initial Release
Added User Guide
Added links to Causeway PICS
Added validation results to comsole output
Added XML section labels
Improved duplicate item support

v1.0

Beta Release

↩ Return to PICS Tool

×

PICS Tool – User Documentation

Getting Started

TO START: Drag-and-drop inside this box or browse to open one or more XML PICS files

Example – PICS Tool Start Screen

+

<.xml>

To get started with the PICS Tool:

Open the PICS Tool HTML file using a web browser. This user guide is also included within the PICS Tool.
Load XML PICS templates by dragging and dropping one or several files into the gray box within the browser window.

Multiple items must be selected as a group; entire folders containing XML files cannot be loaded.
Unclick (or drop) after the gray box turns blue to load the dragged files.
XML files must be stored locally on the machine running the PICS Tool.
Files stored in an archive (zip, rar, 7z, etc.) should be unpacked before loading into the tool.
XML text cannot be copy-and-pasted into the PICS Tool.

Alternatively, multiple files may also be opened at once by clicking the "or browse" link to launch a file picker.

Where to find approved XML PICS:

Download from Causeway – Contact [email protected] if you need access to Causeway.
BDB PICS – https://groups.csa-iot.org/wg/members-all/document/24034
ZCL Cluster PICS – https://groups.csa-iot.org/wg/members-all/document/13407
Download the latest revision of the files above from Causeway
Unzip to a local file on your computer.

Navigation

TO START: Drag-and-drop inside this box or browse to open one or more XML PICS files

16-02800-001-PRO_BDB-BDB-XML-PICS.xml: Loaded successfully. (209 items loaded)

1 Template Loaded, 209 Items Loaded

☝ Click the Validate All button to check all PICS for errors.

🔎 Filter All PICS

🔖 Bookmarks

16-02800-001-PRO_BDB-BDB-XML-PICS.xml

Example – PICS Tool Console and Function Buttons

1

2

3

4

5

6

7

8

9

🔆︎

⛶︎

🔝︎

↑

↓

Example – PICS Tool Page Navigation

10

11

12

13

14

Navigating the PICS Tool:

Drag and drop additional XML PICS files into the gray box. Files must be selected as a group, folders cannot be loaded.
The console shows import status and any errors that occurred while loading.
Shows how many known PICS templates and unique items have been loaded.

Note: PICS items can only be loaded once, duplicate items will be shown in read-only mode.

Shortcut button to validate all PICS files at the same time.
Shortcut button to save all XML files at the same time.

XML files are automatically updated with the new values filled out using the tool.
The files will be saved the default browser downloads folder.

Shortcut button to close all open PICS files.
Shortcut button to clear all checkboxes, radio buttons and text fields in all open PICS files.
Apply an item number search filter to all open PICS files.
List of bookmarks to jump to each file loaded into the tool.

Page navigation buttons can be found at the bottom of the PICS tool main page:

Enable high-contrast mode.
Enable compact mode and hide PICS item details.
Jump to the top of the page.
Jump to the top of the PICS file currently focused.
Jump to the bottom of the PICS file currently focused.

The PICS file in focus will have a light blue background and thicker border.
The last PICS template loaded will be focused automatically.
Clicking on a PICS table will bring the PICS file into focus.

Understanding PICS Tables

209 Item(s) Loaded
PICS File: 16-02800-001-PRO_BDB-BDB-XML-PICS.xml
PICS Template: 16-02800-001-PRO_BDB-BDB-XML-PICS.xml
Template MD5: 7bf86aa0d2395396ec684f7c436c9cdf
Template Status: ✓ Approved – See readme

🔍 Filter PICS

Item: ❌

Validation: UnvalidatedPassWarningError

	Item Number	Feature	Status	Support
PIXIT Items
	IA2	bdbJoinUsesInstallCodeKey: Does the Trust Center policy require all nodes to join using an install code?	M : ZLT1	🖱︎ Click to Autofill ✏ N/A True False Yes No 0x00 0x01
PICS Items
	CC1	Can the product be stimulated to invoke touchlink commissioning only?	O	T/F

Example – PICS Table and Items

1

2

3

4

5

6

7

8

9

10

11

12

13

14

Understanding the PICS Tables:

The PICS table in focus will have a light blue background and border.
The PICS filename is shown at the top of the PICS details.
- The save-as filename can be changed by clicking on the current filename and editing the text field.
Basic PICS information is shown directly below the PICS file heading, including the number of PICS items loaded and the original filename.

For Cluster PICS, additional details such as the Cluster ID, name and PICS root will also be shown here.

If the PICS template is known, it's label and MD5 signature will be displayed.

All known template descriptions will include one of the following tags:

APPROVED: This template can be submitted with a Zigbee Certified Product application.
FUTURE: This template has been released by a balloting group however may not be approved for use with certified products. Check with the certification team or the respective balloting group chair before using an unapproved template.
DEPRECATED: This template is outdated and should not be used. The latest approved PICS templates can be found using the links at the top of the user guide and PICS Tool start screen.
See readme for a full list of supported PICS templates.

If the PICS template signature is unknown, an error will be displayed and the user will be prompted to enter Author Mode. The unrecognized PICS file must then be opened a second time after Author Mode is enabled.

PICS Table Controls:

Validate PICS – Validate all the items in the table above.
Download PICS – Download an updated XML with your new PICS support values.
Reset PICS – Clear all checkboxes, radio buttons and text fields in the table above.
Close PICS – Remove the opened PICS file from the tool, any changes will not be saved.
Edit PICS* – Open the existing PICS in the PICS editor window to make changes. (*Author Mode Only – See Advanced Usage)
Filter PICS by item number or validation status.
PICS Table Columns:

Validation Result – The gray dot will turn green, yellow or red upon validating to indicate success or warning.
Item Number – Unique PICS Item Number.

Items with duplicate item numbers will be shown as read-only and an error will be output to the console.

Feature – The description of the item.
Status – The support requirement of the item.
Support – The user input value relating to the device support of the feature.

See BDB Specification Document for abbreviations and symbols used in the Support column.

PIXIT and PICS items will be grouped into categories as specified in the PICS XML.

PIXIT and PICS items have different types of answer fields:

PIXIT – An answer must be selected from the autofill menu or typed into the text box.

Selecting N/A for a PIXIT item is equivalent to leaving the answer blank.

PICS – An answer must be true or false.

Validating PICS

209 Item(s) Loaded
PICS File: 16-02800-001-PRO_BDB-BDB-XML-PICS.xml
PICS Template: 16-02800-001-PRO_BDB-BDB-XML-PICS.xml
Template MD5: 7bf86aa0d2395396ec684f7c436c9cdf
Template Status: ✓ Approved – See readme

❌ Validated 3 items with 1 warning and 1 error

🔍 Filter PICS

Item: ❌

Validation: UnvalidatedPassWarningError

	Item Number	Feature	Status	Support
PICS Items
	IA5	bdbSecondaryChannelSet: What is the secondary channel set?	M	T/F
	IA6	bdbTCLinkKeyExchangeAttemptsMax: What is the maximum number of attempts a node will try to exchange its Trust Center link key?Dependency ZLT2 has not been met. Dependency ZLT3 has not been met.	ZLT2 : M ZLT3 : M	T/F
	ZLT4	⚫ Select One (O.1)Can the node switch between ZLT1 and ZLT2 types under application control.At least one O.1 item must be supported.	O.1	T/F

Example – PICS Validation Results

1

2

3

4

5

6

7

8

How to Validate your PICS:

Following validation, there will be a summary message for the entire PICS file.
To re-run the validation routine, click the Validate PICS button.

There is also a Validate All button at the top of the page to validate all loaded PICS files at once.

Note: You may download the PICS XML with the changes you've made in the tool regardless of the validation result.

PICS items can be filtered by validation status once the items have been validated.
Each item will be evaluated based on template-provided status and user-input support values.

See BDB Specification Document for abbreviations and symbols used in the Support column.

The color bar in the left column of each PICS Table row will turn green, yellow or red to indicate validation results of each PICS Item:

Green Dot: Passed validation and requires no review.
Yellow Dot: Inconclusive result and may require manual review.
Red Dot: Incorrectly answered and manual review is required.

Additional error feedback may follow the PICS item description after validation

Common Errors

TO START: Drag-and-drop one or more XML PICS files inside the gray box

BDB_PICS_in_Non_XML_Format.docx: This is not a valid XML file. If this file is stored inside a ZIP archive, try unpacking the archive to a folder first.

16-02800-001-PRO_BDB-BDB-XML-PICS.xml: Validated 222 items with 2 warnings and 34 errors.

Example – Import and Validation feedback will be shown in the console at the top of the page.

Common errors during import of PICS:

BDB_PICS_in_Non_XML_Format.docx: This is not a valid XML file. If this file is stored inside a ZIP archive, try unpacking the archive to a folder first.

Only valid XML files will be processed – PICS in .docx and .pdf formats are not supported.

16-02800-001-PRO_BDB-BDB-XML-PICS.xml: Loaded unsuccessfully. This XML PICS template is unapproved and has not been tested with this tool. To test new or updated PICS documents, please enable author mode and try again.

PICS templates which have been modified from the approved configuration will fail to load without enabling author mode. To test draft PICS or changes to PICS items, first enable author mode using the link at the bottom of the page or within the error message.

Modified templates include any changes to item numbers, status or conditions. Changes made to the user-input support column will not be considered when the tool determines if the template has modified from its approved state.
Some templates may be supported by this tool but are not approved for use with Zigbee Certified programs. See readme for a full list of supported PICS templates and their approval status.

My-Modified-BDB-XML-PICS.xml: Conditional status item ‘( (IA2==true) AND BKN2))’ is invalid and has been converted to ‘(IA2==true AND BKN2)’

Conditional status items must contain balanced parenthesis. If the conditional statement is invalid, the tool will interpret the statement with parenthesis removed.

Common errors during validation of PICS:

16-02800-001-PRO_BDB-BDB-XML-PICS.xml: Validated 222 items with 2 warnings and 34 errors.

A summary will be given with the number of errors and warnings for each PICS file validated.

Failure Errors
All failure errors must be addressed prior to the PICS being submitted for product certification.

❌ Support for this item is mandatory.

A mandatory item must be supported in all use cases.

❌ A condition has been met which makes this item mandatory: ZLT1

A use case has been identified that now requires this item to be supported.

❌ An item with status O.1 must be supported.

At least one item within an O.x status group must be supported.

❌ A condition has been met which makes this item prohibited: ZLT1

This item cannot be supported with the selected configuration.

❌ Support for this item requires support for the following: S.S

Cluster server and client items must be supported as a group.

Advisory Warnings
Advisory warnings are provided for context relating to item support requirements.

⚠ Support for this item may not be needed.

A PICS item is supported without a clearly defined reason.

⚠ Review all supplementary notes before supporting this item.

A supplementary note on an item has altered the normal validation behavior.

⚠ Review all supplementary CCBs before supporting this item.

Some mandatory items may be rendered optional in some cases by known CCBs.

⚠ This item is a duplicate. Check the item description and category before enabling support.

All duplicate items should be double-checked to confirm the correct item is being supported.

⚠ Duplicate dependency item found, only the first item will be evaluated: G.C.C00.Tx

Items which depend on the support of another item will only validate against the first item found.

⚠ The following dependency item could not be found and will be evaluated as false: S.S

Dependency items from other PICS files which have not been loaded (usually related to the Scenes cluster) will be evaluated as if they are not supported.

Advanced Usage

Author Mode and PICS Editor

Author Mode allows the user to load unrecognized PICS templates and use the PICS editor to revise or create new XML PICS documents.
To enable author mode, click the "Enable Author Mode" link at the bottom of the start screen. A message will be displayed at the top of the page to indicate that Author Mode is enabled.
Once Author Mode has been enabled, it can only be turned off by reloading the PICS Tool.
The PICS editor can be accessed by opening the main menu at the top right of the PICS Tool. Opening the PICS Editor will automatically enable author mode.
Existing XML PICS files can be edited by first opening in the PICS Tool, and then clicking the Edit PICS button.
Further instructions for PICS editor usage will be found in the PICS editor window.
For debugging purposes, enabling author mode will show a Save JSON button at the top of the PICS next to Save All. PICS can be validated and saved as a JSON to be reloaded later in the same state.

For additional support, please email [email protected].

🔝 Go To Top

↩ Return to PICS Tool

PICS Tool

🔖︎ Bookmarks

Test Cases: 0

PICS Comparison

PICS Editor

PICS Editor Usage Instructions

PICS Tool – Release Notes

v1.6.4

v1.6.3

v1.6.2

v1.6.1

v1.6

v1.5

v1.4

v1.3.1

v1.3

v1.2

v1.1

v1.0

PICS Tool – User Documentation

Contents

Getting Started

Navigation

1 Template Loaded, 209 Items Loaded

🔖 Bookmarks

Understanding PICS Tables

Validating PICS

Common Errors

Advanced Usage