Skip to content

Commit 3398e97

Browse files
committed
Updated Linux README.md to highlight --application and --featureSet args.
1 parent 8a00603 commit 3398e97

File tree

1 file changed

+16
-18
lines changed
  • examples/energy-management-app/linux

1 file changed

+16
-18
lines changed

examples/energy-management-app/linux/README.md

+16-18
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ details.
1616
- [Building](#building)
1717
- [Commandline arguments](#commandline-arguments)
1818
- [Running the Complete Example on Raspberry Pi 4](#running-the-complete-example-on-raspberry-pi-4)
19-
- [Running RPC Console](#running-rpc-console)
2019
- [Device Tracing](#device-tracing)
2120
- [Python Test Cases](#python-test-cases)
2221
- [Running the test cases:](#running-the-test-cases)
@@ -74,6 +73,19 @@ details.
7473
`hciconfig` command, for example, `--ble-device 1` means using `hci1`
7574
interface. Default: `0`.
7675

76+
- `--application <evse | water-heater>`
77+
78+
Emulate either an EVSE or Water Heater example.
79+
80+
- `--featureSet <feature map for Device Energy Management e.g. 0x7a>`
81+
82+
Sets the run-time FeatureMap value for the Device Energy Management cluster.
83+
This allows the DEM cluster to support `PFR` or `SFR` so that the full range
84+
of TC_DEM_2.x test cases can be exercised with this application.
85+
86+
See the test-runner headers in the respective test script in
87+
src/python_testing/TC_DEM_2.x.py which have recommended values to use.
88+
7789
## Running the Complete Example on Raspberry Pi 4
7890

7991
> If you want to test Echo protocol, please enable Echo handler
@@ -124,20 +136,6 @@ details.
124136
- Test the device using ChipDeviceController on your laptop /
125137
workstation etc.
126138

127-
## Running RPC Console
128-
129-
- As part of building the example with RPCs enabled the chip_rpc python
130-
interactive console is installed into your venv. The python wheel files are
131-
also created in the output folder: out/debug/chip_rpc_console_wheels. To
132-
install the wheel files without rebuilding:
133-
`pip3 install out/debug/chip_rpc_console_wheels/*.whl`
134-
135-
- To use the chip-rpc console after it has been installed run:
136-
`chip-console -s localhost:33000 -o /<YourFolder>/pw_log.out`
137-
138-
- Then you can Get and Set the Energy Management using the RPCs:
139-
`rpcs.chip.rpc.EnergyManagement.Get()`
140-
141139
## Device Tracing
142140

143141
Device tracing is available to analyze the device performance. To turn on
@@ -185,7 +183,7 @@ app you need to add `chip_enable_energy_evse_trigger=true` to the gn args.
185183
Once the application is built you also need to tell it at runtime what the
186184
chosen enable key is using the `--enable-key` command line option.
187185

188-
$ ./chip-energy-management-app --enable-key 000102030405060708090a0b0c0d0e0f
186+
$ ./chip-energy-management-app --enable-key 000102030405060708090a0b0c0d0e0f --application evse
189187

190188
### Running the test cases:
191189

@@ -194,7 +192,7 @@ From the top-level of the connectedhomeip repo type:
194192
Start the chip-energy-management-app:
195193

196194
```bash
197-
rm -f evse.bin; out/debug/chip-energy-management-app --enable-key 000102030405060708090a0b0c0d0e0f --KVS evse.bin --featureSet $featureSet
195+
rm -f evse.bin; out/debug/chip-energy-management-app --enable-key 000102030405060708090a0b0c0d0e0f --KVS evse.bin --featureSet $featureSet --application evse
198196
```
199197

200198
where the \$featureSet depends on the test being run:
@@ -262,7 +260,7 @@ data (e.g. fabric info).
262260
- Step 1: Launch the example app
263261

264262
```bash
265-
$ ./chip-energy-management-app --enable-key 000102030405060708090a0b0c0d0e0f
263+
$ ./chip-energy-management-app --enable-key 000102030405060708090a0b0c0d0e0f --application evse
266264
```
267265

268266
- Step 2: Launch CHIP-REPL

0 commit comments

Comments
 (0)