Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 79399e0

Browse files
restyled-commitsabiradarti
restyled-commits
authored and
abiradarti
committedMar 26, 2024·
Restyled by prettier-markdown
1 parent 400d860 commit 79399e0

File tree

5 files changed

+149
-119
lines changed

5 files changed

+149
-119
lines changed
 

‎examples/lighting-app/cc13x4_26x4/README.md

+46-38
Original file line numberDiff line numberDiff line change
@@ -56,20 +56,20 @@ guide assumes that the environment is linux based, and recommends Ubuntu 20.04.
5656
- Download and install [SysConfig][sysconfig]. This can be done simply with
5757
the following commands.
5858

59+
````
60+
$ cd ~
61+
$ wget https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-nsUM6f7Vvb/1.18.1.3343/sysconfig-1.18.1_3343-setup.run
62+
$ chmod +x sysconfig-1.18.1_3343-setup.run
63+
$ ./sysconfig-1.18.1_3343-setup.run
5964
```
60-
$ cd ~
61-
$ wget https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-nsUM6f7Vvb/1.18.1.3343/sysconfig-1.18.1_3343-setup.run
62-
$ chmod +x sysconfig-1.18.1_3343-setup.run
63-
$ ./sysconfig-1.18.1_3343-setup.run
64-
```
6565
6666
- Run the bootstrap script to setup the build environment.
6767
68-
```
69-
$ cd ~/connectedhomeip
70-
$ source ./scripts/bootstrap.sh
68+
```
69+
$ cd ~/connectedhomeip
70+
$ source ./scripts/bootstrap.sh
7171
72-
```
72+
```
7373
7474
### Compilation
7575
@@ -78,33 +78,33 @@ Ninja to build the executable.
7878
7979
- Activate the build environment with the repository activate script.
8080
81-
```
82-
$ cd ~/connectedhomeip
83-
$ source ./scripts/activate.sh
81+
```
82+
$ cd ~/connectedhomeip
83+
$ source ./scripts/activate.sh
8484
85-
```
85+
```
8686
8787
- Run the build to produce a default executable. By default on Linux both the
88-
TI SimpleLink SDK and Sysconfig are located in a `ti` folder in the user's
89-
home directory, and you must provide the absolute path to them. For example
90-
`/home/username/ti/sysconfig_1.18.1`. On Windows the default directory is
91-
`C:\ti`. Take note of this install path, as it will be used in the next
92-
step.
88+
TI SimpleLink SDK and Sysconfig are located in a `ti` folder in the user's
89+
home directory, and you must provide the absolute path to them. For example
90+
`/home/username/ti/sysconfig_1.18.1`. On Windows the default directory is
91+
`C:\ti`. Take note of this install path, as it will be used in the next
92+
step.
9393
94-
```
95-
$ cd ~/connectedhomeip/examples/lock-app/cc13x4_26x4
96-
$ gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\""
97-
$ ninja -C out/debug
94+
```
95+
$ cd ~/connectedhomeip/examples/lock-app/cc13x4_26x4
96+
$ gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\""
97+
$ ninja -C out/debug
9898
99-
```
99+
```
100100
101-
If you would like to define arguments on the command line you may add them
102-
to the GN call.
101+
If you would like to define arguments on the command line you may add them
102+
to the GN call.
103103
104104
105-
```
106-
gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\" target_defines=[\"CC13X4_26X4_ATTESTATION_CREDENTIALS=1\"]"
107-
```
105+
```
106+
gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\" target_defines=[\"CC13X4_26X4_ATTESTATION_CREDENTIALS=1\"]"
107+
```
108108
109109
## Programming
110110
@@ -210,9 +210,10 @@ Getting Started Guide][matter-e2e-faq].
210210
Commission the light device onto the Matter network. Run the following command
211211
on the CHIP tool:
212212
213-
```
213+
````
214214

215-
./chip-tool pairing ble-thread <nodeID - e.g. 1> hex:<complete dataset from starting the OTBR> 20202021 3840
215+
./chip-tool pairing ble-thread <nodeID - e.g. 1>
216+
hex:<complete dataset from starting the OTBR> 20202021 3840
216217

217218
```
218219
@@ -229,8 +230,9 @@ message on the CHIP tool output:
229230
230231
```
231232

232-
[1677648218.370754][39785:39790] CHIP:CTL: Received CommissioningComplete response, errorCode=0
233-
[1677648218.370821][39785:39790] CHIP:CTL: Successfully finished commissioning step 'SendComplete'
233+
[1677648218.370754][39785:39790] CHIP:CTL: Received CommissioningComplete
234+
response, errorCode=0 [1677648218.370821][39785:39790] CHIP:CTL: Successfully
235+
finished commissioning step 'SendComplete'
234236

235237
```
236238
@@ -249,25 +251,30 @@ Send commands to the lighting app. Here are some example commands:
249251
On
250252
251253
```
252-
./chip-tool onoff on <nodeID> 1
253-
./chip-tool onoff toggee <nodeID> 1 (assuming the light is off)
254+
255+
./chip-tool onoff on <nodeID> 1 ./chip-tool onoff toggee <nodeID> 1 (assuming
256+
the light is off)
254257

255258
```
256259
257260
Off
258261
259262
```
260-
./chip-tool onoff off <nodeID> 1
261-
./chip-tool onoff toggle <nodeID> 1 (assuming the light is on)
263+
264+
./chip-tool onoff off <nodeID> 1 ./chip-tool onoff toggle <nodeID> 1 (assuming
265+
the light is on)
262266

263267
```
264268
265269
Identify
266270
267271
```
268-
./chip-tool identify identify <IdentifyTime> <nodeID> 1 e.g. ./chip-tool identify identify 100 1 1
269272

270-
./chip-tool identify trigger-effect <EffectIdentifier> <EffectVariant> <nodeID> <endpointID> e.g. ./chip-tool identify trigger-effect 0x0000 0 1 1
273+
./chip-tool identify identify <IdentifyTime> <nodeID> 1 e.g. ./chip-tool
274+
identify identify 100 1 1
275+
276+
./chip-tool identify trigger-effect <EffectIdentifier> <EffectVariant> <nodeID>
277+
<endpointID> e.g. ./chip-tool identify trigger-effect 0x0000 0 1 1
271278

272279
```
273280
@@ -295,3 +302,4 @@ Additionally, we welcome any feedback.
295302
https://www.ti.com/wireless-connectivity/thread/design-development.html
296303
[ot_border_router_setup]: https://openthread.io/guides/border-router/build
297304
[uniflash]: https://www.ti.com/tool/download/UNIFLASH
305+
```

‎examples/lock-app/cc13x2x7_26x2x7/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ guide assumes that the environment is linux based, and recommends Ubuntu 20.04.
5757
- Download and install [SysConfig][sysconfig]. This can be done simply with
5858
the following commands.
5959

60-
```
60+
```
6161
$ cd ~
6262
$ wget https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-nsUM6f7Vvb/1.18.1.3343/sysconfig-1.18.1_3343-setup.run
6363
$ chmod +x sysconfig-1.18.1_3343-setup.run

‎examples/lock-app/cc13x4_26x4/README.md

+63-42
Original file line numberDiff line numberDiff line change
@@ -57,20 +57,20 @@ guide assumes that the environment is linux based, and recommends Ubuntu 20.04.
5757
- Download and install [SysConfig][sysconfig]. This can be done simply with
5858
the following commands.
5959

60-
```
61-
$ cd ~
62-
$ wget https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-nsUM6f7Vvb/1.18.1.3343/sysconfig-1.18.1_3343-setup.run
63-
$ chmod +x sysconfig-1.18.1_3343-setup.run
64-
$ ./sysconfig-1.18.1_3343-setup.run
65-
```
60+
````
61+
$ cd ~
62+
$ wget https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-nsUM6f7Vvb/1.18.1.3343/sysconfig-1.18.1_3343-setup.run
63+
$ chmod +x sysconfig-1.18.1_3343-setup.run
64+
$ ./sysconfig-1.18.1_3343-setup.run
65+
```
6666
6767
- Run the bootstrap script to setup the build environment.
6868
69-
```
70-
$ cd ~/connectedhomeip
71-
$ source ./scripts/bootstrap.sh
69+
```
70+
$ cd ~/connectedhomeip
71+
$ source ./scripts/bootstrap.sh
7272
73-
```
73+
```
7474
7575
### Compilation
7676
@@ -79,35 +79,35 @@ Ninja to build the executable.
7979
8080
- Activate the build environment with the repository activate script.
8181
82-
```
83-
$ cd ~/connectedhomeip
84-
$ source ./scripts/activate.sh
82+
```
83+
$ cd ~/connectedhomeip
84+
$ source ./scripts/activate.sh
8585
86-
```
86+
```
8787
8888
- Run the build to produce a default executable. By default on Linux both the
89-
TI SimpleLink SDK and Sysconfig are located in a `ti` folder in the user's
90-
home directory, and you must provide the absolute path to them. For example
91-
`/home/username/ti/sysconfig_1.18.1`. On Windows the default directory is
92-
`C:\ti`. Take note of this install path, as it will be used in the next
93-
step.
89+
TI SimpleLink SDK and Sysconfig are located in a `ti` folder in the user's
90+
home directory, and you must provide the absolute path to them. For example
91+
`/home/username/ti/sysconfig_1.18.1`. On Windows the default directory is
92+
`C:\ti`. Take note of this install path, as it will be used in the next
93+
step.
9494
95-
```
96-
$ cd ~/connectedhomeip/examples/lock-app/cc13x2x7_26x2x7
97-
OR
98-
$ cd ~/connectedhomeip/examples/lock-app/cc13x4_26x4
99-
$ gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\""
100-
$ ninja -C out/debug
95+
```
96+
$ cd ~/connectedhomeip/examples/lock-app/cc13x2x7_26x2x7
97+
OR
98+
$ cd ~/connectedhomeip/examples/lock-app/cc13x4_26x4
99+
$ gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\""
100+
$ ninja -C out/debug
101101
102-
```
102+
```
103103
104-
If you would like to define arguments on the command line you may add them
105-
to the GN call.
104+
If you would like to define arguments on the command line you may add them
105+
to the GN call.
106106
107107
108-
```
109-
gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\" target_defines=[\"CC13X4_26X4_ATTESTATION_CREDENTIALS=1\"]"
110-
```
108+
```
109+
gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\" target_defines=[\"CC13X4_26X4_ATTESTATION_CREDENTIALS=1\"]"
110+
```
111111
112112
## Programming
113113
@@ -213,9 +213,10 @@ Getting Started Guide][matter-e2e-faq].
213213
Commission the device onto the Matter network. Run the following command on the
214214
CHIP tool:
215215
216-
```
216+
````
217217

218-
./chip-tool pairing ble-thread <nodeID - e.g. 1> hex:<complete dataset from starting the OTBR> 20202021 3840
218+
./chip-tool pairing ble-thread <nodeID - e.g. 1>
219+
hex:<complete dataset from starting the OTBR> 20202021 3840
219220

220221
```
221222
@@ -232,8 +233,9 @@ message on the CHIP tool output:
232233
233234
```
234235

235-
[1677648218.370754][39785:39790] CHIP:CTL: Received CommissioningComplete response, errorCode=0
236-
[1677648218.370821][39785:39790] CHIP:CTL: Successfully finished commissioning step 'SendComplete'
236+
[1677648218.370754][39785:39790] CHIP:CTL: Received CommissioningComplete
237+
response, errorCode=0 [1677648218.370821][39785:39790] CHIP:CTL: Successfully
238+
finished commissioning step 'SendComplete'
237239

238240
```
239241
@@ -248,36 +250,54 @@ Commissioning complete, notify platform driver to persist network credentials.
248250
**Step 2** The example Doorlock cluster operations have the following format:
249251
250252
```
251-
./chip-tool doorlock <attribute-name> <attribute-values> <destination-id> <endpoint-id-ignored-for-group-commands>
252-
./chip-tool doorlock set-user <OperationType> <UserIndex> <UserName> <UserUniqueId> <UserStatus> <UserType> <CredentialRule> <destination-id> <endpoint-id-ignored-for-group-commands>
253-
./chip-tool <doorlock set-credential> <OperationType> <Credential> <CredentialData> <UserIndex> <UserStatus> <UserType> <destination-id> <endpoint-id-ignored-for-group-commands>
253+
254+
./chip-tool doorlock <attribute-name> <attribute-values> <destination-id>
255+
<endpoint-id-ignored-for-group-commands> ./chip-tool doorlock set-user
256+
<OperationType> <UserIndex> <UserName> <UserUniqueId> <UserStatus> <UserType>
257+
<CredentialRule> <destination-id> <endpoint-id-ignored-for-group-commands>
258+
./chip-tool <doorlock set-credential> <OperationType> <Credential>
259+
<CredentialData> <UserIndex> <UserStatus> <UserType> <destination-id>
260+
<endpoint-id-ignored-for-group-commands>
261+
254262
```
255263
256264
Send commands to the lock-app. Here are some example commands:
257265
258266
Set a new user "`TST`" with user index of 1 with a default pin of 123456
259267
260268
```
261-
./chip-tool doorlock set-user 0 1 `TST` 6452 1 0 0 1 1 --timedInteractionTimeoutMs 1000
262-
./chip-tool doorlock set-credential 0 '{ "credentialType" : 1 , "credentialIndex" : 1 }' 123456 1 null null 1 1 --timedInteractionTimeoutMs 1000
269+
270+
./chip-tool doorlock set-user 0 1 `TST` 6452 1 0 0 1 1
271+
--timedInteractionTimeoutMs 1000 ./chip-tool doorlock set-credential 0 '{
272+
"credentialType" : 1 , "credentialIndex" : 1 }' 123456 1 null null 1 1
273+
--timedInteractionTimeoutMs 1000
274+
263275
```
264276
265277
Require a pin mode for lock operations:
266278
267279
```
280+
268281
./chip-tool doorlock write require-pinfor-remote-operation 1 1 1
282+
269283
```
270284
271285
Lock the Door
272286
273287
```
274-
./chip-tool doorlock lock-door 1 1 --timedInteractionTimeoutMs 1000 --PinCode 123456
288+
289+
./chip-tool doorlock lock-door 1 1 --timedInteractionTimeoutMs 1000 --PinCode
290+
123456
291+
275292
```
276293
277294
Unlock the door
278295
279296
```
280-
./chip-tool doorlock unlock-door 1 1 --timedInteractionTimeoutMs 1000 --PinCode 123456
297+
298+
./chip-tool doorlock unlock-door 1 1 --timedInteractionTimeoutMs 1000 --PinCode
299+
123456
300+
281301
```
282302
283303
### Provisioning
@@ -324,3 +344,4 @@ Additionally, we welcome any feedback.
324344
https://www.ti.com/wireless-connectivity/thread/design-development.html
325345
[ot_border_router_setup]: https://openthread.io/guides/border-router/build
326346
[uniflash]: https://www.ti.com/tool/download/UNIFLASH
347+
```

‎examples/pump-app/cc13x2x7_26x2x7/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ guide assumes that the environment is linux based, and recommends Ubuntu 20.04.
5656
- Download and install [SysConfig][sysconfig]. This can be done simply with
5757
the following commands.
5858

59-
```
59+
```
6060
$ cd ~
6161
$ wget https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-nsUM6f7Vvb/1.18.1.3343/sysconfig-1.18.1_3343-setup.run
6262
$ chmod +x sysconfig-1.18.1_3343-setup.run

‎examples/shell/cc13x2x7_26x2x7/README.md

+38-37
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ guide assumes that the environment is linux based, and recommends Ubuntu 20.04.
1414
- Download and install [SysConfig][sysconfig]. This can be done simply with
1515
the following commands.
1616

17+
````
18+
$ cd ~
19+
$ wget https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-nsUM6f7Vvb/1.18.1.3343/sysconfig-1.18.1_3343-setup.run
20+
$ chmod +x sysconfig-1.18.1_3343-setup.run
21+
$ ./sysconfig-1.18.1_3343-setup.run
1722
```
18-
$ cd ~
19-
$ wget https://dr-download.ti.com/software-development/ide-configuration-compiler-or-debugger/MD-nsUM6f7Vvb/1.18.1.3343/sysconfig-1.18.1_3343-setup.run
20-
$ chmod +x sysconfig-1.18.1_3343-setup.run
21-
$ ./sysconfig-1.18.1_3343-setup.run
22-
```
2323
2424
- Run the bootstrap script to setup the build environment.
2525
26-
```
27-
$ cd ~/connectedhomeip
28-
$ source ./scripts/bootstrap.sh
26+
```
27+
$ cd ~/connectedhomeip
28+
$ source ./scripts/bootstrap.sh
2929
30-
```
30+
```
3131
3232
### Compilation
3333
@@ -36,35 +36,35 @@ Ninja to build the executable.
3636
3737
- Activate the build environment with the repository activate script.
3838
39-
```
40-
$ cd ~/connectedhomeip
41-
$ source ./scripts/activate.sh
39+
```
40+
$ cd ~/connectedhomeip
41+
$ source ./scripts/activate.sh
4242
43-
```
43+
```
4444
4545
- Run the build to produce a default executable. By default on Linux both the
46-
TI SimpleLink SDK and Sysconfig are located in a `ti` folder in the user's
47-
home directory, and you must provide the absolute path to them. For example
48-
`/home/username/ti/sysconfig_1.18.1`. On Windows the default directory is
49-
`C:\ti`. Take note of this install path, as it will be used in the next
50-
step.
46+
TI SimpleLink SDK and Sysconfig are located in a `ti` folder in the user's
47+
home directory, and you must provide the absolute path to them. For example
48+
`/home/username/ti/sysconfig_1.18.1`. On Windows the default directory is
49+
`C:\ti`. Take note of this install path, as it will be used in the next
50+
step.
5151
52-
```
53-
$ cd ~/connectedhomeip/examples/shell/cc13x2x7_26x2x7
54-
OR
55-
$ cd ~/connectedhomeip/examples/shell/cc13x4_26x4
52+
```
53+
$ cd ~/connectedhomeip/examples/shell/cc13x2x7_26x2x7
54+
OR
55+
$ cd ~/connectedhomeip/examples/shell/cc13x4_26x4
5656
57-
$ gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\""
58-
$ ninja -C out/debug
57+
$ gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\""
58+
$ ninja -C out/debug
5959
60-
```
60+
```
6161
62-
If you would like to define arguments on the command line you may add them
63-
to the GN call.
62+
If you would like to define arguments on the command line you may add them
63+
to the GN call.
6464
65-
```
66-
gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\" target_defines=[\"CC13X4_26X4_ATTESTATION_CREDENTIALS=1\"]"
67-
```
65+
```
66+
gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.18.1\" target_defines=[\"CC13X4_26X4_ATTESTATION_CREDENTIALS=1\"]"
67+
```
6868
6969
## Programming
7070
@@ -164,19 +164,20 @@ Additionally, we welcome any feedback.
164164
[matter]: https://csa-iot.org/all-solutions/matter/
165165
[ccs]: https://www.ti.com/tool/CCSTUDIO
166166
[ccs_after_launch]:
167-
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#after-launch
167+
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#after-launch
168168
[ccs_debug_view]:
169-
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#debug-view
169+
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#debug-view
170170
[ccs_manual_launch]:
171-
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#manual-launch
171+
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#manual-launch
172172
[ccs_manual_method]:
173-
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#manual-method
173+
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#manual-method
174174
[e2e]:
175-
https://e2e.ti.com/support/wireless-connectivity/zigbee-thread-group/zigbee-and-thread/f/zigbee-thread-forum
175+
https://e2e.ti.com/support/wireless-connectivity/zigbee-thread-group/zigbee-and-thread/f/zigbee-thread-forum
176176
[matter-e2e-faq]:
177-
https://e2e.ti.com/support/wireless-connectivity/zigbee-thread-group/zigbee-and-thread/f/zigbee-thread-forum/1082428/faq-cc2652r7-matter----getting-started-guide
177+
https://e2e.ti.com/support/wireless-connectivity/zigbee-thread-group/zigbee-and-thread/f/zigbee-thread-forum/1082428/faq-cc2652r7-matter----getting-started-guide
178178
[sysconfig]: https://www.ti.com/tool/SYSCONFIG
179179
[ti_thread_dnd]:
180-
https://www.ti.com/wireless-connectivity/thread/design-development.html
180+
https://www.ti.com/wireless-connectivity/thread/design-development.html
181181
[ot_border_router_setup]: https://openthread.io/guides/border-router/build
182182
[uniflash]: https://www.ti.com/tool/download/UNIFLASH
183+
````

0 commit comments

Comments
 (0)
Please sign in to comment.