Google Git
Sign in
pigweed / third_party / github / project-chip / connectedhomeip / 3bd1a076c885b5cde48f115f3dcc5e9d6f3a4cb3 / . / examples / chip-tool
tree: 6b8a3f704fa24e7d0ff59b4a5685158faa262b8c [path history] [tgz]
  1. commands/
  2. third_party/
  3. build ⇨ third_party/connectedhomeip/build
  4. build_overrides ⇨ ../build_overrides
  5. .gn
  6. args.gni
  7. BUILD.gn
  8. Dockerfile
  9. entrypoint.sh
  10. main.cpp
  11. README.md
examples/chip-tool/README.md

CHIP Client Example

An example application that uses CHIP to send messages to a CHIP server.

Building the Example Application

Building the example application is quite straightforward.

gn

cd examples/chip-tool
git submodule update --init
source third_party/connectedhomeip/scripts/activate.sh
gn gen out/debug
ninja -C out/debug
  • After the application is built, it can be found in the build directory as out/debug/chip-tool

Using the Client to Request an Echo

Ping a device over BLE

To initiate a client echo request to a BLE device, run the built executable and pass it the discriminator and pairing code of the remote device. The command below uses the default values hard-coded into the debug versions of the ESP32 wifi-echo app:

$ chip-tool echo ble 3840 12345678

Ping a device over IP

To start the Client in echo mode, run the built executable and pass it the IP address and port of the server to talk to, as well as the command “echo”.

$ chip-tool echo ip 192.168.0.30 8000

If valid values are supplied, it will begin to periodically send messages to the server address provided.

It also verifies that the incoming echo from the server matches what was sent out.

Stop the Client at any time with Ctrl + C.

Using the Client to Send CHIP Commands

To use the Client to send a CHIP commands, run the built executable and pass it the target cluster name, the target command name, an endpoint id as well as the IP address and port of the server to talk to. The endpoint id must be between 1 and 240.

$ chip-tool onoff on 1 192.168.0.30 11095

The client will send a single command packet and then exit.

How to get the list of supported clusters

To get the list of supported clusters, run the built executable without any arguments.

$ chip-tool

How to get the list of supported commands for a specific cluster

To get the list of commands for a specific cluster, run the built executable with the target cluster name.

$ chip-tool onoff

How to get the list of supported attributes for a specific cluster

To the the list of attributes for a specific cluster, run the built executable with the target cluster name and the read command name.

$ chip-tool onoff read

How to get the list of parameters for a command

To get the list of parameters for a specific command, run the built executable with the target cluster name and the target command name

$ chip-tool onoff on