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 192.168.0.30 8000 echo

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 comands, run the built executable and pass it the IP address and port of the server to talk to, the name of the command to send, as well as an enpoint id. Right now the “off”, “on”, and “toggle” commands are supported, from the On/Off cluster. The endpoint id must be between 1 and 240.

      $ chip-tool 192.168.0.30 8000 on 1

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