Skip to content

Commit ce8a60e

Browse files
authored
Revise README for clarity and added demo application info
Updated README to clarify library description and usage.
1 parent 09e9a37 commit ce8a60e

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

readme.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,14 @@
33
![build](https://github.com/tom-code/rust-matc/actions/workflows/rust.yml/badge.svg)
44
[![doc](https://github.com/tom-code/rust-matc/actions/workflows/doc.yml/badge.svg)](https://tom-code.github.io/rust-matc/matc/)
55

6-
This is prototype of matter protocol library in rust (controller side).
6+
This is matter protocol library in rust (controller side).
77

88
[API doc](https://tom-code.github.io/rust-matc/matc/)
99

1010
[Examples](https://github.com/tom-code/rust-matc/tree/main/examples)
1111

12+
[Matter controller desktop application also demonstrates use of this library](https://github.com/tom-code/matc-ui)
13+
1214
It supports controller side of:
1315

1416
* PASE - passcode authenticated session establishment
@@ -19,8 +21,9 @@ It supports controller side of:
1921
* sign and push certificates to device
2022
* BLE commissioning with Wi-Fi/Thread credential provisioning (opt-in, `--features ble`)
2123
* Basic interactions
22-
* Read attribute
23-
* Invoke command
24+
* Read/Write attributes
25+
* Invoke commands
26+
* Subscribe for notifications
2427

2528
### BLE commissioning
2629

@@ -37,7 +40,9 @@ cargo run --features ble --example simple-ble -- \
3740
--pairing-code "MT:Y.K908..." --ssid HomeWifi --password secret --node-id 300 --name "kitchen light"
3841
```
3942

40-
Use of demo application:
43+
### Use of demo application:
44+
note: this is original low level demo application. It is probably better to follow devman_demo for higher level api. See https://github.com/tom-code/rust-matc/tree/main/examples
45+
4146
* Compile demo application using cargo. Binary will be found usually in target/debug/examples/demo.\
4247
`cargo build --example demo`
4348
* demo application uses clap. use --help to learn all supported parameters
@@ -73,4 +78,4 @@ Other demo application flags:
7378
* --local-address - specify local bind address for matter protocol. Format is ip:port. This is
7479
ip/port which is used as source address for matter UDP requests.
7580
Default is 0.0.0.0:5555. When IPV6 is used this must be changed for example to --local-address "[\:\:]:5555"
76-
* --cert-path - change directory where pem files with keys and certificates are stored
81+
* --cert-path - change directory where pem files with keys and certificates are stored

0 commit comments

Comments
 (0)