From 118a37c3c43a3cdd239ec7a3f84924b423397483 Mon Sep 17 00:00:00 2001 From: Martin Turon Date: Tue, 31 Aug 2021 16:04:15 -0700 Subject: [PATCH] [docs] Document IP Pairing and chip-tool tests. (#8548) --- docs/QUICK_START.md | 31 +++++++++++++++++++++++++++---- examples/chip-tool/README.md | 11 +++++++++++ 2 files changed, 38 insertions(+), 4 deletions(-) diff --git a/docs/QUICK_START.md b/docs/QUICK_START.md index bdaa1aee46ae6d..2749be25cfc868 100644 --- a/docs/QUICK_START.md +++ b/docs/QUICK_START.md @@ -7,10 +7,10 @@ platforms. ## WiFi Nodes -|
Controller / Admin
|
Node
| Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [**chip-tool**](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md) (Linux / Mac)
Includes docs for all the cluster commands supported
| **all-clusters-app**
  • [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)
  • [Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Use the command line tool on a laptop to pair with and control an embedded WiFi platform. This demo supports the “all-clusters-app”, so it provides the basic onoff light test but much more. Two increment modes of operation are supported for testing (configurable via Kconfig tool when building M5):
    1. Unsecured (WiFi only)
      BLE Rendezvous Mode Bypass = 1
    2. PASE secured
      (BLE pairing, WiFi operational)
    | -| [**chip-device-ctrl.py**](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) | **all-clusters-app**
  • [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)
  • [Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Same as above, but uses the pychip tool as Controller Node, and focuses on BLE flow rather than Bypass. | +|
    Controller / Admin
    |
    Node
    | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [**chip-tool**](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md) (Linux / Mac)
    Includes docs for all the cluster commands supported
    | **all-clusters-app**
  • [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)
  • [Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Use the command line tool on a laptop to pair with and control an embedded WiFi platform. This demo supports the “all-clusters-app”, so it provides the basic onoff light test and more. Two incremental modes of operation are supported for testing (configurable via Kconfig tool when building M5):
    1. Unsecured (WiFi only)
      BLE Rendezvous Mode Bypass = 1
    2. PASE secured
      (BLE pairing, WiFi operational)
    | +| [**chip-device-ctrl.py**](https://github.com/project-chip/connectedhomeip/blob/master/src/controller/python/README.md) | **all-clusters-app**
  • [M5Stack](https://github.com/project-chip/connectedhomeip/blob/master/examples/all-clusters-app/esp32/README.md) (ESP)
  • [Linux](https://github.com/project-chip/connectedhomeip/tree/master/examples/all-clusters-app/linux) simulation | Same as above, but uses the pychip tool as Controller Node, and focuses on BLE flow rather than Bypass. | ## Thread Nodes @@ -21,3 +21,26 @@ combination listed below. | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [**ot-br**](https://openthread.io/guides/border-router/build)
    Thread Border Router
  • RasPi
  • BeagleBone | **lighting-app**
  • [Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nrfconnect/README.md)
  • [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/k32w/README.md)
  • [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/qpg)
  • [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/efr32/README.md) | The Lighting example is supported by many of the available Thread platforms. See the chip-tool controller instructions for how to actuate the light on/off cluster. | | [**ot-br**](https://openthread.io/guides/border-router/build)
    Thread Border Router
  • RasPi
  • BeagleBone | **lock-app**
  • [Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nrfconnect/README.md)
  • [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/k32w/README.md)
  • [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/qpg)
  • [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/efr32/README.md)
  • [TI CC13x2x7](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/cc13x2x7_26x2x7/README.md) | The Lock example is supported by many of the available Thread and WiFi platforms. | + +## Controllers + +### chip-tool + +This section summarizes how to run some common scenarios with the +[**chip-tool**](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md) +controller. + +#### IP Pairing + +`chip-tool pairing onnetwork 0 20202021 3840 ::1 5540` will use PASE over IP to +pair a device. + +NOTE: to run both the Node and Controller as separate processes on the same +Linux or Mac machine, build the all-clusters-app with BLE disabled as follows: + +`scripts/examples/gn_build_example.sh examples/all-clusters-app/linux out/debug/standalone/ chip_config_network_layer_ble=false` + +#### Automated CASE tests + +`chip-tool tests Test_TC_OO_1_1` will run a suite of tests that use CASE To +communicate with a paired `all-clusters-app` peer node. diff --git a/examples/chip-tool/README.md b/examples/chip-tool/README.md index 4771186d417385..e68ee541649fdb 100644 --- a/examples/chip-tool/README.md +++ b/examples/chip-tool/README.md @@ -76,6 +76,13 @@ or equivalently: $ chip-tool pairing ble-wifi hex:787980 hex:736563726574 0 20202021 3840 +#### Pair a device over IP + +The command below will pair to a localhost device (`::1`) running the +`all-clusters-app` on the default port (`5540`) over IPv6: + + $ chip-tool pairing onnetwork 0 20202021 3840 ::1 5540 + ### Forget the currently-commissioned device $ chip-tool pairing unpair @@ -144,6 +151,10 @@ with the target cluster name and the target command name $ chip-tool onoff on +### Run a test suite against a paired peer device + + $ chip-tool tests Test_TC_OO_1_1 + ## Using the Client for Setup Payload ### How to parse a setup code