|
1 | | -# MCU Examples for PSoC 6 SDK and ModusToolbox<sup>TM</sup> IDE |
| 1 | +# Code Examples for the ModusToolbox<sup>TM</sup> PSoC 6 SDK |
2 | 2 |
|
| 3 | +This file is a placeholder for the upcoming release of code examples for ModusToolbox IDE. |
3 | 4 |
|
4 | 5 | # Table of Contents |
5 | 6 |
|
6 | 7 | * [Overview](#overview) |
7 | | -* [Creating the Code Example](#creating-the-code-example) |
| 8 | +* [Adding the Code Example to the IDE](#adding-the-code-example-to-the-ide) |
8 | 9 | * [MCU Code Examples](#mcu-code-examples) |
9 | 10 | * [ModusToolbox IDE](#modustoolbox-ide) |
10 | 11 | * [Kits](#kits) |
11 | 12 | * [Technical Resources](#technical-resources) |
12 | | - |
13 | 13 | ## Overview |
14 | 14 |
|
15 | | -These examples demonstrate the peripherals and basic functionality of the PSoC 6 MCU. Each example has a readme.txt, and a comprehensive PDF document that explains what to do and what to observe when running the example. |
| 15 | +These examples demonstrate the peripherals and basic functionality of the PSoC 6 MCU. Some examples demonstrate more complex solutions. Each example has a readme.txt, and a comprehensive PDF document that explains what to do and what to observe when running the example. |
| 16 | + |
| 17 | +The code examples in this repository all use [ModusToolbox™ IDE](http://www.cypress.com/products/modustoolbox-integrated-design-environment-ide) and the C language. |
| 18 | + |
| 19 | +The specific supported kits and parts vary per example. Review the readme.txt or the PDF file for each example. Most examples support all [PSoC 6<sup>®</sup> MCU](http://www.cypress.com/PSoC6) parts |
| 20 | + |
| 21 | +Supported kits include [PSoC 6 BLE Pioneer Kit](http://www.cypress.com/go/cy8ckit-062-ble), [PSoC 6 WiFi-BT Pioneer Kit](http://www.cypress.com/documentation/development-kitsboards/psoc-6-wifi-bt-pioneer-kit), and [PSoC 6 Wi-Fi BT Prototyping Kit](http://www.cypress.com/cy8cproto-062-4343w). |
| 22 | + |
| 23 | +You can browse the code examples in the repository, or use GitHub's search capabilities to find a particular symbol or term. Just type the term into the search box and search in this repository. |
16 | 24 |
|
17 | | -## Creating the Code Example |
| 25 | + |
18 | 26 |
|
19 | | -Download and unzip this repository onto your local machine. You can also clone the repository into a location on your local machine. |
| 27 | +## Adding the Code Example to the IDE |
20 | 28 |
|
21 | | -In the ModusToolbox IDE, use **File > New > ModusToolbox IDE Application**. Pick your kit or device. You must use a supported kit or device. Supported kits are in the list of code examples below, and in the readme.txt file. |
| 29 | +Download and unzip this repository onto your local machine. You can also clone the repository into a location on your local machine. This puts all the code examples on your local machine. |
| 30 | + |
| 31 | +In the ModusToolbox IDE, use **File > New > ModusToolbox IDE Application**. Pick your kit or device. You must use a kit or device supported by the code example. |
22 | 32 |
|
23 | 33 | In the **Starter Application** window, click the **Browse** button and navigate to the _modus.mk_ file for the example. Click **Next** and complete the application creation process. |
24 | | -Then import all the projects in the archive or root directory. |
25 | 34 |
|
26 | | -# MCU Code Examples |
27 | | -| Code Example | Supported Kits | Notes | |
28 | | -| ----- | ----- | ----- | |
29 | | -| Come back soon | TBD | Notes here | |
| 35 | +## MCU Code Examples |
30 | 36 |
|
| 37 | +| Code Example | Description | |
| 38 | +| ----- | ----- | |
| 39 | +|Stay Tuned! | Many code examples will appear here | |
31 | 40 |
|
32 | 41 | # ModusToolbox IDE |
33 | 42 |  |
34 | 43 |
|
35 | | -ModusToolbox™ IDE for IoT designers provides a single, coherent, and familiar design experience combining the industry’s most deployed WiFi and Bluetooth technologies, and the lowest power, most flexible MCUs with best-in-class sensing. |
| 44 | +ModusToolbox™ IDE is based on the industry standard Eclipse IDE, and provides a single, coherent, and familiar design experience for the lowest power, most flexible MCUs with best-in-class sensing. |
36 | 45 |
|
37 | 46 | * [ModusToolbox](http://www.cypress.com/products/modustoolbox-integrated-design-environment-ide) |
38 | 47 |
|
39 | 48 | # Kits |
40 | 49 | Cypress provides low-cost development kits for the PSoC 6 MCU platform. |
41 | 50 |
|
42 | | -[PSoC® 6 BLE Pioneer Kit](http://www.cypress.com/documentation/development-kitsboards/psoc-6-ble-pioneer-kit): The PSoC 6 BLE Pioneer Kit (CY8CKIT-062-BLE) enables design and debug of the PSoC 63 Line. The kit includes an E-Ink display, and Cypress' industry-leading CapSense. |
| 51 | +[PSoC 6 BLE Pioneer Kit](http://www.cypress.com/documentation/development-kitsboards/psoc-6-ble-pioneer-kit): The PSoC 6 BLE Pioneer Kit enables design and debug of the PSoC 63 Line. The kit includes an E-Ink display, and Cypress' industry-leading CapSense® technology. |
| 52 | + |
| 53 | +[PSoC 6 WiFi-BT Pioneer Kit](http://www.cypress.com/documentation/development-kitsboards/psoc-6-wifi-bt-pioneer-kit): The PSoC 6 WiFi-BT Pioneer Kit enables design and debug of the PSoC 62 MCU and the Murata LBEE5KL1DX Module (CYW4343W WiFi + Bluetooth Combo Chip). It includes a TFT display and Cypress' industry-leading CapSense technology. |
43 | 54 |
|
44 | | -[PSoC® 6 WiFi-BT Pioneer Kit](http://www.cypress.com/documentation/development-kitsboards/psoc-6-wifi-bt-pioneer-kit): The PSoC 6 WiFi-BT Pioneer Kit (CY8CKIT-062-WiFi-BT) enables design and debug of the PSoC 62 MCU and the Murata LBEE5KL1DX Module (CYW4343W WiFi + Bluetooth Combo Chip). It includes a TFT display and Cypress' industry-leading CapSense. |
| 55 | +[PSoC 6 Wi-Fi BT Prototyping Kit](http://www.cypress.com/cy8cproto-062-4343w) enables design and debug of PSoC 6 MCUs. It comes with industry-leading CapSense technology for touch buttons and slider, on-board debugger/programmer with KitProg3, μSD card interface, 512-Mb Quad-SPI NOR flash, PDM-PCM microphone, and a thermistor. It also includes a Murata LBEE5KL1DX module, based on the CYW4343W combo device. |
45 | 56 |
|
46 | 57 | # Technical Resources |
47 | 58 |
|
48 | 59 | Cypress provides a wealth of data at [www.cypress.com](http://www.cypress.com/) to help you select the right PSoC device and effectively integrate it into your design. Visit our [PSoC 6 MCU](http://www.cypress.com/products/32-bit-arm-cortex-m4-psoc-6) webpage to explore more about PSoC 6 MCU family of device. |
49 | 60 |
|
50 | 61 | For a comprehensive list of PSoC 6 MCU resources, see [KBA223067](https://community.cypress.com/docs/DOC-14644) in the Cypress community. |
51 | 62 |
|
52 | | -#### PSoC 6 MCU Datasheets |
53 | | -Device datasheets list the features and electrical specifications of PSoC 6 families of devices: [PSoC 6 MCU Datasheets](http://www.cypress.com/search/all?f%5B0%5D=meta_type%3Atechnical_documents&f%5B1%5D=resource_meta_type%3A575&f%5B2%5D=field_related_products%3A114026) |
| 63 | +#### [PSoC 6 MCU Datasheets](http://www.cypress.com/search/all?f%5B0%5D=meta_type%3Atechnical_documents&f%5B1%5D=resource_meta_type%3A575&f%5B2%5D=field_related_products%3A114026) |
| 64 | +Device datasheets list the features and electrical specifications of PSoC 6 families of devices. |
54 | 65 |
|
55 | | -#### PSoC 6 MCU Application Notes |
56 | | -Application notes are available on the Cypress website to assist you with designing your PSoC application: [A list of PSoC 6 MCU ANs](http://www.cypress.com/psoc6an) |
| 66 | +#### [PSoC 6 MCU Application Notes](http://www.cypress.com/psoc6an) |
| 67 | +Application notes are available on the Cypress website to assist you with designing your PSoC application. |
57 | 68 |
|
58 | | -#### PSoC 6 MCU Technical Reference Manuals (TRM) |
59 | | -The TRM provides detailed descriptions of the internal architecture of PSoC 6 devices:[PSoC 6 MCU TRMs](http://www.cypress.com/psoc6trm) |
| 69 | +#### [PSoC 6 MCU Technical Reference Manuals](http://www.cypress.com/psoc6trm) |
| 70 | +The TRM provides detailed descriptions of the internal architecture of PSoC 6 devices. |
60 | 71 |
|
61 | 72 | ### Cypress Developer Community ## |
62 | 73 |
|
63 | 74 | Need support for your design and development questions? Check out the [PSoC 6 forum](https://community.cypress.com/community/psoc-6) on the [Cypress Developer Community 3.0](https://community.cypress.com/welcome). Interact with technical experts in the embedded design community and receive answers verified by Cypress' very best applications engineers. You'll also have access to robust technical documentation, active conversation threads, and rich multimedia content. |
64 | 75 |
|
65 | 76 | [Community Forums](https://community.cypress.com/welcome) | [Videos](http://www.cypress.com/video-library) | [Blogs](http://www.cypress.com/blog) | [Training](http://www.cypress.com/training) |
66 | | - |
67 | | -### Technical Support |
68 | | - |
69 | | -You can also use the following support resources if you need quick assistance: |
70 | | -##### Self-help: [Technical Support](http://www.cypress.com/support) |
71 | | -##### Local Sales office locations: [Sales Office](http://www.cypress.com/about-us/sales-offices) |
|
0 commit comments