Skip to content

Commit a844f78

Browse files
Merge pull request #1 from SiliconLabsSoftware/doccurator/2.6.0
Doccurator/2.6.0
2 parents ff51e24 + 9c149d1 commit a844f78

File tree

1,653 files changed

+11606
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,653 files changed

+11606
-128
lines changed

.github/workflows/00-Check-Code-Convention.yml

Lines changed: 0 additions & 94 deletions
This file was deleted.

.github/workflows/02-Build-Firmware.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Matter Fundamentals
2+
3+
This section contains information for those not yet familiar with Matter.
4+
5+
- [**Introduction to Matter**](/matter/{build-docspace-version}/matter-fundamentals-introduction): Offers an overview for those new to Matter.
6+
- [**The Matter Data Model**](/matter/{build-docspace-version}/matter-fundamentals-data-model): Reviews the components of the Matter Data Model including nodes, endpoints, clusters, and device types.
7+
- [**The Matter Interaction Model**](/matter/{build-docspace-version}/matter-fundamentals-interaction-model): Describes how the model defines the methods of communication between nodes, serving as the common language for node-to-node information transmission.
8+
- [**Matter Security**](/matter/{build-docspace-version}/matter-fundamentals-security): Provides an overview of security for Matter as promoted by the Connectivity Standards Alliance.
Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# Light and Switch Step-by-Step Example
2+
3+
## Setting up the Matter Hub/Chip-Tool
4+
5+
This procedure prepares the Raspberry Pi 4B (RPi4B) to become a Matter Hub. You should have downloaded the Matter Hub Raspberry Pi image and Raspberry Pi Imager as described in the [Overview](/matter/{build-docspace-version}/matter-overview). The Raspberry Pi image contains software called chip-tool, which provides a command-line interface into the Matter protocol.
6+
7+
1. Install the Raspberry Pi Imager and insert the SD card into the PC to flash the image.
8+
9+
1. Open the Imager, select the Operating System as 'Custom OS' and browse for the Raspberry Pi Image.
10+
11+
2. Select the storage as an SD card.
12+
13+
3. Click the settings icon to configure the access point (AP) credentials, Hostname and user credentials. Make sure the 5 GHz Wi-Fi credentials of the dual-band AP are entered.
14+
15+
4. Click the 'write' option. **Note** this will erase all existing content on that SD card.
16+
17+
2. Insert the SD card into Raspberry Pi 4B (RPi4B).
18+
19+
3. Power-up the RPi4B. Once it is booted up, check the Raspberry Pi's IP address. Refer to [Finding Raspberry Pi IP address](/matter/{build-docspace-version}/matter-references/find-raspi) in the References chapter to get the IP address or enter the Hostname directly in PuTTY.
20+
21+
4. Use PuTTY to connect to RPi4B.
22+
23+
1. The first time connecting to RPi4B, PuTTY will warn about a new host key or key fingerprint. Accept the key.
24+
2. The credentials (username: password) are the same given Step 1.
25+
3. Switch to root mode and navigate to path "/home/ubuntu/connectedhomeip/out/standalone" to find the chip-tool.
26+
27+
Matter hub/chip-tool are ready and working. Keep the PuTTY session open for the following steps.
28+
29+
## Creating the Matter Accessory Devices (MADs)
30+
31+
> If using NCP hardware, make sure firmware is properly loaded to the NCP using instructions provided in: [Upgrading the Wi-Fi Connectivity Firmware](/matter/{build-docspace-version}/matter-wifi-run-demo/loading-firmware-for-ncp-and-soc-boards).
32+
33+
1. In Simplicity Studio 5, create the Light MAD:
34+
35+
1. Switch to the Launcher view (if not already in it).
36+
37+
2. Connect one compatible dev board to the development computer.
38+
39+
3. Once it shows up in the Debug Adapters view, select it.
40+
41+
4. Open the Example Projects and Demos tab, select the **Matter** filter and enter "_Wi-Fi_" in **Filter on keywords**.
42+
43+
5. Select the _Matter - SoC Lighting over Wi-Fi_ example for RS9116, click **Create**, rename the project if you wish, and click **Finish**.
44+
45+
6. Once the project is created, the perspective changes to the Simplicity IDE perspective. In the Project Explorer view, right-click the project and select _Build Project_.
46+
47+
7. Once the project has compiled, in the Debug Adapters view right-click the board and select _Upload application_.
48+
49+
8. Select the _Application image path_ (Select the path for .s37 file in the path '\<solution\>\project*name\GNU ARM v12.2.1 - Default') for the newly compiled project and a \_Bootloader image*. The EFR32MG24 devices must be programmed with a bootloader. Obtain those here: [Silicon Labs Matter Artifacts](/matter/{build-docspace-version}/matter-prerequisites/matter-artifacts).
50+
51+
9. Disconnect the dev board from development computer.
52+
53+
10. **Optional**: Label this device (eg: my_light or my_switch) to make it easier to identify later.
54+
55+
2. Repeat the process with the second Dev board, but selecting the _Matter - SoC Light Switch over Wi-Fi_ example instead.
56+
57+
## Creating the Matter Network
58+
59+
This procedure uses the chip-tool installed on the Matter Hub. Chip-tool includes many commands. The following are some that are used in this example:
60+
61+
- `chip-tool ble-wifi pairing`
62+
- `chip-tool onoff`
63+
- `chip-tool toggle`
64+
- `chip-tool accesscontrol`
65+
- `chip-tool binding`
66+
67+
In a PuTTY session to the Matter hub, use the chip-tool to commission the Matter light device.The various compatible boards will have different setups for their LED(s). Typically one LED (or a color channel, if RGB) will be used to indicate the network status of the device:
68+
69+
- A short flash indicates the MAD is advertising to join a network
70+
71+
- A rapid flash indicates the commissioning is in progress
72+
73+
- Solid ON: the MAD is now in the network
74+
75+
1. Power up the Matter Light device.
76+
77+
2. Once it is powered up and booted, use the PuTTY session to commission the device using
78+
79+
`./chip-tool pairing ble-wifi nodeID SSID PSK 20202021 3840`
80+
81+
where `nodeID` is replaced with the desired ID (for example `./chip-tool pairing ble-wifi 1122 SlWifi 12345678 20202021 3840`).
82+
83+
3. Make sure the SSID and PSK given here are of 2.4 GHz of the Dual Band AP.
84+
85+
Be sure to note which nodeIDs are used for Matter light and Matter light_switch devices. These will be needed later for modifying the Matter light's ACL & the Matter light switch's binding table.
86+
87+
4. Power up the Matter light switch device and commission it too, using a different `nodeID`.
88+
89+
Now two Matter accessory devices (MADs) are on the network and ready to be used.
90+
91+
## Controlling the Light MAD
92+
93+
1. In a PuTTY session to the Matter hub, use the chip-tool to test the Matter light device.
94+
95+
1. Control the light status of the light MAD Using `./chip-tool onoff on nodeID 1`. You can also use `chip-tool onoff off` and `chip-tool toggle`.
96+
2. For dev board with buttons available, you can use BTN1 to toggle the light status locally.
97+
98+
2. In a PuTTY session to the Matter hub, use the chip-tool to bind the light_switch MAD to the light MAD, thus allowing the switch to control the light.
99+
100+
1. First, modify the Access Control List (ACL) of the Matter light device. This list determines which device in the network the Matter light device will react to. Use: `./chip-tool accesscontrol write acl '[ { "fabricIndex" : 1 , "privilege" : 5 , "authMode" : 2 , "subjects" : [`**`112233`**`] , "targets" : null } , { "fabricIndex" : 1 , "privilege" : 3 , "authMode" : 2 , "subjects" : [`**`nodeID-switch`**`], "targets" : null }]'`**`nodeID-light 0`**, where the highlighted parameters are:
101+
102+
- **112233**: The node ID of the controller. This is always 112233.
103+
104+
- **nodeID-switch**: The node ID of the Matter light switch device.
105+
106+
- **nodeID-light**: The node ID of the Matter light device.
107+
108+
- **0**: The endpoint in the Matter light device that holds the ACL. This is always 0.
109+
110+
To read the ACL for a Matter device use: `./chip-tool accesscontrol read acl`**`nodeID 0`**, where the highlighted parameters are:
111+
112+
- **nodeID**: The nodeID of the Matter device (Light or Light_switch) to read the ACL contents from.
113+
114+
- **0**: The endpoint in the Matter device that holds the ACL. This is always 0.
115+
116+
2. Second, bind the switch's write command to the light. This is done by updating the binding table of the Matter light_switch device. This can be done using the command: `./chip-tool binding write binding '[ { "fabricIndex" : 1 , "node" :`**`nodeID-light`**,`"endpoint" :`**`1`**,`"cluster" :`**`cluster-ID`**`} ]'`**`nodeID-switch 1`**, where the highlighted parameters are:
117+
118+
- **nodeID-light**: The node ID of the Matter light device.
119+
120+
- **1**: The application endpoint in the light. This is always 1.
121+
122+
- **cluster-ID**: The ID of the cluster to be controlled. Currently supported clusters are on/off(ID: 6) and level control(ID: 8).
123+
124+
- **nodeID-switch**: The node ID of the switch.
125+
126+
- **1**: This is the application endpoint in the switch that holds the binding table. This is always 1.
127+
128+
The binding table from a Matter device can be read using: `./chip-tool binding read binding`**`nodeID-switch 1`**, where the highlighted parameters are:
129+
130+
- **nodeID-switch**: The node ID of the Matter switch.
131+
132+
- **1**: The application endpoint in the switch that holds the binding table. This is always 1.
133+
134+
3. With the binding complete, a button press (BTN1) on Matter light switch device should now toggle the light or control the level of Matter light device. The button functionality is as follows:
135+
136+
- **On/Off Binding**
137+
- **BTN1 short press**: To toggle the light on the Matter light device.
138+
139+
- **Level Control Binding**
140+
- By default, step direction is UP.
141+
- **BTN0 short press + BTN1 short press**: Inverts the step direction (i.e., UP to DOWN and vice versa).
142+
- **BTN1 long press**: Moves the level UP or DOWN according to the step direction
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Example Applications and Demos
2+
3+
The Silicon Labs Matter Extension offers example applications to help in getting started with Matter. The first two of these are used in this guide's step-by-step example:
4+
5+
- Matter SoC Light over Wi-Fi
6+
7+
- Matter SoC Light Switch over Wi-Fi
8+
9+
- Matter SoC Window Cover over Wi-Fi
10+
11+
- Matter SoC Lock over Wi-Fi
12+
13+
- Matter SoC Thermostat over Wi-Fi
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Next Steps
2+
3+
Now that you have gotten a sense of what goes into making a Matter network, you can begin to customize MADs and other features for your own purposes. The [Developers' Guide](/matter/{build-docspace-version}/matter-developers-guide-overview) contains more detail than was provided in this Quick-Start guide, and also contains information on a number of special development topics. Your Matter Extension package contains a number of other Matter examples that you can use as a starting point, the first two of which were used in this example.
4+
5+
- Matter SoC Light over Wi-Fi
6+
7+
- Matter SoC Light Switch over Wi-Fi
8+
9+
- Matter SoC Window Cover over Wi-Fi
10+
11+
- Matter SoC Lock over Wi-Fi
12+
13+
- Matter SoC Thermostat over Wi-Fi
14+
15+
If you need support you can contact Silicon Labs through the [Silicon Labs Community](https://community.silabs.com/s/topic/0TO1M000000qHZgWAM/matter). Our engineers and community will be happy to help! You may also find answers here:
16+
17+
- [Silicon Labs Matter articles](https://community.silabs.com/s/topic/0TO1M000000qHZgWAM/matter?tabset-178da=2)
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Matter over Wi-Fi Quick-Start Guide
2+
3+
These pages describe how to create a simple Matter network in which you can use a switch to control a light.
4+
5+
You should have obtained hardware and installed software as described in the [Overview](/matter/{build-docspace-version}/matter-overview). Once you have done so,
6+
you can begin the [step-by-step instructions](./04-light-switch-step-by-step-example.md).

0 commit comments

Comments
 (0)