Skip to content

Commit 9318d13

Browse files
turonturon
authored
[doc] Extend documentation of chip-tool to detail commands. (#4466)
1 parent cc21d5c commit 9318d13

File tree

1 file changed

+317
-0
lines changed

1 file changed

+317
-0
lines changed

‎examples/chip-tool/README.md

+317
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,31 @@ arguments.
7575

7676
$ chip-tool
7777

78+
Example output:
79+
80+
```bash
81+
Usage:
82+
./chip-tool cluster_name command_name [param1 param2 ...]
83+
84+
+-------------------------------------------------------------------------------------+
85+
| Clusters: |
86+
+-------------------------------------------------------------------------------------+
87+
| * barriercontrol |
88+
| * basic |
89+
| * colorcontrol |
90+
| * doorlock |
91+
| * groups |
92+
| * iaszone |
93+
| * identify |
94+
| * levelcontrol |
95+
| * onoff |
96+
| * pairing |
97+
| * payload |
98+
| * scenes |
99+
| * temperaturemeasurement |
100+
+-------------------------------------------------------------------------------------+
101+
```
102+
78103
### How to get the list of supported commands for a specific cluster
79104

80105
To get the list of commands for a specific cluster, run the built executable
@@ -123,3 +148,295 @@ To parse an additional data payload, run the built executable with the `payload`
123148
cluster name and the `parse-additional-data-payload` command
124149

125150
$ chip-tool payload parse-additional-data-payload "#####"
151+
152+
# Command Reference
153+
154+
## Command List
155+
156+
- [barriercontrol](#barriercontrol)
157+
- [basic](#basic)
158+
- [colorcontrol](#colorcontrol)
159+
- [doorlock](#doorlock)
160+
- [groups](#groups)
161+
- [iaszone](#iaszone)
162+
- [identify](#identify)
163+
- [levelcontrol](#levelcontrol)
164+
- [onoff](#onoff)
165+
- [pairing](#pairing)
166+
- [payload](#payload)
167+
- [scenes](#scenes)
168+
- [temperaturemeasurement](#temperaturemeasurement)
169+
170+
## Command Details
171+
172+
### barriercontrol
173+
174+
```bash
175+
Usage:
176+
./chip-tool barriercontrol command_name [param1 param2 ...]
177+
178+
+-------------------------------------------------------------------------------------+
179+
| Commands: |
180+
+-------------------------------------------------------------------------------------+
181+
| * barrier-control-go-to-percent |
182+
| * barrier-control-stop |
183+
| * discover |
184+
| * read |
185+
+-------------------------------------------------------------------------------------+
186+
```
187+
188+
### basic
189+
190+
```bash
191+
Usage:
192+
./chip-tool basic command_name [param1 param2 ...]
193+
194+
+-------------------------------------------------------------------------------------+
195+
| Commands: |
196+
+-------------------------------------------------------------------------------------+
197+
| * reset-to-factory-defaults |
198+
| * ping |
199+
| * discover |
200+
| * read |
201+
+-------------------------------------------------------------------------------------+
202+
```
203+
204+
### colorcontrol
205+
206+
```bash
207+
Usage:
208+
./chip-tool colorcontrol command_name [param1 param2 ...]
209+
210+
+-------------------------------------------------------------------------------------+
211+
| Commands: |
212+
+-------------------------------------------------------------------------------------+
213+
| * move-color |
214+
| * move-color-temperature |
215+
| * move-hue |
216+
| * move-saturation |
217+
| * move-to-color |
218+
| * move-to-color-temperature |
219+
| * move-to-hue |
220+
| * move-to-hue-and-saturation |
221+
| * move-to-saturation |
222+
| * step-color |
223+
| * step-color-temperature |
224+
| * step-hue |
225+
| * step-saturation |
226+
| * stop-move-step |
227+
| * discover |
228+
| * read |
229+
| * report |
230+
+-------------------------------------------------------------------------------------+
231+
```
232+
233+
### doorlock
234+
235+
```bash
236+
Usage:
237+
./chip-tool doorlock command_name [param1 param2 ...]
238+
239+
+-------------------------------------------------------------------------------------+
240+
| Commands: |
241+
+-------------------------------------------------------------------------------------+
242+
| * clear-all-pins |
243+
| * clear-all-rfids |
244+
| * clear-holiday-schedule |
245+
| * clear-pin |
246+
| * clear-rfid |
247+
| * clear-weekday-schedule |
248+
| * clear-yearday-schedule |
249+
| * get-holiday-schedule |
250+
| * get-pin |
251+
| * get-rfid |
252+
| * get-user-type |
253+
| * get-weekday-schedule |
254+
| * get-yearday-schedule |
255+
| * lock-door |
256+
| * set-holiday-schedule |
257+
| * set-pin |
258+
| * set-rfid |
259+
| * set-user-type |
260+
| * set-weekday-schedule |
261+
| * set-yearday-schedule |
262+
| * unlock-door |
263+
| * unlock-with-timeout |
264+
| * discover |
265+
| * read |
266+
| * report |
267+
+-------------------------------------------------------------------------------------+
268+
```
269+
270+
### groups
271+
272+
```bash
273+
Usage:
274+
./chip-tool groups command_name [param1 param2 ...]
275+
276+
+-------------------------------------------------------------------------------------+
277+
| Commands: |
278+
+-------------------------------------------------------------------------------------+
279+
| * add-group |
280+
| * add-group-if-identifying |
281+
| * get-group-membership |
282+
| * remove-all-groups |
283+
| * remove-group |
284+
| * view-group |
285+
| * discover |
286+
| * read |
287+
+-------------------------------------------------------------------------------------+
288+
```
289+
290+
### iaszone
291+
292+
```bash
293+
Usage:
294+
./chip-tool iaszone command_name [param1 param2 ...]
295+
296+
+-------------------------------------------------------------------------------------+
297+
| Commands: |
298+
+-------------------------------------------------------------------------------------+
299+
| * discover |
300+
| * read |
301+
| * write |
302+
+-------------------------------------------------------------------------------------+
303+
```
304+
305+
### identify
306+
307+
```bash
308+
Usage:
309+
./chip-tool identify command_name [param1 param2 ...]
310+
311+
+-------------------------------------------------------------------------------------+
312+
| Commands: |
313+
+-------------------------------------------------------------------------------------+
314+
| * identify |
315+
| * identify-query |
316+
| * discover |
317+
| * read |
318+
+-------------------------------------------------------------------------------------+
319+
```
320+
321+
### levelcontrol
322+
323+
```bash
324+
Usage:
325+
./chip-tool levelcontrol command_name [param1 param2 ...]
326+
327+
+-------------------------------------------------------------------------------------+
328+
| Commands: |
329+
+-------------------------------------------------------------------------------------+
330+
| * move |
331+
| * move-to-level |
332+
| * move-to-level-with-on-off |
333+
| * move-with-on-off |
334+
| * step |
335+
| * step-with-on-off |
336+
| * stop |
337+
| * stop-with-on-off |
338+
| * discover |
339+
| * read |
340+
| * report |
341+
+-------------------------------------------------------------------------------------+
342+
```
343+
344+
### onoff
345+
346+
```bash
347+
Usage:
348+
./chip-tool onoff command_name [param1 param2 ...]
349+
350+
+-------------------------------------------------------------------------------------+
351+
| Commands: |
352+
+-------------------------------------------------------------------------------------+
353+
| * off |
354+
| * on |
355+
| * toggle |
356+
| * discover |
357+
| * read |
358+
| * report |
359+
+-------------------------------------------------------------------------------------+
360+
```
361+
362+
### onoff off [endpoint-id]
363+
364+
Send the OFF command to the ONOFF cluster on the given endpoint.
365+
366+
### onoff on [endpoint-id]
367+
368+
Send the ON command to the ONOFF cluster on the given endpoint.
369+
370+
### onoff toggle [endpoint-id]
371+
372+
Send the TOGGLE command to the ONOFF cluster on the given endpoint.
373+
374+
### onoff discover [endpoint-id]
375+
376+
Send the DISCOVER command to the ONOFF cluster on the given endpoint.
377+
378+
### pairing
379+
380+
```bash
381+
Usage:
382+
./chip-tool pairing command_name [param1 param2 ...]
383+
384+
+-------------------------------------------------------------------------------------+
385+
| Commands: |
386+
+-------------------------------------------------------------------------------------+
387+
| * unpair |
388+
| * bypass |
389+
| * ble |
390+
| * softap |
391+
+-------------------------------------------------------------------------------------+
392+
```
393+
394+
### payload
395+
396+
```bash
397+
Usage:
398+
./chip-tool payload command_name [param1 param2 ...]
399+
400+
+-------------------------------------------------------------------------------------+
401+
| Commands: |
402+
+-------------------------------------------------------------------------------------+
403+
| * parse-setup-payload |
404+
| * parse-additional-data-payload |
405+
+-------------------------------------------------------------------------------------+
406+
```
407+
408+
### scenes
409+
410+
```bash
411+
Usage:
412+
./chip-tool scenes command_name [param1 param2 ...]
413+
414+
+-------------------------------------------------------------------------------------+
415+
| Commands: |
416+
+-------------------------------------------------------------------------------------+
417+
| * add-scene |
418+
| * get-scene-membership |
419+
| * recall-scene |
420+
| * remove-all-scenes |
421+
| * remove-scene |
422+
| * store-scene |
423+
| * view-scene |
424+
| * discover |
425+
| * read |
426+
+-------------------------------------------------------------------------------------+
427+
```
428+
429+
### temperaturemeasurement
430+
431+
```bash
432+
Usage:
433+
./chip-tool temperaturemeasurement command_name [param1 param2 ...]
434+
435+
+-------------------------------------------------------------------------------------+
436+
| Commands: |
437+
+-------------------------------------------------------------------------------------+
438+
| * discover |
439+
| * read |
440+
| * report |
441+
+-------------------------------------------------------------------------------------+
442+
```

0 commit comments

Comments
 (0)