Skip to content

Commit ec6e34b

Browse files
s07641069interfer
s07641069
and
interfer
authored
[Telink] Add Temperature Measurement app demo (#25366)
* [Telink] Temperature Measurement App demo added (simulated data) * [Telink] Temperature Measurement App demo GitHub CI modified * [Telink] move zap & matter files into common folder * [Telink] Cleanup & fix identify cluster * [Telink] Remove identify functionality * [Telink] Set correct app name for CI build * [Telink] Fix code style --------- Co-authored-by: Dmytro Huz <diman1436@gmail.com>
1 parent eff5773 commit ec6e34b

File tree

22 files changed

+1280
-5
lines changed

22 files changed

+1280
-5
lines changed

‎.github/workflows/examples-telink.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,15 @@ jobs:
160160
out/telink-tlsr9518adk80d-pump-controller/zephyr/zephyr.elf \
161161
/tmp/bloat_reports/
162162
163+
- name: Build example Telink Temperature Measurement App
164+
run: |
165+
./scripts/run_in_build_env.sh \
166+
"./scripts/build/build_examples.py --target 'telink-tlsr9518adk80d-temperature-measurement' build"
167+
.environment/pigweed-venv/bin/python3 scripts/tools/memory/gh_sizes.py \
168+
telink tlsr9518adk80d temperature-measurement-app \
169+
out/telink-tlsr9518adk80d-temperature-measurement/zephyr/zephyr.elf \
170+
/tmp/bloat_reports/
171+
163172
- name: Build example Telink Thermostat App
164173
run: |
165174
./scripts/run_in_build_env.sh \

‎.vscode/tasks.json

+1
Original file line numberDiff line numberDiff line change
@@ -645,6 +645,7 @@
645645
"telink-tlsr9518adk80d-ota-requestor",
646646
"telink-tlsr9518adk80d-pump-app",
647647
"telink-tlsr9518adk80d-pump-controller-app",
648+
"telink-tlsr9518adk80d-temperature-measurement",
648649
"telink-tlsr9518adk80d-thermostat",
649650
"tizen-arm-light"
650651
]

‎examples/temperature-measurement-app/esp32/main/CMakeLists.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ idf_component_register(PRIV_INCLUDE_DIRS ${PRIV_INCLUDE_DIRS_LIST}
7878
PRIV_REQUIRES ${PRIV_REQUIRES_LIST})
7979

8080
include("${CHIP_ROOT}/build/chip/esp32/esp32_codegen.cmake")
81-
chip_app_component_codegen("${CHIP_ROOT}/examples/temperature-measurement-app/esp32/main/temperature-measurement.matter")
82-
chip_app_component_zapgen("${CHIP_ROOT}/examples/temperature-measurement-app/esp32/main/temperature-measurement.zap")
81+
chip_app_component_codegen("${CHIP_ROOT}/examples/temperature-measurement-app/temperature-measurement-common/temperature-measurement.matter")
82+
chip_app_component_zapgen("${CHIP_ROOT}/examples/temperature-measurement-app/temperature-measurement-common/temperature-measurement.zap")
8383

8484
set_property(TARGET ${COMPONENT_LIB} PROPERTY CXX_STANDARD 17)
8585
target_compile_options(${COMPONENT_LIB} PRIVATE "-DCHIP_HAVE_CONFIG_H")

‎examples/temperature-measurement-app/telink/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/build/

‎examples/temperature-measurement-app/telink/CMakeLists.txt

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
#
2+
# Copyright (c) 2023 Project CHIP Authors
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
cmake_minimum_required(VERSION 3.13.1)
17+
18+
set(BOARD tlsr9518adk80d)
19+
20+
get_filename_component(CHIP_ROOT ${CMAKE_CURRENT_SOURCE_DIR}/third_party/connectedhomeip REALPATH)
21+
get_filename_component(TELINK_COMMON ${CHIP_ROOT}/examples/platform/telink REALPATH)
22+
get_filename_component(GEN_DIR ${CHIP_ROOT}/zzz_generated/ REALPATH)
23+
24+
set(CONF_FILE ${CHIP_ROOT}/config/telink/app/zephyr.conf prj.conf)
25+
26+
# Load NCS/Zephyr build system
27+
list(APPEND ZEPHYR_EXTRA_MODULES ${CHIP_ROOT}/config/telink/chip-module)
28+
find_package(Zephyr HINTS $ENV{ZEPHYR_BASE})
29+
30+
project(chip-telink-temperature-measurement-example)
31+
32+
include(${CHIP_ROOT}/config/telink/app/enable-gnu-std.cmake)
33+
include(${CHIP_ROOT}/src/app/chip_data_model.cmake)
34+
35+
target_compile_options(app PRIVATE -fpermissive)
36+
37+
target_include_directories(app PRIVATE
38+
include
39+
${GEN_DIR}/app-common
40+
${GEN_DIR}/temperature-measurement-app
41+
${TELINK_COMMON}/util/include
42+
${TELINK_COMMON}/app/include
43+
)
44+
45+
add_definitions(
46+
"-DCHIP_ADDRESS_RESOLVE_IMPL_INCLUDE_HEADER=<lib/address_resolve/AddressResolve_DefaultImpl.h>"
47+
)
48+
49+
target_sources(app PRIVATE
50+
src/AppTask.cpp
51+
src/SensorManager.cpp
52+
src/main.cpp
53+
${TELINK_COMMON}/util/src/LEDWidget.cpp
54+
${TELINK_COMMON}/util/src/ButtonManager.cpp
55+
${TELINK_COMMON}/util/src/ThreadUtil.cpp
56+
${TELINK_COMMON}/util/src/PWMDevice.cpp
57+
)
58+
59+
chip_configure_data_model(app
60+
INCLUDE_SERVER
61+
ZAP_FILE ${CMAKE_CURRENT_SOURCE_DIR}/../temperature-measurement-common/temperature-measurement.zap
62+
)
63+
64+
if(CONFIG_CHIP_OTA_REQUESTOR)
65+
target_sources(app PRIVATE ${TELINK_COMMON}/util/src/OTAUtil.cpp)
66+
endif()

