Skip to content

Commit acd42c6

Browse files
JimTrudeauJimTrudeau
authored
Update README.md
1 parent 14dd26c commit acd42c6

File tree

1 file changed

+110
-1
lines changed

1 file changed

+110
-1
lines changed

‎README.md

Lines changed: 110 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,110 @@
1-
# PSoC-6-MCU-Code-Examples-with-ModusToolbox-IDE
1+
# PSoC 6 MCU Code Examples with ModusToolbox IDE
2+
This repository is a "Table of Contents" for the many ModusToolbox IDE code examples that are coming, and for resources available to you as a PSoC 6 MCU developer. As code examples appear, this document will link to them. Until then, use this to locate PSoC 6 MCU resources.
3+
4+
# Table of Contents
5+
6+
* [Importing a Code Example](#importing-a-code-example)
7+
* [Code Examples](#code-examples)
8+
* [Getting Started Examples](#getting-started-examples): basic examples that introduce the platform
9+
* [Analog Examples](#analog-examples): focus on analog peripherals like ADC, DAC, and comparators
10+
* [Digital Examples](#digital-examples): focus on a non-analog peripheral, such as UART, I2C, RTC, DMA, Interrupts, and so forth
11+
* [BLE Examples](#ble-examples): demonstrate Bluetooth Low Energy connectivity
12+
* [RTOS Examples](#rtos-examples): demonstrate how to integrate an RTOS
13+
* [System Examples](#system-examples): more complex examples that demonstrate a solution, such as a bootloader
14+
* [ModusToolbox IDE](#modustoolbox-ide)
15+
* [Kits](#kits)
16+
* [Technical Resources](#technical-resources)
17+
18+
# Importing a Code Example
19+
20+
We assume you're familiar with GitHub. You may need a little help understanding how to get the example into the IDE.
21+
22+
When you go to the repository, you can download or clone the repository. The IDE import process starts the same either way.
23+
24+
Use **File** > **Import** > **General** > **Existing projects into workspace**.
25+
26+
*If you downloaded a zip*: enable the **Select Archive File** option and browse to locate the archive (zip file)
27+
28+
*If you cloned*: enable the **Select root directory** option and browse to locate the directory where you cloned the example.
29+
30+
Then import all the projects in the archive or root directory. Most code examples have a PDF document that explains the code example. You will find that PDF file in the code example folder. Or you can read it right here on GitHub.
31+
32+
# Code Examples
33+
34+
Cypress provides a rich set of code examples for the PSoC 6 MCU, using the ModusToolbox IDE. PSoC 6 MCU bridges the gap between expensive, power hungry application processors and low‑performance microcontrollers (MCUs). The ultra‑low‑power, dual-core architecture of PSoC 6 MCU offers the processing performance needed by IoT devices, eliminating the tradeoffs between power and performance.
35+
36+
Code examples are grouped by category. The same code example may appear in more than one category. All the code examples come with well documented design guidelines to help you understand the design and how to develop it. Feel free to explore the code example source files and let's innovate together!
37+
38+
This ReadMe also includes information about ModusToolbox software, links to avaliable kits, and programming resources for PSoC 6 MCU.
39+
40+
## Getting Started Examples
41+
42+
| Code Example | Supported Kits | Notes |
43+
| ----- | ----- | ----- |
44+
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
45+
46+
## Analog Examples
47+
| Code Example | Supported Kits | Notes |
48+
| ----- | ----- | -----
49+
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
50+
51+
## Digital Examples
52+
| Code Example | Supported Kits | Notes |
53+
| ----- | ----- | ----- |
54+
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
55+
56+
## BLE Examples
57+
| Code Example | Supported Kits | Notes |
58+
| ----- | ----- | -----
59+
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
60+
61+
## RTOS Examples
62+
| Code Example | Supported Kits | Notes |
63+
| ----- | ----- | -----
64+
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
65+
66+
## System Examples
67+
| Code Example | Supported Kits | Notes |
68+
| ----- | ----- | -----
69+
| TBD | PSoC 6 BLE Kit, PSoC 6 WiFi-BT Kit | Notes Here |
70+
71+
# ModusToolbox IDE
72+
![](/images/MTbanner.png)
73+
74+
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.
75+
76+
* [ModusToolbox](http://www.cypress.com/products/modustoolbox-integrated-design-environment-ide)
77+
78+
# Kits
79+
Cypress provides low-cost development kits for the PSoC 6 MCU platform.
80+
81+
[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.
82+
83+
[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.
84+
85+
# Technical Resources
86+
87+
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.
88+
89+
For a comprehensive list of PSoC 6 MCU resources, see [KBA223067](https://community.cypress.com/docs/DOC-14644) in the Cypress community.
90+
91+
#### PSoC 6 MCU Datasheets
92+
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)
93+
94+
#### PSoC 6 MCU Application Notes
95+
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)
96+
97+
#### PSoC 6 MCU Technical Reference Manuals (TRM)
98+
The TRM provides detailed descriptions of the internal architecture of PSoC 6 devices:[PSoC 6 MCU TRMs](http://www.cypress.com/psoc6trm)
99+
100+
### Cypress Developer Community ##
101+
102+
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.
103+
104+
[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)
105+
106+
### Technical Support
107+
108+
You can also use the following support resources if you need quick assistance:
109+
##### Self-help: [Technical Support](http://www.cypress.com/support)
110+
##### Local Sales office locations: [Sales Office](http://www.cypress.com/about-us/sales-offices)

0 commit comments

Comments
 (0)