diff --git a/docs/examples/index.md b/docs/examples/index.md index f899c0196725db..83fee053520c33 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -180,6 +180,15 @@ shell/**/README temperature-measurement-app/**/README ``` +## Thermostat example + +```{toctree} +:glob: +:maxdepth: 1 + +thermostat/**/README +``` + ## TV example ```{toctree} diff --git a/docs/guides/darwin.md b/docs/guides/darwin.md index b28a9925d53cd0..0d9e16b4253c16 100644 --- a/docs/guides/darwin.md +++ b/docs/guides/darwin.md @@ -200,7 +200,7 @@ requirements [examples](https://github.com/project-chip/connectedhomeip/tree/master/examples) to support the fixed device types [above](#ensuring-your-matter-accessory-works-with-iosipadostvos) -3. Read the [platform guides](.) on how set up the hardware +3. Read the [platform guides](README.md) on how set up the hardware ##### Guides diff --git a/docs/guides/nrfconnect_factory_data_configuration.md b/docs/guides/nrfconnect_factory_data_configuration.md index aef2de4a607a89..9f57c079131cb4 100644 --- a/docs/guides/nrfconnect_factory_data_configuration.md +++ b/docs/guides/nrfconnect_factory_data_configuration.md @@ -661,7 +661,7 @@ $ west build -b nrf52840dk_nrf52840 -- \ > Note: To generate new certificates using the nRF Connect platform build > system, you need the `chip-cert` executable in your system variable PATH. To > learn how to get `chip-cert`, go to the note at the end of -> [creating the factory data partition with the second script](#creating-the-factory-data-partition-with-the-second-script) +> [creating the factory data partition with the second script](#creating-a-factory-data-partition-with-the-second-script) > section, and then add the newly built executable to the system variable PATH. > The Cmake build system will find this executable automatically. diff --git a/examples/lock-app/nxp/k32w/k32w0/README.md b/examples/lock-app/nxp/k32w/k32w0/README.md index 7a7e43db8bad0c..cdfe06ac50e07f 100644 --- a/examples/lock-app/nxp/k32w/k32w0/README.md +++ b/examples/lock-app/nxp/k32w/k32w0/README.md @@ -25,13 +25,13 @@ network. - [Flashing and debugging](#flashing-and-debugging) - [Known Issues](#known-issues) - [Testing the example](#testing-the-example) -- [Pigweed Tokenizer](#tokenizer) - - [Detokenizer script](#detokenizer) - - [Notes](#detokenizer-notes) - - [Known issues](#detokenizer-known-issues) -- [Tinycrypt ECC operations](#tinycrypt) +- [Pigweed Tokenizer](#pigweed-tokenizer) + - [Detokenizer script](#detokenizer-script) + - [Notes](#notes) + - [Known issues](#known-issues-1) +- [Tinycrypt ECC operations](#tinycrypt-ecc-operations) - - [Building steps](#tinycrypt-building-steps) + - [Building steps](#building-steps) @@ -273,8 +273,6 @@ See [Unlocking the Future of Project CHIP Webinar](https://www.nxp.com/design/training/unlocking-the-future-of-project-chip:TIP-EEE-UNLOCKING-THE-FUTURE-OF-PROJECT-CHIP) for an in-depth analysis of NXP capabilities for Project CHIP. - - ## Pigweed tokenizer The tokenizer is a pigweed module that allows hashing the strings. This greatly @@ -282,8 +280,6 @@ reduces the flash needed for logs. The module can be enabled by building with the gn argument _chip_pw_tokenizer_logging=true_. The detokenizer script is needed for parsing the hashed scripts. - - ### Detokenizer script The python3 script detokenizer.py is a script that decodes the tokenized logs @@ -312,8 +308,6 @@ where the decoded logs will be stored. This parameter is required for file usage and optional for serial usage. If not provided when used with serial port, it will show the decoded log only at the stdout and not save it to file. - - ### Notes The token database is created automatically after building the binary if the @@ -328,8 +322,6 @@ detokenizer script to see logs of a lock app: python3 ../../../../../examples/platform/nxp/k32w/k32w0/scripts/detokenizer.py serial -i /dev/ttyACM0 -d out/debug/chip-k32w0x-lock-example-database.bin -o device.txt ``` - - ### Known issues The building process will not update the token database if it already exists. In @@ -347,12 +339,8 @@ If run, closed and rerun with the serial option on the same serial port, the detokenization script will get stuck and not show any logs. The solution is to unplug and plug the board and then rerun the script. - - ## Tinycrypt ECC operations - - ### Building steps Note: This solution is temporary. diff --git a/examples/thermostat/efr32/README.md b/examples/thermostat/efr32/README.md index 35cbeefad50b4a..5df3866dcb0ca1 100644 --- a/examples/thermostat/efr32/README.md +++ b/examples/thermostat/efr32/README.md @@ -7,7 +7,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12. - [CHIP EFR32 Light Switch Example](#chip-efr32-light-switch-example) - [Introduction](#introduction) - [Building](#building) - - [Note](#note) - [Flashing the Application](#flashing-the-application) - [Viewing Logging Output](#viewing-logging-output) - [Running the Complete Example](#running-the-complete-example) @@ -18,8 +17,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12.
- - ## Introduction The EFR32 light switch example provides a baseline demonstration of a on-off @@ -38,8 +35,6 @@ The light switch example is intended to serve both as a means to explore the workings of CHIP as well as a template for creating real products based on the Silicon Labs platform. - - ## Building - Download the @@ -130,15 +125,11 @@ Silicon Labs platform. $ gn gen out/debug --args='import("//with_pw_rpc.gni")' $ ninja -C out/debug - [Running Pigweed RPC console](#running-pigweed-rpc-console) - For more build options, help is provided when running the build script without arguments ./scripts/examples/gn_efr32_example.sh - - ## Flashing the Application - On the command line: @@ -148,8 +139,6 @@ arguments - Or with the Ozone debugger, just load the .out file. - - ## Viewing Logging Output The example application is built to use the SEGGER Real Time Transfer (RTT) @@ -198,8 +187,6 @@ combination with JLinkRTTClient as follows: $ JLinkRTTClient - - ## Running the Complete Example - It is assumed here that you already have an OpenThread border router @@ -283,8 +270,6 @@ combination with JLinkRTTClient as follows: #Add Ipv6 route on PC(Linux) \$ sudo ip route add /64 via 2002::2 - - ## Running RPC console - As part of building the example with RPCs enabled the chip_rpc python