‎examples/temperature-measurement-app/telink/README.md

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
# Matter Telink Temperature Measurement Example Application
2+
3+
The Telink Temperature Measurement Example demonstrates getting simulated data
4+
from temperature sensor. In further releases the real sensor handling will be
5+
implemented along. It uses buttons to test changing the device states and LEDs
6+
to show the state of these changes. You can use this example as a reference for
7+
creating your own application.
8+
9+
![Telink B91 EVK](http://wiki.telink-semi.cn/wiki/assets/Hardware/B91_Generic_Starter_Kit_Hardware_Guide/connection_chart.png)
10+
11+
## Build and flash
12+
13+
1. Pull docker image from repository:
14+
15+
```bash
16+
$ docker pull connectedhomeip/chip-build-telink:latest
17+
```
18+
19+
1. Run docker container:
20+
21+
```bash
22+
$ docker run -it --rm -v ${CHIP_BASE}:/root/chip -v /dev/bus/usb:/dev/bus/usb --device-cgroup-rule "c 189:* rmw" connectedhomeip/chip-build-telink:latest
23+
```
24+
25+
here `${CHIP_BASE}` is directory which contains CHIP repo files **!!!Pay
26+
attention that OUTPUT_DIR should contains ABSOLUTE path to output dir**
27+
28+
1. Activate the build environment:
29+
30+
```bash
31+
$ source ./scripts/activate.sh
32+
```
33+
34+
1. In the example dir run:
35+
36+
```bash
37+
$ west build
38+
```
39+
40+
1. Flash binary:
41+
42+
```
43+
$ west flash --erase
44+
```
45+
46+
## Usage
47+
48+
### UART
49+
50+
To get output from device, connect UART to following pins:
51+
52+
| Name | Pin |
53+
| :--: | :---------------------------- |
54+
| RX | PB3 (pin 17 of J34 connector) |
55+
| TX | PB2 (pin 16 of J34 connector) |
56+
| GND | GND |
57+
58+
### Buttons
59+
60+
The following buttons are available on **tlsr9518adk80d** board:
61+
62+
| Name | Function | Description |
63+
| :------- | :--------------------- | :----------------------------------------------------------------------------------------------------- |
64+
| Button 1 | Factory reset | Perform factory reset to forget currently commissioned Thread network and back to uncommissioned state |
65+
| Button 2 | NA | NA |
66+
| Button 3 | Thread start | Commission thread with static credentials and enables the Thread on device |
67+
| Button 4 | Open commission window | The button is opening commissioning window to perform commissioning over BLE |
68+
69+
### LEDs
70+
71+
#### Indicate current state of Thread network
72+
73+
**Red** LED indicates current state of Thread network. It is able to be in
74+
following states:
75+
76+
| State | Description |
77+
| :-------------------------- | :--------------------------------------------------------------------------- |
78+
| Blinks with short pulses | Device is not commissioned to Thread, Thread is disabled |
79+
| Blinks with frequent pulses | Device is commissioned, Thread enabled. Device trying to JOIN thread network |
80+
| Blinks with wide pulses | Device commissioned and joined to thread network as CHILD |
81+
82+
### CHIP tool commands
83+
84+
1. Build
85+
[chip-tool cli](https://github.com/project-chip/connectedhomeip/blob/master/examples/chip-tool/README.md)
86+
87+
2. Pair with device
88+
89+
```
90+
${CHIP_TOOL_DIR}/chip-tool pairing ble-thread ${NODE_ID} hex:${DATASET} ${PIN_CODE} ${DISCRIMINATOR}
91+
```
92+
93+
Example:
94+
95+
```
96+
./chip-tool pairing ble-thread 1234 hex:0e080000000000010000000300000f35060004001fffe0020811111111222222220708fd61f77bd3df233e051000112233445566778899aabbccddeeff030e4f70656e54687265616444656d6f010212340410445f2b5ca6f2a93a55ce570a70efeecb0c0402a0fff8 20202021 3840
97+
```
98+
99+
### OTA with Linux OTA Provider
100+
101+
OTA feature enabled by default only for ota-requestor-app example. To enable OTA
102+
feature for another Telink example:
103+
104+
- set CONFIG_CHIP_OTA_REQUESTOR=y in corresponding "prj.conf" configuration
105+
file.
106+
107+
After build application with enabled OTA feature, use next binary files:
108+
109+
- zephyr.bin - main binary to flash PCB (Use 2MB PCB).
110+
- zephyr-ota.bin - binary for OTA Provider
111+
112+
All binaries has the same SW version. To test OTA “zephyr-ota.bin” should have
113+
higher SW version than base SW. Set CONFIG_CHIP_DEVICE_SOFTWARE_VERSION=2 in
114+
corresponding “prj.conf” configuration file.
115+
116+
Usage of OTA:
117+
118+
- Build the [Linux OTA Provider](../../ota-provider-app/linux)
119+
120+
```
121+
./scripts/examples/gn_build_example.sh examples/ota-provider-app/linux out/ota-provider-app chip_config_network_layer_ble=false
122+
```
123+
124+
- Run the Linux OTA Provider with OTA image.
125+
126+
```
127+
./chip-ota-provider-app -f zephyr-ota.bin
128+
```
129+
130+
- Provision the Linux OTA Provider using chip-tool
131+
132+
```
133+
./chip-tool pairing onnetwork ${OTA_PROVIDER_NODE_ID} 20202021
134+
```
135+
136+
here:
137+
138+
- \${OTA_PROVIDER_NODE_ID} is the node id of Linux OTA Provider
139+
140+
- Configure the ACL of the ota-provider-app to allow access
141+
142+
```
143+
./chip-tool accesscontrol write acl '[{"fabricIndex": 1, "privilege": 5, "authMode": 2, "subjects": [112233], "targets": null}, {"fabricIndex": 1, "privilege": 3, "authMode": 2, "subjects": null, "targets": null}]' ${OTA_PROVIDER_NODE_ID} 0
144+
```
145+
146+
here:
147+
148+
- \${OTA_PROVIDER_NODE_ID} is the node id of Linux OTA Provider
149+
150+
- Use the chip-tool to announce the ota-provider-app to start the OTA process
151+
152+
```
153+
./chip-tool otasoftwareupdaterequestor announce-ota-provider ${OTA_PROVIDER_NODE_ID} 0 0 0 ${DEVICE_NODE_ID} 0
154+
```
155+
156+
here:
157+
158+
- \${OTA_PROVIDER_NODE_ID} is the node id of Linux OTA Provider
159+
- \${DEVICE_NODE_ID} is the node id of paired device
160+
161+
Once the transfer is complete, OTA requestor sends ApplyUpdateRequest command to
162+
OTA provider for applying the image. Device will restart on successful
163+
application of OTA image.

‎examples/temperature-measurement-app/telink/include/AppConfig.h

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
*
3+
* Copyright (c) 2023 Project CHIP Authors
4+
* All rights reserved.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#pragma once
20+
21+
// ---- Temperature measurement Example App Config ----
22+
23+
// Buttons config
24+
#define BUTTON_PORT DEVICE_DT_GET(DT_NODELABEL(gpioc))
25+
26+
#define BUTTON_PIN_1 2
27+
#define BUTTON_PIN_3 3
28+
#define BUTTON_PIN_4 1
29+
#define BUTTON_PIN_2 0
30+
31+
// LEDs config
32+
#define LEDS_PORT DEVICE_DT_GET(DT_NODELABEL(gpiob))
33+
#define SYSTEM_STATE_LED 7

‎examples/temperature-measurement-app/telink/include/AppEvent.h

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
/*
2+
*
3+
* Copyright (c) 2023 Project CHIP Authors
4+
* All rights reserved.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#pragma once
20+
21+
#include <cstdint>
22+
23+
struct AppEvent;
24+
typedef void (*EventHandler)(AppEvent *);
25+
26+
class LEDWidget;
27+
28+
struct AppEvent
29+
{
30+
enum AppEventTypes
31+
{
32+
kEventType_Button = 0,
33+
kEventType_Timer,
34+
kEventType_UpdateLedState,
35+
kEventType_Install,
36+
};
37+
38+
uint16_t Type;
39+
40+
union
41+
{
42+
struct
43+
{
44+
uint8_t Action;
45+
} ButtonEvent;
46+
struct
47+
{
48+
void * Context;
49+
} TimerEvent;
50+
struct
51+
{
52+
LEDWidget * LedWidget;
53+
} UpdateLedStateEvent;
54+
};
55+
56+
EventHandler Handler;
57+
};

0 commit comments

Comments
 (0)