Skip to content

Commit

Permalink
Update documentation now that "bypass" rendezvous is gone. (#11879)
Browse files Browse the repository at this point in the history
  • Loading branch information
bzbarsky-apple authored and pull[bot] committed Jan 25, 2023
1 parent 194469c commit 9605110
Show file tree
Hide file tree
Showing 7 changed files with 5 additions and 65 deletions.
1 change: 1 addition & 0 deletions .github/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ cppreference
CPROTO
cpuapp
cpython
CQM
crypto
cryptographic
CSA
Expand Down
22 changes: 1 addition & 21 deletions examples/all-clusters-app/ameba/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down
10 changes: 0 additions & 10 deletions examples/bridge-app/linux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 0 additions & 8 deletions examples/chip-tool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -433,7 +426,6 @@ Usage:
| Commands: |
+-------------------------------------------------------------------------------------+
| * unpair |
| * bypass |
| * ble |
| * softap |
+-------------------------------------------------------------------------------------+
Expand Down
15 changes: 2 additions & 13 deletions examples/lighting-app/linux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions examples/lighting-app/telink/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
10 changes: 0 additions & 10 deletions examples/tv-app/linux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9605110

Please sign in to comment.