xref: /aosp_15_r20/external/openthread/src/cli/README_TCAT.md (revision cfb92d1480a9e65faed56933e9c12405f45898b4)
1*cfb92d14SAndroid Build Coastguard Worker# OpenThread CLI - TCAT Example
2*cfb92d14SAndroid Build Coastguard Worker
3*cfb92d14SAndroid Build Coastguard Worker## Command List
4*cfb92d14SAndroid Build Coastguard Worker
5*cfb92d14SAndroid Build Coastguard Worker- advid [#advid]
6*cfb92d14SAndroid Build Coastguard Worker- devid [#devid]
7*cfb92d14SAndroid Build Coastguard Worker- help [#help]
8*cfb92d14SAndroid Build Coastguard Worker- start [#start]
9*cfb92d14SAndroid Build Coastguard Worker- stop [#stop]
10*cfb92d14SAndroid Build Coastguard Worker
11*cfb92d14SAndroid Build Coastguard Worker### advid
12*cfb92d14SAndroid Build Coastguard Worker
13*cfb92d14SAndroid Build Coastguard WorkerDisplays currently set TCAT advertised ids.
14*cfb92d14SAndroid Build Coastguard Worker
15*cfb92d14SAndroid Build Coastguard Worker```bash
16*cfb92d14SAndroid Build Coastguard Workertcat advid
17*cfb92d14SAndroid Build Coastguard Workertype oui24, value: f378aa
18*cfb92d14SAndroid Build Coastguard WorkerDone
19*cfb92d14SAndroid Build Coastguard Worker```
20*cfb92d14SAndroid Build Coastguard Worker
21*cfb92d14SAndroid Build Coastguard Worker### advid ianapen \<id\>
22*cfb92d14SAndroid Build Coastguard Worker
23*cfb92d14SAndroid Build Coastguard WorkerSets TCAT advertised ianapen id.
24*cfb92d14SAndroid Build Coastguard Worker
25*cfb92d14SAndroid Build Coastguard Worker```bash
26*cfb92d14SAndroid Build Coastguard Workertcat advid ianapen f378aabb
27*cfb92d14SAndroid Build Coastguard WorkerDone
28*cfb92d14SAndroid Build Coastguard Worker```
29*cfb92d14SAndroid Build Coastguard Worker
30*cfb92d14SAndroid Build Coastguard Worker### advid oui24 \<id\>
31*cfb92d14SAndroid Build Coastguard Worker
32*cfb92d14SAndroid Build Coastguard WorkerSets TCAT advertised oui24 id.
33*cfb92d14SAndroid Build Coastguard Worker
34*cfb92d14SAndroid Build Coastguard Worker```bash
35*cfb92d14SAndroid Build Coastguard Workertcat advid oui24 f378aa
36*cfb92d14SAndroid Build Coastguard WorkerDone
37*cfb92d14SAndroid Build Coastguard Worker```
38*cfb92d14SAndroid Build Coastguard Worker
39*cfb92d14SAndroid Build Coastguard Worker### advid oui36 \<id\>
40*cfb92d14SAndroid Build Coastguard Worker
41*cfb92d14SAndroid Build Coastguard WorkerSets TCAT advertised oui36 id.
42*cfb92d14SAndroid Build Coastguard Worker
43*cfb92d14SAndroid Build Coastguard Worker```bash
44*cfb92d14SAndroid Build Coastguard Workertcat advid oui36 f378aabbcc
45*cfb92d14SAndroid Build Coastguard WorkerDone
46*cfb92d14SAndroid Build Coastguard Worker```
47*cfb92d14SAndroid Build Coastguard Worker
48*cfb92d14SAndroid Build Coastguard Worker### advid discriminator \<id\>
49*cfb92d14SAndroid Build Coastguard Worker
50*cfb92d14SAndroid Build Coastguard WorkerSets TCAT advertised discriminator id.
51*cfb92d14SAndroid Build Coastguard Worker
52*cfb92d14SAndroid Build Coastguard Worker```bash
53*cfb92d14SAndroid Build Coastguard Workertcat advid discriminator f378aabbdd
54*cfb92d14SAndroid Build Coastguard WorkerDone
55*cfb92d14SAndroid Build Coastguard Worker```
56*cfb92d14SAndroid Build Coastguard Worker
57*cfb92d14SAndroid Build Coastguard Worker### advid clear
58*cfb92d14SAndroid Build Coastguard Worker
59*cfb92d14SAndroid Build Coastguard WorkerClears TCAT advertised id.
60*cfb92d14SAndroid Build Coastguard Worker
61*cfb92d14SAndroid Build Coastguard Worker```bash
62*cfb92d14SAndroid Build Coastguard Workertcat advid clear
63*cfb92d14SAndroid Build Coastguard WorkerDone
64*cfb92d14SAndroid Build Coastguard Worker```
65*cfb92d14SAndroid Build Coastguard Worker
66*cfb92d14SAndroid Build Coastguard Worker### devid
67*cfb92d14SAndroid Build Coastguard Worker
68*cfb92d14SAndroid Build Coastguard WorkerDisplays currently set TCAT device id.
69*cfb92d14SAndroid Build Coastguard Worker
70*cfb92d14SAndroid Build Coastguard Worker```bash
71*cfb92d14SAndroid Build Coastguard Workertcat devid
72*cfb92d14SAndroid Build Coastguard Workerabcd
73*cfb92d14SAndroid Build Coastguard WorkerDone
74*cfb92d14SAndroid Build Coastguard Worker```
75*cfb92d14SAndroid Build Coastguard Worker
76*cfb92d14SAndroid Build Coastguard Worker### devid \<id\>
77*cfb92d14SAndroid Build Coastguard Worker
78*cfb92d14SAndroid Build Coastguard WorkerSets TCAT device id.
79*cfb92d14SAndroid Build Coastguard Worker
80*cfb92d14SAndroid Build Coastguard Worker```bash
81*cfb92d14SAndroid Build Coastguard Workertcat devid abcd
82*cfb92d14SAndroid Build Coastguard WorkerDone
83*cfb92d14SAndroid Build Coastguard Worker```
84*cfb92d14SAndroid Build Coastguard Worker
85*cfb92d14SAndroid Build Coastguard Worker### devid clear
86*cfb92d14SAndroid Build Coastguard Worker
87*cfb92d14SAndroid Build Coastguard WorkerClears TCAT device id.
88*cfb92d14SAndroid Build Coastguard Worker
89*cfb92d14SAndroid Build Coastguard Worker```bash
90*cfb92d14SAndroid Build Coastguard Workertcat devid clear
91*cfb92d14SAndroid Build Coastguard WorkerDone
92*cfb92d14SAndroid Build Coastguard Worker```
93*cfb92d14SAndroid Build Coastguard Worker
94*cfb92d14SAndroid Build Coastguard Worker### help
95*cfb92d14SAndroid Build Coastguard Worker
96*cfb92d14SAndroid Build Coastguard Workerprint help
97*cfb92d14SAndroid Build Coastguard Worker
98*cfb92d14SAndroid Build Coastguard Worker```bash
99*cfb92d14SAndroid Build Coastguard Workertcat help
100*cfb92d14SAndroid Build Coastguard Workeradvid
101*cfb92d14SAndroid Build Coastguard Workerdevid
102*cfb92d14SAndroid Build Coastguard Workerhelp
103*cfb92d14SAndroid Build Coastguard Workerstart
104*cfb92d14SAndroid Build Coastguard Workerstop
105*cfb92d14SAndroid Build Coastguard WorkerDone
106*cfb92d14SAndroid Build Coastguard Worker```
107*cfb92d14SAndroid Build Coastguard Worker
108*cfb92d14SAndroid Build Coastguard Worker### start
109*cfb92d14SAndroid Build Coastguard Worker
110*cfb92d14SAndroid Build Coastguard WorkerStart tcat server and ble advertisement.
111*cfb92d14SAndroid Build Coastguard Worker
112*cfb92d14SAndroid Build Coastguard Worker```bash
113*cfb92d14SAndroid Build Coastguard Workertcat start
114*cfb92d14SAndroid Build Coastguard WorkerDone
115*cfb92d14SAndroid Build Coastguard Worker```
116*cfb92d14SAndroid Build Coastguard Worker
117*cfb92d14SAndroid Build Coastguard Worker### stop
118*cfb92d14SAndroid Build Coastguard Worker
119*cfb92d14SAndroid Build Coastguard WorkerStop tcat server and ble advertisement.
120*cfb92d14SAndroid Build Coastguard Worker
121*cfb92d14SAndroid Build Coastguard Worker```bash
122*cfb92d14SAndroid Build Coastguard Workertcat stop
123*cfb92d14SAndroid Build Coastguard WorkerDone
124*cfb92d14SAndroid Build Coastguard Worker```
125