Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Matter Linux Dishwasher Example README #34873

Merged
merged 5 commits into from
Aug 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 27 additions & 13 deletions examples/dishwasher-app/linux/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Matter Linux Lighting Example
# Matter Linux Dishwasher Example

An example showing the use of Matter on the Linux. The document will describe
how to build and run Matter Linux Lighting Example on Raspberry Pi. This doc is
tested on **Ubuntu for Raspberry Pi Server 20.04 LTS (aarch64)** and **Ubuntu
how to build and run Matter Linux Dishwasher Example on Raspberry Pi. This doc
is tested on **Ubuntu for Raspberry Pi Server 20.04 LTS (aarch64)** and **Ubuntu
for Raspberry Pi Desktop 20.10 (aarch64)**

To cross-compile this example on x64 host and run on **NXP i.MX 8M Mini**
Expand All @@ -12,7 +12,7 @@ details.

<hr>

- [Matter Linux Lighting Example](#matter-linux-lighting-example)
- [Matter Linux Dishwasher Example](#matter-linux-dishwasher-example)
- [Building](#building)
- [Commandline Arguments](#commandline-arguments)
- [Running the Complete Example on Raspberry Pi 4](#running-the-complete-example-on-raspberry-pi-4)
Expand All @@ -29,20 +29,20 @@ details.

- Build the example application:

$ cd ~/connectedhomeip/examples/lighting-app/linux
$ cd ~/connectedhomeip/examples/dishwasher-app/linux
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ gn gen out/debug
$ ninja -C out/debug

- To delete generated executable, libraries and object files use:

$ cd ~/connectedhomeip/examples/lighting-app/linux
$ cd ~/connectedhomeip/examples/dishwasher-app/linux
$ rm -rf out/

- Build the example with pigweed RPC

$ cd ~/connectedhomeip/examples/lighting-app/linux
$ cd ~/connectedhomeip/examples/dishwasher-app/linux
$ git submodule update --init
$ source third_party/connectedhomeip/scripts/activate.sh
$ gn gen out/debug --args='import("//with_pw_rpc.gni")'
Expand Down Expand Up @@ -107,16 +107,30 @@ details.
RX bytes:8609495 acl:14 sco:0 events:217484 errors:0
TX bytes:92185 acl:20 sco:0 commands:5259 errors:0

- Run Linux Lighting Example App
- Run Linux Dishwasher Example App

$ cd ~/connectedhomeip/examples/lighting-app/linux
$ sudo out/debug/chip-lighting-app --ble-device [bluetooth device number]
$ cd ~/connectedhomeip/examples/dishwasher-app/linux
$ sudo out/debug/chip-dishwasher-app --ble-device [bluetooth device number]
# In this example, the device we want to use is hci1
$ sudo out/debug/chip-lighting-app --ble-device 1
$ sudo out/debug/chip-dishwasher-app --ble-device 1

- Test the device using ChipDeviceController on your laptop /
workstation etc.

## Control

Control the operational mode:

```
$ chip-tool operationalstate start <node_id> <endpoint>
$ chip-tool operationalstate stop <node_id> <endpoint>
$ chip-tool operationalstate pause <node_id> <endpoint>

$ chip-tool operationalstate start 1 1
$ chip-tool operationalstate stop 1 1
$ chip-tool operationalstate pause 1 1
```

## Running RPC Console

- As part of building the example with RPCs enabled the chip_rpc python
Expand All @@ -129,9 +143,9 @@ details.
`chip-console -s localhost:33000 -o /<YourFolder>/pw_log.out`

- Then you can Get and Set the light using the RPCs:
`rpcs.chip.rpc.Lighting.Get()`
`rpcs.chip.rpc.Dishwasher.Get()`

`rpcs.chip.rpc.Lighting.Set(on=True, level=128, color=protos.chip.rpc.LightingColor(hue=5, saturation=5))`
`rpcs.chip.rpc.Dishwasher.Set(on=True, level=128, color=protos.chip.rpc.DishwasherColor(hue=5, saturation=5))`

## Device Tracing

Expand Down
Loading