Skip to content

Commit 6c23ad6

Browse files
committed
Update Custom ZCL design
1 parent cf4e536 commit 6c23ad6

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/custom-zcl.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ e.g. if a user wants to provision additional functionality to the lighting clust
1919

2020
Therefore, ZAP must provide a way for users to be able to add custom entities to the set of ZCL entities used within their projects.
2121

22-
##Custom Entities Overiew
22+
## Custom Entities Overiew
2323

2424
At its core, we can divide these custom ZCL Entities into the following categories:
2525

@@ -47,7 +47,7 @@ To support custom XMLs, `SESSION_PACKAGE` contains a key that specifies the opti
4747
Question:
4848

4949
1. Do we want to require that a custom extension can only rely on the main non-optional XML?
50-
2. If we have a situation where a custom extension can rely on other custom extensions, how do we want to maintain consistency when the prerequisite is deleted?
50+
2. If we have a situation where a custom extension can rely on other custom extensions, how do we want to maintain consistency when the prerequisite is deleted? Do we also want to delete the additional files? How do we want to warn the user? Do we need to introduce priorities for loading when we have chained reliance?
5151

5252
## Seamless Functionality
5353

@@ -58,7 +58,9 @@ In order for the data to be used seamlessly, following needs to be assured:
5858

5959
Apart from making sure that the queries all consider custom package IDs when querying for its package IDs, there should be nothing else special happening with these packages, they are just regular ZCL entities.
6060

61-
ZAP could provide some validation though, since there are specific ZCL rules around what IDs the custom entities can take.
61+
ZAP should provide some validation though, since there are specific ZCL rules around what IDs the custom entities can take. If there is a conflict between two XML files [possibly due to trying to overload], then ZAP should also point this out to the user, and ask/tell the user about what the desired resolution should be.
62+
63+
Essentially, once these XMLs are loaded, the ZCL entities between custom and standard entities should be treated identically, as long as queries respect the session's list of packageIds.
6264

6365
## ZAP File Format
6466

0 commit comments

Comments
 (0)