Skip to content

Commit 9f755f9

Browse files
srickardtisrickardti
authored
[TI] enable shell example (project-chip#18176)
* enable shell example add shell to CI build * revert BLE command change This will cause the BLE advertisment command in the Shell example to not function properly.
1 parent 6e22467 commit 9f755f9

File tree

25 files changed

+1149
-0
lines changed

25 files changed

+1149
-0
lines changed

‎.github/workflows/examples-cc13x2x7_26x2x7.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,13 @@ jobs:
106106
cc13x2_26x2 LP_CC2652R7 all-clusters-app \
107107
out/artifacts/cc13x2x7_26x2x7-all-clusters/chip-LP_CC2652R7-all-clusters-example.out \
108108
/tmp/bloat_reports/
109+
- name: Get Shell App size stats
110+
timeout-minutes: 5
111+
run: |
112+
.environment/pigweed-venv/bin/python3 scripts/tools/memory/gh_sizes.py \
113+
cc13x2_26x2 LP_CC2652R7 shell \
114+
out/artifacts/cc13x2x7_26x2x7-shell/chip-LP_CC2652R7-shell-example.out \
115+
/tmp/bloat_reports/
109116
- name: Uploading Size Reports
110117
uses: actions/upload-artifact@v2
111118
if: ${{ !env.ACT }}

‎examples/all-clusters-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h

+2
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@
8787
*/
8888
#define CHIP_DEVICE_CONFIG_EVENT_LOGGING_DEBUG_BUFFER_SIZE (512)
8989

90+
#define MATTER_CC13X2_26X2_PLATFORM_LOG_ENABLED 1
91+
9092
/**
9193
* CHIP_DEVICE_CONFIG_ENABLE_THREAD_SRP_CLIENT
9294
*

‎examples/lock-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h

+2
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@
8989
*/
9090
#define CHIP_DEVICE_CONFIG_EVENT_LOGGING_DEBUG_BUFFER_SIZE (512)
9191

92+
#define MATTER_CC13X2_26X2_PLATFORM_LOG_ENABLED 1
93+
9294
/**
9395
* CHIP_DEVICE_CONFIG_ENABLE_THREAD_SRP_CLIENT
9496
*

‎examples/pump-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h

+2
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@
8282
*/
8383
#define CHIP_DEVICE_CONFIG_EVENT_LOGGING_DEBUG_BUFFER_SIZE (512)
8484

85+
#define MATTER_CC13X2_26X2_PLATFORM_LOG_ENABLED 1
86+
8587
/**
8688
* CHIP_DEVICE_CONFIG_ENABLE_THREAD_SRP_CLIENT
8789
*

‎examples/pump-controller-app/cc13x2x7_26x2x7/main/include/CHIPProjectConfig.h

+2
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@
8282
*/
8383
#define CHIP_DEVICE_CONFIG_EVENT_LOGGING_DEBUG_BUFFER_SIZE (512)
8484

85+
#define MATTER_CC13X2_26X2_PLATFORM_LOG_ENABLED 1
86+
8587
/**
8688
* CHIP_DEVICE_CONFIG_ENABLE_THREAD_SRP_CLIENT
8789
*

‎examples/shell/cc13x2x7_26x2x7/.gn

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Copyright (c) 2022 Project CHIP Authors
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
import("//build_overrides/build.gni")
16+
17+
# The location of the build configuration file.
18+
buildconfig = "${build_root}/config/BUILDCONFIG.gn"
19+
20+
# CHIP uses angle bracket includes.
21+
check_system_includes = true
22+
23+
default_args = {
24+
target_cpu = "arm"
25+
target_os = "freertos"
26+
27+
import("//args.gni")
28+
}

‎examples/shell/cc13x2x7_26x2x7/BUILD.gn

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# Copyright (c) 2022 Project CHIP Authors
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
import("//build_overrides/build.gni")
16+
import("//build_overrides/chip.gni")
17+
import("//build_overrides/openthread.gni")
18+
import("//build_overrides/ti_simplelink_sdk.gni")
19+
20+
import("${build_root}/config/defaults.gni")
21+
22+
import("${chip_root}/src/platform/device.gni")
23+
24+
import("${ti_simplelink_sdk_build_root}/ti_simplelink_executable.gni")
25+
import("${ti_simplelink_sdk_build_root}/ti_simplelink_sdk.gni")
26+
27+
assert(current_os == "freertos")
28+
29+
ti_simplelink_sdk("sdk") {
30+
include_dirs = [ "include" ]
31+
32+
defines = []
33+
}
34+
35+
ti_sysconfig("sysconfig") {
36+
sources = [ "chip.syscfg" ]
37+
38+
outputs = [
39+
"ti_radio_config.c",
40+
"ti_radio_config.h",
41+
"ti_drivers_config.c",
42+
"ti_drivers_config.h",
43+
"ti_ble_config.c",
44+
"ti_ble_config.h",
45+
"ti_dmm_application_policy.c",
46+
"ti_dmm_application_policy.h",
47+
48+
# disabled until upstream generation is aligned
49+
#"tiop_config.h",
50+
#"tiop_config.c",
51+
52+
# not traditional source files
53+
#"ti_utils_build_linker.cmd.genlibs",
54+
#"syscfg_c.rov.xs",
55+
#"ti_utils_runtime_model.gv",
56+
#"ti_utils_runtime_Makefile",
57+
#"ti_ble_app_config.opt",
58+
#"ti_build_config.opt",
59+
]
60+
61+
public_configs = [ ":sdk_dmm_config" ]
62+
63+
cflags = [
64+
"-Wno-comment",
65+
"@" + rebase_path("${target_gen_dir}/sysconfig/ti_ble_app_config.opt",
66+
root_build_dir),
67+
"@" + rebase_path("${target_gen_dir}/sysconfig/ti_build_config.opt",
68+
root_build_dir),
69+
]
70+
}
71+
72+
ti_simplelink_executable("shell_app") {
73+
output_name = "chip-${ti_simplelink_board}-shell-example.out"
74+
75+
sources = [
76+
"${chip_root}/examples/all-clusters-app/all-clusters-common/src/binding-handler.cpp",
77+
"${chip_root}/examples/all-clusters-app/all-clusters-common/src/bridged-actions-stub.cpp",
78+
"${chip_root}/examples/all-clusters-app/all-clusters-common/src/static-supported-modes-manager.cpp",
79+
"main/AppTask.cpp",
80+
"main/main.cpp",
81+
]
82+
83+
deps = [
84+
":sdk",
85+
":sysconfig",
86+
"${chip_root}/examples/all-clusters-app/all-clusters-common",
87+
"${chip_root}/examples/shell/shell_common:shell_common",
88+
"${chip_root}/src/lib",
89+
"${chip_root}/src/lib/shell:shell",
90+
"${chip_root}/src/setup_payload",
91+
]
92+
93+
if (chip_openthread_ftd) {
94+
deps += [ "${chip_root}/third_party/openthread/repo:libopenthread-ftd" ]
95+
} else {
96+
deps += [ "${chip_root}/third_party/openthread/repo:libopenthread-mtd" ]
97+
}
98+
99+
include_dirs = [
100+
"include",
101+
"main",
102+
"${chip_root}/examples/all-clusters-app/all-clusters-common/include",
103+
]
104+
105+
cflags = [
106+
"-Wno-implicit-fallthrough",
107+
"-Wno-sign-compare",
108+
"-Wconversion",
109+
]
110+
111+
output_dir = root_out_dir
112+
}
113+
114+
group("cc13x2x7_26x2x7") {
115+
deps = [ ":shell_app" ]
116+
}
117+
118+
group("default") {
119+
deps = [ ":cc13x2x7_26x2x7" ]
120+
}

‎examples/shell/cc13x2x7_26x2x7/README.md

+169
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
# Matter CC1352 CC2652 Shell Application
2+
3+
A [chip-shell](../README.md) project on the Texas Instruments CC13X2_26X2 family
4+
of Wireless MCUs.
5+
6+
## Building
7+
8+
### Preparation
9+
10+
Some initial setup is necessary for preparing the build environment. This
11+
section will need to be done when migrating to new versions of the SDK. This
12+
guide assumes that the environment is linux based, and recommends Ubuntu 20.04.
13+
14+
- Download and install [SysConfig][sysconfig] ([recommended
15+
version][sysconfig_recommended]). This can be done simply with the following
16+
commands.
17+
18+
```
19+
$ cd ~
20+
$ wget https://software-dl.ti.com/ccs/esd/sysconfig/sysconfig-1.11.0_2225-setup.run
21+
$ chmod +x sysconfig-1.11.0_2225-setup.run
22+
$ ./sysconfig-1.11.0_2225-setup.run
23+
```
24+
25+
- Run the bootstrap script to setup the build environment.
26+
27+
```
28+
$ cd ~/connectedhomeip
29+
$ source ./scripts/bootstrap.sh
30+
31+
```
32+
33+
### Compilation
34+
35+
It is necessary to activate the environment in every new shell. Then run GN and
36+
Ninja to build the executable.
37+
38+
- Activate the build environment with the repository activate script.
39+
40+
```
41+
$ cd ~/connectedhomeip
42+
$ source ./scripts/activate.sh
43+
44+
```
45+
46+
- Run the build to produce a default executable. By default on Linux both the
47+
TI SimpleLink SDK and Sysconfig are located in a `ti` folder in the user's
48+
home directory, and you must provide the absolute path to them. For example
49+
`/home/username/ti/sysconfig_1.11.0`. On Windows the default directory is
50+
`C:\ti`. Take note of this install path, as it will be used in the next
51+
step.
52+
53+
```
54+
$ cd ~/connectedhomeip/examples/all-clusters-app/cc13x2x7_26x2x7
55+
$ gn gen out/debug --args="ti_sysconfig_root=\"$HOME/ti/sysconfig_1.11.0\""
56+
$ ninja -C out/debug
57+
58+
```
59+
60+
## Programming
61+
62+
Loading the built image onto a LaunchPad is supported through two methods;
63+
Uniflash and Code Composer Studio (CCS). UniFlash can be used to load the image.
64+
Code Composer Studio can be used to load the image and debug the source code.
65+
66+
### Code Composer Studio
67+
68+
Programming with CCS will allow for a full debug environment within the IDE.
69+
This is accomplished by creating a target connection to the XDS110 debugger and
70+
starting a project-less debug session. The CCS IDE will attempt to find the
71+
source files on the local machine based on the debug information embedded within
72+
the ELF. CCS may prompt you to find the source code if the image was built on
73+
another machine or the source code is located in a different location than is
74+
recorded within the ELF.
75+
76+
Download and install [Code Composer Studio][ccs].
77+
78+
First open CCS and create a new workspace.
79+
80+
Create a target connection (sometimes called the CCXML) for your target SoC and
81+
debugger as described in the [Manual Method][ccs_manual_method] section of the
82+
CCS User's Guide.
83+
84+
Next initiate a project-less debug session as described in the [Manual
85+
Launch][ccs_manual_launch] section of the CCS User's Guide.
86+
87+
CCS should switch to the debug view described in the [After
88+
Launch][ccs_after_launch] section of the User's Guide. The SoC core will likely
89+
be disconnected and symbols will not be loaded. Connect to the core as described
90+
in the [Debug View][ccs_debug_view] section of the User's Guide. Once the core
91+
is connected, use the `Load` button on the toolbar to load the ELF image.
92+
93+
Note that the default configuration of the CCXML uses 2-wire cJTAG instead of
94+
the full 4-wire JTAG connection to match the default jumper configuration of the
95+
LaunchPad.
96+
97+
### UniFlash
98+
99+
Uniflash is Texas Instrument's uniform programming tool for embedded processors.
100+
This will allow you to erase, flash, and inspect the SoC without setting up a
101+
debugging environment.
102+
103+
Download and install [UniFlash][uniflash].
104+
105+
First open UniFlash. Debug probes connected to the computer will usually be
106+
displayed under the Detected Devices due to the automatic device detection
107+
feature. If your device does not show up in this view it my be disconnected, or
108+
you may have to create a New Configuration. If you already have a CCXML for your
109+
SoC and debug connection you can use that in the section at the bottom. Once
110+
your device is selected, click the `Start` button within the section to launch
111+
the session.
112+
113+
Select the ELF image to load on the device with the `Browse` button. This file
114+
is placed in the `out/debug` folder by this guide and ends with the `*.out` file
115+
extension.
116+
117+
Finally click the `Load Image` button to load the executable image onto the
118+
device. You should be able to see the log output over the XDS110 User UART.
119+
120+
Note that programming the device through JTAG sets the Halt-in-Boot flag and may
121+
cause issues when performing a software reset. This flag can be reset by
122+
power-cycling the LaunchPad.
123+
124+
## Running the Example
125+
126+
By default the log output will be sent to the Application/User UART. Open a
127+
terminal emulator to that port to see the output with the following options:
128+
129+
| Parameter | Value |
130+
| ------------ | -------- |
131+
| Speed (baud) | `115200` |
132+
| Data bits | `8` |
133+
| Stop bits | `1` |
134+
| Parity | `None` |
135+
| Flow control | `None` |
136+
137+
## Running the Example
138+
139+
Once a device has been flashed with this example, it can now join and operate in
140+
an existing Thread network. The following sections assume that a Thread network
141+
is already active, and has at least one [OpenThread Border
142+
Router][ot_border_router_setup].
143+
144+
For insight into what other components are needed to run this example, please
145+
refer to our [Matter Getting Started Guide][matter-e2e-faq].
146+
147+
For help with the shell itself, refer to the
148+
[shell example README](../README.md).
149+
150+
## TI Support
151+
152+
For technical support, please consider creating a post on TI's [E2E forum][e2e].
153+
Additionally, we welcome any feedback.
154+
155+
[ccs]: https://www.ti.com/tool/CCSTUDIO
156+
[ccs_after_launch]:
157+
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#after-launch
158+
[ccs_debug_view]:
159+
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#debug-view
160+
[ccs_manual_launch]:
161+
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#manual-launch
162+
[ccs_manual_method]:
163+
https://software-dl.ti.com/ccs/esd/documents/users_guide/ccs_debug-main.html?configuration#manual-method
164+
[e2e]: https://e2e.ti.com/support/wireless-connectivity/zigbee-and-thread
165+
[sysconfig]: https://www.ti.com/tool/SYSCONFIG
166+
[sysconfig_recommended]:
167+
https://software-dl.ti.com/ccs/esd/sysconfig/sysconfig-1.10.0_2163-setup.run
168+
[ti_cc13x2_26x2_r7_matter_request]: https://ti.com/chip_sdk
169+
[uniflash]: https://www.ti.com/tool/download/UNIFLASH

0 commit comments

Comments
 (0)