-
Notifications
You must be signed in to change notification settings - Fork 20
/
20721_readme.txt
118 lines (102 loc) · 5.88 KB
/
20721_readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
------------------------------------------------------------------------------------
BT SDK - CYW20721
------------------------------------------------------------------------------------
Overview
--------
The Cypress CYW20721 is an ultra-low-power dual-mode Bluetooth 5.0 wireless
MCU device. It has a stand-alone baseband processor with an integrated 2.4 GHz
transceiver supporting BR/EDR/BLE.
SDK Software Features
----------------------
- Dual mode Bluetooth stack included the ROM (BR/EDR and BLE).
- BT stack and profile level APIs for embedded BT application development.
- WICED HCI protocol to simplify host/MCU application development.
- APIs and drivers to access on board peripherals
- Bluetooth protocols include GAP, GATT, SMP, RFCOMM, SDP, AVDT/AVCT, BLE Mesh
- BLE and BR/EDR profile APIs, libraries and sample apps
- Support for Over-The-Air (OTA) upgrade.
- Documentation for APIs, datasheet, profiles and features.
Kits
----
CYW920721B2EVK-01 & CYW920721B2EVK-03:
40-QFN package, Arduino compatible headers, 9-axis motion sensor and thermistor,
user switches and LEDs, USB connector for power, programming and USB-UART bridge.
Note: (1) Max UART baud rate is 3M
(2) HW debugging is not supported on CYW920721B2EVK-03.
(3) Device configurator is not supported for CYW920721B2EVK-01 or CYW920721B2EVK-03.
Software Tools
--------------
Following applications are installed with ModusToolbox on your computer.
BT Spy :
BTSpy is a trace viewer utility that can be used in the WICED BT platforms to
view protocol and application trace messages from the embedded device. The
utility is located in folder below. For more information, see readme.txt
in the same folder. (This utility can also be run from IDE Launches menu).
It is supported on Windows, Linux and macOS.
<Install Dir>\ModusToolbox_1.1\tools\wiced-tools-1.0\BT\BTSpy
BT/BLE Profile Client Control:
This application emulates the host MCU applications for BLE and BR/EDR profile.
It demonstrates WICED BT APIs. It application communicates with embedded apps
over the WICED HCI interface. The application is located in folder below.
See readme.txt in the same folder. (This utility can also be run from IDE Launches menu).
It is supported on Windows, Linux and macOS.
<Install Dir>\ModusToolbox_1.1\libraries\bt_sdk-1.x\components\BT-SDK\common\client_control
BLE Mesh Client Control:
Similar to the above app, this application emulates the host MCU applications
for BLE Mesh models. It can configure and provision mesh devices and create mesh
network. The application is located in folder below. (Currently for Windows OS only).
<Install Dir>\ModusToolbox_1.1\libraries\bt_sdk-1.x\components\BT-SDK\common\apps\snip\mesh\ClientControl
See readme.txt in the same folder.
Peer apps:
Application that run on Windows, iOS or Android and act as peer
BT apps to demonstrate specific profiles or features.
BT/BLE apps location -
<Install Dir>\ModusToolbox_1.1\libraries\bt_sdk-1.x\components\BT-SDK\common\peer_apps
BLE Mesh apps location -
<Install Dir>\ModusToolbox_1.1\libraries\bt_sdk-1.x\components\BT-SDK\common\apps\snip\mesh\peerapps
Tracing
-------
To view application traces, there are 2 methods available. Note that the application
needs to configure the tracing options.
1. WICED Peripheral UART - Open this port on your computer using serial port utility
such as Tera Term or PuTTY (usually baud rate of 115200).
2. WICED HCI UART - Open this port on your computer using Client Control application
mentioned above (usually baud rate of 3M). Then run BT Spy utility mentioned above.
Application Settings
--------------------
Application settings can be changed via 'Change Application Settings...' menu (right click on
application in IDE). Options below are available for all applications. Other application
specific options might also be available and are documented in the readme.txt for those
applications.
BT_DEVICE_ADDRESS
Set BT device address for your BT device. The BT address is 6 bytes,
for example 20721B20FFEE. By default, the SDK will set random BDA for your device.
UART
Select the UART port you want the application to be downloaded. For example 'COM6'
on Windows or '/dev/ttyWICED_HCI_UART0' on Linux or '/dev/tty.usbserial-000154' on macOS.
By default, the SDK will auto detect the port.
ENABLE_DEBUG
For HW debugging, select the option '1'. See the document WICED-Hardware-Debugging.pdf
for more information. This setting configures GPIO for SWD.
CYW920721B2EVK-01: SWD hardware debugging is not compatible with the CYW9BT_AUDIO board.
PUART RX/TX signals are shared with SWDCK and SWDIO. Remove RX and TX jumpers on J10
when using SWD. PUART and SWD cannot be used simultaneously on this board unless these
pins are changed from the default configuration.
CYW920721B2EVK-03: HW debugging is not supported on this board.
Downloading application to kit
------------------------------
If you have issues downloading to the kit, follow the steps below -
- Press and hold the 'Recover' button on the kit.
- Press and hold the 'Reset' button on the kit.
- Release the 'Reset' button.
- After one second, release the 'Recover' button.
After downloading the application, press the 'Reset' button on the kit.
Over The Air (OTA) Firmware Upgrade
-----------------------------------
Application that support OTA upgrade can be updated via peer OTA apps located in the folder -
<Install Dir>\ModusToolbox_1.1\libraries\bt_sdk-1.x\components\BT-SDK\common\peer_apps\ota_firmware_upgrade
See the readme.txt file located in the above folder for instructions.
To generate OTA image for the app, append command line OTA_FW_UPGRADE=1 to the build, for example
> make PLATFORM=CYW920721B2EVK-01 OTA_FW_UPGRADE=1
This will generate <app>.bin file in the 'build' folder.
------------------------------------------------------------------------------------