Skip to content

Commit

Permalink
Revert "[nxp fromtree] Docs: Move platform docs into their own direct…
Browse files Browse the repository at this point in the history
…ory and separate into subfolders (project-chip#34233)"

This reverts commit 3f96bbf.

Signed-off-by: Gatien Chapon <[email protected]>
  • Loading branch information
chapongatien committed Nov 7, 2024
1 parent 5ca022b commit 95e561b
Show file tree
Hide file tree
Showing 199 changed files with 343 additions and 543 deletions.
15 changes: 0 additions & 15 deletions docs/development_controllers/chip-repl/index.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs/development_controllers/chip-tool/index.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/development_controllers/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/getting_started/first_example.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ for testing.

[chip-tool](../../examples/chip-tool/) is a C++ command line controller with an
interactive shell. More information on chip-tool can be found in the
[chip-tool guide](../development_controllers/chip-tool/chip_tool_guide.md).
[chip-tool guide](../guides/chip_tool_guide.md).

[chip-repl](../../src/controller/python/chip-repl.py) is a shell for the python
controller. The chip-repl is part of the python controller framework, often used
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ to speed up development. You can find them in the samples with `/asr` subfolder.

## Building the Example Application

- [Setup Matter Environment](../../guides/BUILDING.md)
- [Setup Matter Environment](./BUILDING.md)

- Setup toolchain
- for ASR582X and ASR550X
Expand Down Expand Up @@ -140,7 +140,7 @@ There are two commissioning modes supported by ASR platform:
`build_examples.py` script. For example:
`./scripts/build/build_examples.py --target asr-$ASR_BOARD-lighting-ota build`
2. For more usage details, please refer to the
[OTA example](../../../examples/ota-requestor-app/asr/README.md)
[OTA example](../../examples/ota-requestor-app/asr/README.md)
## Factory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ Before you can use the CHIP Tool, you must compile it from source on Linux
To build and run the CHIP Tool:

1. Install all required packages for Matter and prepare the source code and the
build system. Read the [Building Matter](../../guides/BUILDING.md) guide for
instructions.
build system. Read the [Building Matter](BUILDING.md) guide for instructions.
2. Open a command prompt in the `connectedhomeip` directory.
3. Run the following command:

Expand Down
8 changes: 4 additions & 4 deletions docs/guides/darwin.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,17 +292,17 @@ Example:
- [ESP32 Lighting](/examples/lighting-app/esp32/README.md)
- [ESP32 Temperature Sensor](/examples/temperature-measurement-app/esp32/README.md)
- [mbedOS](/examples/all-clusters-app/mbed/README.md)
- [nRF Connect All Clusters](../platforms/nrf/nrfconnect_examples_configuration.md)
- [nRF Connect All Clusters](./nrfconnect_examples_configuration.md)
- [nRF Connect Pump](/examples/pump-app/nrfconnect/README.md)
- [NXP Examples](../platforms/nxp/nxp_imx8m_linux_examples.md)
- [NXP Examples](./nxp/nxp_imx8m_linux_examples.md)
- [NXP](/examples/all-clusters-app/nxp/mw320/README.md)
- [Infineon CYW30739 Lighting](/examples/lighting-app/infineon/cyw30739/README.md)
- [Infineon PSoC6](/examples/all-clusters-app/infineon/psoc6/README.md)
- [Qorvo](/examples/lighting-app/qpg/README.md)
- [Silicon Labs](../platforms/silabs/silabs_getting_started.md)
- [Silicon Labs](./silabs_getting_started.md)
- [Simulated Linux](./simulated_device_linux.md)
- [Telink](/examples/lighting-app/telink/README.md)
- [TI Platform](../platforms/ti/ti_matter_overview.md)
- [TI Platform](./ti/ti_matter_overview.md)
- [Tizen](/examples/lighting-app/tizen/README.md)

## Providing Feedback to Apple
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ $ out/debug/chip-tool pairing ble-wifi 12345 MY_SSID MY_PASSWORD 20202021 3840
#### Commissioning the Thread device (ESP32H2)
- For ESP32-H2, firstly start OpenThread Border Router, you can either use
[Raspberry Pi OpenThread Border Router](../openthread/openthread_border_router_pi.md)
[Raspberry Pi OpenThread Border Router](../openthread_border_router_pi.md)
OR
[ESP32 OpenThread Border Router](../../../examples/thread-br-app/esp32/README.md)
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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
43 changes: 43 additions & 0 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,56 @@ and features.
:hidden:
*
bouffalolab/matter_factory_data
esp32/README
nxp/README
ti/ti_matter_overview
```

## Build Guides

- [Building](./BUILDING.md)

## Platform Guides

- [Android - Building](./android_building.md)
- [Apple - Testing with iPhone, iPad, macOS, Apple TV, HomePod, Watch, etc](./darwin.md)
- [ASR - Getting Started Guide](./asr_getting_started_guide.md)
- [Bouffalo Lab - Matter factory data generation](./bouffalolab/matter_factory_data.md)
- [Espressif (ESP32) - Getting Started Guide](./esp32/README.md)
- [Infineon PSoC6 - Software Update](./infineon_psoc6_software_update.md)
- [Linux - Simulated Devices](./simulated_device_linux.md)
- [mbedOS - Adding a new target](./mbedos_add_new_target.md)
- [mbedOS - Commissioning](./mbedos_commissioning.md)
- [mbedOS - Platform Overview](./mbedos_platform_overview.md)
- [nRF Connect - Android Commissioning](./nrfconnect_android_commissioning.md)
- [nRF Connect - CLI Guide](./nrfconnect_examples_cli.md)
- [nRF Connect - Configuration](./nrfconnect_examples_configuration.md)
- [nRF Connect - Factory Data Configuration](./nrfconnect_factory_data_configuration.md)
- [nRF Connect - Platform Overview](./nrfconnect_platform_overview.md)
- [nRF Connect - Software Update](./nrfconnect_examples_software_update.md)
- [NXP - Getting Started Guide](./nxp/README.md)
- [Silicon Labs - Documentation](https://siliconlabs.github.io/matter/latest/index.html)
- [Silicon Labs - Getting Started](./silabs_getting_started.md)
- [Silicon Labs - Software Update](./silabs_efr32_software_update.md)
- [Silicon Labs - CLI Guide](./silabs_cli_guide.md)
- [TI - Platform Overview](./ti/ti_matter_overview.md)

## Tool Guides

- [CHIP Tool](./chip_tool_guide.md)
- [Python Matter-Repl](./matter-repl.md)
- [python-chip-controller - Advanced](./python_chip_controller_advanced_usage.md)
- [python-chip-controller - Building](./python_chip_controller_building.md)
- [CHEF test devices](../../examples/chef/README.md)
- [New device type adding](../../examples/chef/NEW_CHEF_DEVICES.md)

## Development Guides

- [Access Control](./access-control-guide.md)
- [Matter IDL tooling and validation](./matter_idl_tooling.md)

## Setup Guides

- [Open Thread - Hardware suggestions](./openthread_rcp_nrf_dongle.md)
- [Open Thread - Setting up a Raspberry Pi as a Border Router](./openthread_border_router_pi.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ To make provisioning possible and to control the Matter device from your Android
based smartphone, you must first build and install the CHIPTool application.

To build the CHIPTool application for your smartphone, read
[Android building guide](../android/android_building.md).
[Android building guide](android_building.md).

After building, install the application by completing the following steps:

Expand Down Expand Up @@ -154,7 +154,7 @@ brightness between 0-255.
If **Lighting LED** is available then brightness change can be observed.

> For more details about Android CHIPTool please visit
> [CHIPTool](../../../examples/android/CHIPTool/README.md)
> [CHIPTool](../../examples/android/CHIPTool/README.md)
## POSIX CLI CHIPTool

Expand All @@ -164,7 +164,7 @@ To make provisioning possible and to control the Matter device from Linux-based
device, you can build and run the Matter Client example application on it.

To build the POSIX CLI CHIPTool application check the guide
[POSIX CLI guide](../../../examples/chip-tool/README.md).
[POSIX CLI guide](../../examples/chip-tool/README.md).

### Device commissioning for CLI

Expand Down Expand Up @@ -196,7 +196,7 @@ For example:
The client will send a single command packet and then exit.

> For more details about POSIX CLI CHIPTool please visit
> [POSIX CLI CHIPTool](../../../examples/chip-tool/README.md)
> [POSIX CLI CHIPTool](../../examples/chip-tool/README.md)
## Python Device Controller

Expand All @@ -206,7 +206,7 @@ To make provisioning possible and to control the Matter device with Python
application, you can build and run the Python CHIP controller.

To build and install the Python Device Controller application check the guide
[Python Device Controller guide](../../development_controllers/chip-repl/python_chip_controller_building.md).
[Python Device Controller guide](python_chip_controller_building.md).

### Device commissioning for Python Device Controller

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@ needed to perform communication through the Matter stack.
Sample Matter applications are provided for the Mbed OS platform. They can be
used to speed up development:

- [shell](../../../examples/shell/mbed/README.md)
- [all-clusters-app](../../../examples/all-clusters-app/mbed/README.md)
- [lock-app](../../../examples/lock-app/mbed/README.md)
- [lighting-app](../../../examples/lighting-app/mbed/README.md)
- [pigweed-app](../../../examples/pigweed-app/mbed/README.md)
- [shell](../../examples/shell/mbed/README.md)
- [all-clusters-app](../../examples/all-clusters-app/mbed/README.md)
- [lock-app](../../examples/lock-app/mbed/README.md)
- [lighting-app](../../examples/lighting-app/mbed/README.md)
- [pigweed-app](../../examples/pigweed-app/mbed/README.md)

### Example configuration

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Commissioning nRF Connect Accessory using Android CHIPTool

You can use [CHIPTool](../android/android_building.md) for Android smartphones
to commission a Nordic Semiconductor's development kit programmed with a Matter
You can use [CHIPTool](android_building.md) for Android smartphones to
commission a Nordic Semiconductor's development kit programmed with a Matter
example for the nRF Connect platform into a Matter fabric.

This guide references the nRF52840 DK and Matter nRF Connect Lighting Example
Expand Down Expand Up @@ -86,10 +86,9 @@ accessory using Android CHIPTool:
> _Note:_ This step is only needed if you're testing a Thread device. Skip it if
> the tested device operates in a Wi-Fi network.
Follow the
[OpenThread Border Router](../openthread/openthread_border_router_pi.md) article
to set up OpenThread Border Router on the Raspberry Pi, with either the nRF52840
DK or the nRF52840 Dongle acting as the
Follow the [OpenThread Border Router](openthread_border_router_pi.md) article to
set up OpenThread Border Router on the Raspberry Pi, with either the nRF52840 DK
or the nRF52840 Dongle acting as the
[OpenThread Radio Co-Processor](https://openthread.io/platforms/co-processor).
During the setup, make sure that the Raspberry Pi is connected to your Wi-Fi
Access Point.
Expand All @@ -108,7 +107,7 @@ Application to learn how to build and program the example onto an nRF52840 DK.
## Building and installing Android CHIPTool

To build the CHIPTool application for your smartphone, read the
[Building Android](../android/android_building.md) guide.
[Building Android](android_building.md) guide.

After building, install the application by completing the following steps:

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ protocols:

> **_NOTE:_** The procedure presented below requires that you have OpenThread
> Border Router (OTBR) set up either in Docker or on a Raspberry Pi. Read
> [Setup OpenThread Border Router on Raspberry Pi](../openthread/openthread_border_router_pi.md)
> [Setup OpenThread Border Router on Raspberry Pi](openthread_border_router_pi.md)
> to learn how to install the OTBR on a Raspberry Pi.
The DFU over Matter involves two kinds of nodes:
Expand Down Expand Up @@ -94,6 +94,7 @@ To test the DFU over Matter, you need to complete the following steps:
10. Initiate the DFU procedure in one of the following ways:
- If you have built the device firmware with `-DCONFIG_CHIP_LIB_SHELL=y`
option, which enables Matter shell commands, run the following command
on the device shell:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -813,8 +813,8 @@ Alternatively, you can add the relevant Kconfig option lines to the example's
You can edit all configuration options using the interactive Kconfig interface.
See the
[Configuring nRF Connect examples](./nrfconnect_examples_configuration.md) page
for information about how to configure Kconfig options.
[Configuring nRF Connect examples](../guides/nrfconnect_examples_configuration.md)
page for information about how to configure Kconfig options.
In the configuration window, expand the items
`Modules -> connectedhomeip (/home/arbl/matter/connectedhomeip/config/nrfconnect/chip-module) -> Connected Home over IP protocol stack`.
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.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ connected to the IP network and do not require credentials provisioning.

## Building Matter controller

The [Matter controller](../../../src/controller/README.md) is a client
application that allows commission and control of the Matter node.
The [Matter controller](../../src/controller/README.md) is a client application
that allows commission and control of the Matter node.

The [POSIX CLI chip-tool](../../../examples/chip-tool/README.md) is the
recommended Matter controller to use with Open IoT SDK devices.
The [POSIX CLI chip-tool](../../examples/chip-tool/README.md) is the recommended
Matter controller to use with Open IoT SDK devices.

To build `chip-tool` execute command:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can use these examples as a reference for creating your own applications.
The VSCode devcontainer has all the dependencies pre-installed. It is the
recommended way to build, run and develop with the Open IoT SDK port of the
Matter Project. Please read this
[VSCode development guide](../../VSCODE_DEVELOPMENT.md) for more information.
[VSCode development guide](../VSCODE_DEVELOPMENT.md) for more information.

Before building the examples, check out the Matter repository and sync Open IoT
SDK submodules using the following command:
Expand Down Expand Up @@ -347,11 +347,11 @@ provides the `-K,--kvsfile` option to use the persistence options listed above.
Open IoT SDK port supports two crypto backend implementations:
- [Mbed TLS](./openiotsdk_platform_overview.md#mbed-tls) - it's the default
option
- [Mbed TLS](../guides/openiotsdk_platform_overview.md#mbed-tls) - it's the
default option
- [PSA crypto service](https://tf-m-user-guide.trustedfirmware.org/integration_guide/services/tfm_crypto_integration_guide.html)
from the
[TrustedFirmware-M (TF-M)](./openiotsdk_platform_overview.md#trusted-firmware-m)
[TrustedFirmware-M (TF-M)](../guides/openiotsdk_platform_overview.md#trusted-firmware-m)
component
The CMake variable `CONFIG_CHIP_CRYPTO` controls how cryptographic operations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ The last required element is a Matter controller. This application controls both
nodes and manages the entire software update process.

In the procedure described below, the `OTA Provider` will be a
[Linux application](../../../examples/ota-provider-app/linux/README.md) and the
[Linux application](../../examples/ota-provider-app/linux/README.md) and the
Open IoT SDK example with
[DFU support](./openiotsdk_examples.md#device-firmware-update) will work as the
OTA Requestor. The [chip-tool](../../../examples/chip-tool/README.md)
application used as the Matter controller. Each application should be launched
in a separate terminal.
OTA Requestor. The [chip-tool](../../examples/chip-tool/README.md) application
used as the Matter controller. Each application should be launched in a separate
terminal.

List of `OIS` examples that currently support the `DFU` over Matter:

Expand All @@ -41,7 +41,7 @@ List of `OIS` examples that currently support the `DFU` over Matter:
```
More details about the `OTA provider` application can be found
[here](../../../examples/ota-provider-app/linux/README.md).
[here](../../examples/ota-provider-app/linux/README.md).
3. Build `chip-tool`:
Expand All @@ -50,7 +50,7 @@ List of `OIS` examples that currently support the `DFU` over Matter:
```
More details about the `chip-tool` application can be found
[here](../../../examples/chip-tool/README.md).
[here](../../examples/chip-tool/README.md).
4. Build `OIS` example application
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Linux (amd64 / aarch64) or macOS.
To build and run the Python CHIP controller:

1. Install all necessary packages and prepare the build system. For more
details, see the [Building Matter](../../guides/BUILDING.md) documentation:
details, see the [Building Matter](BUILDING.md) documentation:

```
sudo apt-get update
Expand Down Expand Up @@ -77,8 +77,7 @@ To build and run the Python CHIP controller:
5. Build and install the Python CHIP controller:
```
scripts/build_python.sh -m platform -i out/python_env
source out/python_env/bin/activate
scripts/build_python.sh -m platform -i separate
```
> Note: This builds the Python CHIP Controller along with the CHIP REPL as
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ to 2).
Starting the ota-provider-app with the --otaImageList command line option allows
the user to supply a JSON file specifying the Software Version, Vendor and
Product ID that identify the image served by the Provider, see
[ota-provider-app](../../../examples/ota-provider-app/linux/README.md)
[ota-provider-app](../../examples/ota-provider-app/linux/README.md)

Example provider configuration file:

Expand Down
File renamed without changes.
Loading

0 comments on commit 95e561b

Please sign in to comment.