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

Documentation: more handbook re-org #36208

Merged
merged 7 commits into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ Note that the output should also be verified against the spec using the
- Goal: get zap to understand the new cluster so it can be used on devices
(XML and glue)

![](../getting_started/img/zap_compiler.png)
![](../zap_and_codegen/img/zap_compiler.png)

### Cluster definitions and ZAP

Please see [ZAP](../getting_started/zap.md) for an introduction to ZAP.
Please see [ZAP](../zap_and_codegen/zap_intro.md) for an introduction to ZAP.

After implementing the changes outlined in the wiki article, your cluster and
device type should show up in zap. you can check this by running zaptool with
Expand All @@ -64,17 +64,17 @@ To ensure the cluster and device type are correctly implemented for ZAP, open
the endpoint configuration and ensure the device type appears in the device type
list.

![](../getting_started/img/zap3.png)
![](../zap_and_codegen/img/zap3.png)

Next, check your cluster. The "domain" parameter in the XML controls which group
the cluster is in. It should have all the expected attributes, commands and
events.

![](../getting_started/img/zap4.png)
![](../zap_and_codegen/img/zap4.png)

Last, ensure that your attributes have the storage option set appropriately.

![](../getting_started/img/zap5.png)
![](../zap_and_codegen/img/zap5.png)

### Cluster implementation - Ember and overrides

Expand Down
24 changes: 19 additions & 5 deletions docs/getting_started/changing_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ The composition of most examples in the SDK is static and code generated.

The tool used to describe and change the composition of an example is called
ZAP. More information about ZAP and a walk-through of the tool can be found in
the [ZAP introduction](./zap.md). The composition of the device is captured in a
.zap file, which is readable by the ZAP tool. This is then compiled into a
human-readable .matter file, which is used to build the static features of the
example.
the [ZAP introduction](../zap_and_codegen/zap_intro.md). The composition of the
device is captured in a .zap file, which is readable by the ZAP tool. This is
then compiled into a human-readable .matter file, which is used to build the
static features of the example.

To change the composition of a device example, you need to

Expand Down Expand Up @@ -35,7 +35,8 @@ This will open the ZAP GUI tool, which can be used to change the endpoint
composition, clusters, features, attributes, commands and events exposed by the
device.

Details of how to use the tool can be found in the [ZAP Introduction](./zap.md).
Details of how to use the tool can be found in the
[ZAP Introduction](../zap_and_codegen/zap_intro.md).

## Running code generation

Expand All @@ -62,3 +63,16 @@ recompile the .zap files for all the examples and the controller.

After generating the .matter file, re-build the example. Instructions for
building examples are given in [Building your first example](./first_example.md)

## Ensuring device conformance

After changing the examples, it is important to ensure they remain spec
compliant. Although there are numerous certification tests to check the various
parts of the device, the tests most likely to be affected by changes to ZAP are
the conformance tests, which ensure that the device included meets the
conformance requirements for clusters and device types. To run conformance tests
against the example app, see [Testing](../testing/index.md). The tests that
ensure the device composition is spec compliant are found in
[Device Basic Composition Test](../../src/python_testing/TC_DeviceBasicComposition.py)
and
[Device Conformance Tests](../../src/python_testing/TC_DeviceConformance.py).
2 changes: 1 addition & 1 deletion docs/getting_started/first_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ for testing. More information about the python controller can be found in the

The examples directory contains a set of apps using an example device
composition \.zap file. For more information about device composition and zap,
see [ZAP documentation](./zap.md).
see [ZAP documentation](../zap_and_codegen/zap_intro.md).

This quick start guide will walk you through

Expand Down
2 changes: 0 additions & 2 deletions docs/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,9 @@ The following docs are a brief introduction to SDK development.
first_example
changing_examples
SDKBasics
zap

```

- [Running your first example](./first_example.md)
- [Changing examples](./changing_examples.md)
- [SDK Architecture Overview](./SDKBasics.md)
- [ZAP Introduction](./zap.md)
File renamed without changes.
10 changes: 10 additions & 0 deletions docs/ids_and_codes/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# IDs and Codes


```{toctree}
:glob:
:maxdepth: 1

*

```
File renamed without changes.
File renamed without changes.
7 changes: 2 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ VSCODE_DEVELOPMENT
ci-cd/index
development_controllers/index
getting_started/index
ids_and_codes/index
cluster_and_device_type_dev/index
guides/index
platforms/index
Expand All @@ -19,14 +20,10 @@ product_considerations/index
testing/index
tips_and_troubleshooting/index
tools/index
zap_and_codegen/index
BUG_REPORT
code_generation
zap_clusters
spec_clusters
upgrading
ERROR_CODES
issue_triage

```

```{include} README.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,11 @@ via `-o/--output-dir`.
./scripts/tools/zap/generate.py $PATH_TO_ZAP_FILE
```

Rebuild the application.

It is also recommended to run device composition tests to ensure the selected
composition is spec compliant (see [Testing](../testing/index.md))

### Compile-time code generation / pre-generated code

A subset of code generation (both `codegen.py` and `zap-cli`) is done at compile
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
8 changes: 8 additions & 0 deletions docs/zap_and_codegen/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# ZAP and Codegen

```{toctree}
:glob:
:maxdepth: 1

*
```
File renamed without changes.
Loading