From 9605110be7dfc385a05665e928be1a77665c6a89 Mon Sep 17 00:00:00 2001 From: Boris Zbarsky Date: Tue, 16 Nov 2021 16:58:05 -0500 Subject: [PATCH] Update documentation now that "bypass" rendezvous is gone. (#11879) --- .github/.wordlist.txt | 1 + examples/all-clusters-app/ameba/README.md | 22 +--------------------- examples/bridge-app/linux/README.md | 10 ---------- examples/chip-tool/README.md | 8 -------- examples/lighting-app/linux/README.md | 15 ++------------- examples/lighting-app/telink/Readme.md | 4 +--- examples/tv-app/linux/README.md | 10 ---------- 7 files changed, 5 insertions(+), 65 deletions(-) diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt index 52dd940b17d0ab..871d66ee2d8c53 100644 --- a/.github/.wordlist.txt +++ b/.github/.wordlist.txt @@ -216,6 +216,7 @@ cppreference CPROTO cpuapp cpython +CQM crypto cryptographic CSA diff --git a/examples/all-clusters-app/ameba/README.md b/examples/all-clusters-app/ameba/README.md index a21e4c926635a8..69dfd29aa11c4c 100644 --- a/examples/all-clusters-app/ameba/README.md +++ b/examples/all-clusters-app/ameba/README.md @@ -10,7 +10,6 @@ control. - [Building the Example Application](#building-the-example-application) - [Commissioning and cluster control](#commissioning-and-cluster-control) - [Commissioning](#commissioning) - - [Bypass mode](#bypass-mode) - [BLE mode](#ble-mode) - [IP mode](#ip-mode) - [Cluster control](#cluster-control) @@ -59,26 +58,7 @@ The CHIP demo application is supported on ## Commissioning -There are three commissioning modes supported by Ameba platform: - -### Bypass mode - -1. In "connectedhomeip/config/ameba/args.gni" - - - set `chip_bypass_rendezvous = true` - - Set `chip_config_network_layer_ble = false` - -2. In "connectedhomeip/src/platform/Ameba/CHIPDevicePlatformConfig.h" - - - Set `#define CHIP_DEVICE_CONFIG_ENABLE_CHIPOBLE 0` - -3. Build and Flash -4. Use ATS\$ command to run all-cluster example. -5. Connect to AP using `ATW0, ATW1, ATWC` commands -6. Test with - [Chip-Tool](https://github.com/project-chip/connectedhomeip/tree/master/examples/chip-tool) - or - [Python Controller](https://github.com/project-chip/connectedhomeip/blob/master/docs/guides/python_chip_controller_building.md). +There are two commissioning modes supported by Ameba platform: ### BLE mode diff --git a/examples/bridge-app/linux/README.md b/examples/bridge-app/linux/README.md index 546ea0a7e83819..9cdd2a30f8080c 100644 --- a/examples/bridge-app/linux/README.md +++ b/examples/bridge-app/linux/README.md @@ -129,16 +129,6 @@ value/label pair `"room"`/`[light name]`. ## Running the Complete Example on Raspberry Pi 4 -> If you want to test ZCL, please disable Rendezvous -> -> gn gen out/debug --args='bypass_rendezvous=true' -> ninja -C out/debug -> -> Note that GN will set bypass_rendezvous for future builds, to enable -> rendezvous, re-generate using -> -> gn gen out/debug --args='chip_bypass_rendezvous=false' - - Prerequisites 1. A Raspberry Pi 4 board diff --git a/examples/chip-tool/README.md b/examples/chip-tool/README.md index 871361d45fca96..61a23a6209a8af 100644 --- a/examples/chip-tool/README.md +++ b/examples/chip-tool/README.md @@ -42,13 +42,6 @@ configuration. To initiate a client commissioning request to a device, run the built executable and choose the pairing mode. -##### Commission a device configured to bypass Rendezvous - -The command below commissions a device with the provided IP address and port of -the server to talk to. - - $ chip-tool pairing bypass ${NODE_ID_TO_ASSIGN} 192.168.0.30 5540 - #### Commission a device over BLE Run the built executable and pass it the discriminator and pairing code of the @@ -433,7 +426,6 @@ Usage: | Commands: | +-------------------------------------------------------------------------------------+ | * unpair | - | * bypass | | * ble | | * softap | +-------------------------------------------------------------------------------------+ diff --git a/examples/lighting-app/linux/README.md b/examples/lighting-app/linux/README.md index 4cb22a5c396ebf..03f079532cad75 100644 --- a/examples/lighting-app/linux/README.md +++ b/examples/lighting-app/linux/README.md @@ -73,20 +73,9 @@ To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini** ## Running the Complete Example on Raspberry Pi 4 -> If you want to test ZCL, please disable Rendezvous +> If you want to test Echo protocol, please enable Echo handler > -> gn gen out/debug --args='chip_bypass_rendezvous=true' -> ninja -C out/debug -> -> Note that GN will set chip_bypass_rendezvous for future builds, to enable -> rendezvous, re-generate using -> -> gn gen out/debug --args='chip_bypass_rendezvous=false' - -> If you want to test Echo protocol, please disable Rendezvous and enable Echo -> handler -> -> gn gen out/debug --args='chip_bypass_rendezvous=true chip_app_use_echo=true' +> gn gen out/debug --args='chip_app_use_echo=true' > ninja -C out/debug - Prerequisites diff --git a/examples/lighting-app/telink/Readme.md b/examples/lighting-app/telink/Readme.md index 3e35a8131da4cd..b852dfb6f8b74f 100644 --- a/examples/lighting-app/telink/Readme.md +++ b/examples/lighting-app/telink/Readme.md @@ -163,14 +163,12 @@ following states: 1. Pair with device ``` - ${CHIP_TOOL_DIR}/chip-tool pairing bypass ${NODE_ID_TO_ASSIGN} ${IP_ADDRESS_OF_CHIP_DEVICE} 5540 + ${CHIP_TOOL_DIR}/chip-tool pairing qrcode ${NODE_ID_TO_ASSIGN} MT:D8XA0CQM00KA0648G00 ``` here: - \${NODE_ID_TO_ASSIGN} is the node id to assign to the lightbulb - - `${IP_ADDRESS_OF_CHIP_DEVICE}` is IPv6 address of CHIP device - - **5540** is the standard CHIP TCP port 1. Switch on the light: diff --git a/examples/tv-app/linux/README.md b/examples/tv-app/linux/README.md index 1522f4d595340c..5196b4b282cc36 100644 --- a/examples/tv-app/linux/README.md +++ b/examples/tv-app/linux/README.md @@ -38,16 +38,6 @@ Desktop 20.10 (aarch64)** ## Running the Complete Example on Raspberry Pi 4 -> If you want to test ZCL, please disable Rendezvous -> -> gn gen out/debug --args='bypass_rendezvous=true' -> ninja -C out/debug -> -> Note that GN will set bypass_rendezvous for future builds, to enable -> rendezvous, re-generate using -> -> gn gen out/debug --args='chip_bypass_rendezvous=false' - - Prerequisites 1. A Raspberry Pi 4 board