Skip to content

Commit f4019b6

Browse files
committed
[Realtek] Update README
1 parent e9af3bc commit f4019b6

File tree

11 files changed

+38528
-35
lines changed

11 files changed

+38528
-35
lines changed

examples/light-switch-app/realtek_bee/README.md

+73-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,79 @@
1-
---
2-
orphan: true
3-
---
1+
# Matter BEE4 Light Switch Example Application
42

5-
# Matter BEE4 SDK
3+
This reference application implements an light switch device type. You can use
4+
this example as a reference for creating your own application.
65

7-
## Realtek SDK
6+
The example is based on:
87

9-
More detailed information on the Bee4 SDK can be found in the
10-
[Realtek Matter SDK](https://github.com/rtkconnectivity/rtl87x2g_sdk).
8+
- [Matter](https://github.com/project-chip/connectedhomeip)
9+
- [BEE4 github SDK](https://github.com/rtkconnectivity/rtl87x2g_sdk)
10+
- [OT-REALTEK](https://github.com/rtkconnectivity/ot-realtek)
11+
12+
## Supported devices
13+
14+
- [RTL8777G]
15+
16+
## Introduction
17+
18+
The application showcases a light switch device that communicates with clients
19+
over a low-power, 802.15.4 Thread network.
20+
21+
It can be commissioned into an existing Matter network using a controller such
22+
as `chip-tool`.
23+
24+
This example implements a `Standard commissioning flow`, meaning devices not
25+
connected to the network automatically broadcast advertising when powered on.
26+
The initial commissioning is done through `ble-thread` pairing method.
27+
28+
The Thread network dataset will be transferred on the device using a secure
29+
session over Bluetooth LE.To pair successfully, the commissioner must know the
30+
commissioning information corresponding to the device: setup passcode and
31+
discriminator. This data is usually encoded within a QR code or printed to the
32+
UART console.
33+
34+
## Prerequisites for building
35+
36+
In order to build the example, it is recommended to use a Linux distribution.
37+
Please visit the supported Operating Systems list in
38+
[BUILDING.md](../../../docs/guides/BUILDING.md#prerequisites).
39+
40+
- Make sure that below prerequisites are correctly installed (as described in
41+
[BUILDING.md](../../../docs/guides/BUILDING.md#prerequisites))
42+
43+
```
44+
sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev libglib2.0-dev libavahi-client-dev ninja-build python3-venv python3-dev python3-pip unzip libgirepository1.0-dev libcairo2-dev libreadline-dev
45+
```
46+
47+
- Step 1: checkout Realtek specific submodules only
48+
49+
```
50+
user@ubuntu:~/Desktop/git/connectedhomeip$ scripts/checkout_submodules.py --shallow --platform realtek_bee --recursive
51+
```
52+
53+
- Step 1: Init REALTEK SDK
54+
55+
```
56+
cd ./third_party/openthread/ot-realtek
57+
user@ubuntu:~/Desktop/git/connectedhomeip/third_party/openthread/ot-realtek$ git submodule update --init --recursive
58+
```
59+
60+
- Step 3: activate local environment
61+
62+
```
63+
user@ubuntu:~/Desktop/git/connectedhomeip$ source scripts/activate.sh
64+
```
65+
66+
If the script says the environment is out of date, you can update it by
67+
running the following command:
68+
69+
```
70+
user@ubuntu:~/Desktop/git/connectedhomeip$ source scripts/bootstrap.sh
71+
```
72+
73+
## Building
74+
75+
user@ubuntu:~/Desktop/git/connectedhomeip$ cd ./third_party/openthread/ot-realtek
76+
user@ubuntu:~/Desktop/git/connectedhomeip/third_party/openthread/ot-realtek$ OT_CMAKE_NINJA_TARGET="matter-cli-mtd" ./Realtek/build bee4 sdk rtl8777g light-switch-app
1177
1278
## More information
1379

0 commit comments

Comments
 (0)