blob: ea3585f036a34fb580d5b34ed641cb45ee647d1f [file] [log] [blame] [view]
Grzegorz Ferencbae3e7d2021-10-19 15:49:45 +02001# Matter Shell - Device Layer module
Martin Turon899de402020-07-14 14:05:49 -07002
Grzegorz Ferencbae3e7d2021-10-19 15:49:45 +02003The chip::DeviceLayer APIs may be invoked via the Matter Shell CLI.
Martin Turon899de402020-07-14 14:05:49 -07004
5## Command List
6
7- [help](#help)
8- [config](#config)
9- [get](#get-parameter)
10- [start](#start)
11
12## Command Details
13
14### help
15
16List the Device CLI commands.
17
18```bash
19> device help
20 help Usage: device <subcommand>
21 start Start the device layer. Usage: device start
22 get Get configuration value. Usage: device get <param_name>
23 config Dump entire configuration of device. Usage: device dump
24Done
25```
26
27### config
28
29Dump the configuration of the device.
30
31```bash
32> device config
33VendorId: 235a
34ProductId: feff
Markus Beckerec95ba72021-11-25 15:25:51 +010035HardwareVersion: 0001
Martin Turon899de402020-07-14 14:05:49 -070036SerialNumber: <None>
37ServiceId: <None>
38FabricId: <None>
Song Guo6ce38942020-07-23 03:12:51 +080039PinCode: <None>
40Discriminator: <None>
Martin Turon899de402020-07-14 14:05:49 -070041DeviceId: <None>
42DeviceCert: <None>
43DeviceCaCerts: <None>
44MfrDeviceId: <None>
45MfrDeviceCert: <None>
46MfgDeviceCaCerts:<None>
47```
48
49### get \<parameter\>
50
51- parameter: name of field to query
52
53Where valid parameter names include:
54
55- vendorid: Vendor Identifier
56- productid: Product Identifier
Markus Beckerec95ba72021-11-25 15:25:51 +010057- hardwarever: Hardware Version
Martin Turon899de402020-07-14 14:05:49 -070058- serial: Serial Number
59- deviceid: Device Identification Number
60- cert: Device Certificate
61- cacerts: Device CA Certificates
62- mfrdeviceid: Manufacturer Device Identification Number
63- mfrcert: Manufacturer Device Certificate
64- mfrcacerts: Manufacturer Device CA Certs
Song Guo6ce38942020-07-23 03:12:51 +080065- pincode: Setup Pin Code
66- discriminator: Setup Discriminator
Martin Turon899de402020-07-14 14:05:49 -070067- serviceid: Service Identifier
68- fabricid: Fabric Identifier
69
70```bash
71> device get vendorid
72235a
73Done
74```
75
76### start
77
Grzegorz Ferencbae3e7d2021-10-19 15:49:45 +020078Initialize the Matter stack and start the device layer event loop.
Martin Turon899de402020-07-14 14:05:49 -070079
80```bash
81> device start
82Init CHIP Stack
83Starting Platform Manager Event Loop
84Done
85```