Skip to content

Commit

Permalink
doc: sphinx: rebase on master
Browse files Browse the repository at this point in the history
Signed-off-by: Gaute Svanes Lunde <[email protected]>
  • Loading branch information
gautesl committed Aug 23, 2022
1 parent 0da5d60 commit 8a8c73e
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 35 deletions.
9 changes: 9 additions & 0 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,15 @@ shell/**/README
temperature-measurement-app/**/README
```

## Thermostat example

```{toctree}
:glob:
:maxdepth: 1
thermostat/**/README
```

## TV example

```{toctree}
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/darwin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/nrfconnect_factory_data_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
24 changes: 6 additions & 18 deletions examples/lock-app/nxp/k32w/k32w0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

</hr>

Expand Down Expand Up @@ -273,17 +273,13 @@ 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.

<a name="tokenizer"></a>

## Pigweed tokenizer

The tokenizer is a pigweed module that allows hashing the strings. This greatly
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.

<a name="detokenizer"></a>

### Detokenizer script

The python3 script detokenizer.py is a script that decodes the tokenized logs
Expand Down Expand Up @@ -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.

<a name="detokenizer-notes"></a>

### Notes

The token database is created automatically after building the binary if the
Expand All @@ -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
```

<a name="detokenizer-known-issues"></a>

### Known issues

The building process will not update the token database if it already exists. In
Expand All @@ -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.

<a name="tinycrypt"></a>

## Tinycrypt ECC operations

<a name="tinycrypt-building-steps"></a>

### Building steps

Note: This solution is temporary.
Expand Down
15 changes: 0 additions & 15 deletions examples/thermostat/efr32/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -18,8 +17,6 @@ An example showing the use of CHIP on the Silicon Labs EFR32 MG12.

<hr>

<a name="intro"></a>

## Introduction

The EFR32 light switch example provides a baseline demonstration of a on-off
Expand All @@ -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.

<a name="building"></a>

## Building

- Download the
Expand Down Expand Up @@ -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

<a name="flashing"></a>

## Flashing the Application

- On the command line:
Expand All @@ -148,8 +139,6 @@ arguments

- Or with the Ozone debugger, just load the .out file.

<a name="view-logging"></a>

## Viewing Logging Output

The example application is built to use the SEGGER Real Time Transfer (RTT)
Expand Down Expand Up @@ -198,8 +187,6 @@ combination with JLinkRTTClient as follows:

$ JLinkRTTClient

<a name="running-complete-example"></a>

## Running the Complete Example

- It is assumed here that you already have an OpenThread border router
Expand Down Expand Up @@ -283,8 +270,6 @@ combination with JLinkRTTClient as follows:
#Add Ipv6 route on PC(Linux) \$ sudo ip route add <Thread global ipv6 prefix>/64
via 2002::2
<a name="running-pigweed-rpc-console"></a>
## Running RPC console
- As part of building the example with RPCs enabled the chip_rpc python
Expand Down

0 comments on commit 8a8c73e

Please sign in to comment.