Grzegorz Ferenc | bae3e7d | 2021-10-19 15:49:45 +0200 | [diff] [blame] | 1 | # Matter Shell - Device Layer module |
Martin Turon | 899de40 | 2020-07-14 14:05:49 -0700 | [diff] [blame] | 2 | |
Grzegorz Ferenc | bae3e7d | 2021-10-19 15:49:45 +0200 | [diff] [blame] | 3 | The chip::DeviceLayer APIs may be invoked via the Matter Shell CLI. |
Martin Turon | 899de40 | 2020-07-14 14:05:49 -0700 | [diff] [blame] | 4 | |
| 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 | |
| 16 | List 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 |
| 24 | Done |
| 25 | ``` |
| 26 | |
| 27 | ### config |
| 28 | |
| 29 | Dump the configuration of the device. |
| 30 | |
| 31 | ```bash |
| 32 | > device config |
| 33 | VendorId: 235a |
| 34 | ProductId: feff |
Markus Becker | ec95ba7 | 2021-11-25 15:25:51 +0100 | [diff] [blame] | 35 | HardwareVersion: 0001 |
Martin Turon | 899de40 | 2020-07-14 14:05:49 -0700 | [diff] [blame] | 36 | SerialNumber: <None> |
| 37 | ServiceId: <None> |
| 38 | FabricId: <None> |
Song Guo | 6ce3894 | 2020-07-23 03:12:51 +0800 | [diff] [blame] | 39 | PinCode: <None> |
| 40 | Discriminator: <None> |
Martin Turon | 899de40 | 2020-07-14 14:05:49 -0700 | [diff] [blame] | 41 | DeviceId: <None> |
| 42 | DeviceCert: <None> |
| 43 | DeviceCaCerts: <None> |
| 44 | MfrDeviceId: <None> |
| 45 | MfrDeviceCert: <None> |
| 46 | MfgDeviceCaCerts:<None> |
| 47 | ``` |
| 48 | |
| 49 | ### get \<parameter\> |
| 50 | |
| 51 | - parameter: name of field to query |
| 52 | |
| 53 | Where valid parameter names include: |
| 54 | |
| 55 | - vendorid: Vendor Identifier |
| 56 | - productid: Product Identifier |
Markus Becker | ec95ba7 | 2021-11-25 15:25:51 +0100 | [diff] [blame] | 57 | - hardwarever: Hardware Version |
Martin Turon | 899de40 | 2020-07-14 14:05:49 -0700 | [diff] [blame] | 58 | - 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 Guo | 6ce3894 | 2020-07-23 03:12:51 +0800 | [diff] [blame] | 65 | - pincode: Setup Pin Code |
| 66 | - discriminator: Setup Discriminator |
Martin Turon | 899de40 | 2020-07-14 14:05:49 -0700 | [diff] [blame] | 67 | - serviceid: Service Identifier |
| 68 | - fabricid: Fabric Identifier |
| 69 | |
| 70 | ```bash |
| 71 | > device get vendorid |
| 72 | 235a |
| 73 | Done |
| 74 | ``` |
| 75 | |
| 76 | ### start |
| 77 | |
Grzegorz Ferenc | bae3e7d | 2021-10-19 15:49:45 +0200 | [diff] [blame] | 78 | Initialize the Matter stack and start the device layer event loop. |
Martin Turon | 899de40 | 2020-07-14 14:05:49 -0700 | [diff] [blame] | 79 | |
| 80 | ```bash |
| 81 | > device start |
| 82 | Init CHIP Stack |
| 83 | Starting Platform Manager Event Loop |
| 84 | Done |
| 85 | ``` |