Matt's Tips: Finding Code Examples for PSoC Creator | Cypress Semiconductor
Matt's Tips: Finding Code Examples for PSoC Creator
This is a reblog from the PSoC Today! entry I did last May 2014. I'm posting this again in hopes of getting more visibility for the example project finder in Creator. I also plan to discuss some plans we have for example projects (which we will start calling "Code Examples") in the PSoC Creator forum. That's here, in case you were unaware.
Users new to a tool almost always agree on one thing - more (good) examples are better! Even experienced users don't want to reinvent the wheel. To that end, this post will cover a few ways you can find examples for PSoC Creator.
The Example Finder
In PSoC Creator, there are a couple of ways to find example projects. Many of you are familiar with finding example projects for particular components (I'll discuss this in a bit), but in Creator 3.X there is also an example finder accessible from the file menu. See the screenshot below.
Once you select "Example Project", you will get a search tool which allows you to customize your results based on keyword, architecture, etc. Notice in the image below that once you select an example project from the left-hand side, there are two tabs on the right that give you more information about the project.
(1) The documentation tab, highlighted in yellow in the screenshot, gives you a description of the project. Sometimes the descriptions are elaborate and sometimes they are just a basic overview of what the project does. Also notice the buttons at the bottom of the dialog box which allow you to add the project to the existing workspace or a new one.
(2) The Sample Code tab shows the code that comes with the example. See the image shown next. You can copy and paste code from this window if you don't want to use the example project as a basis for your new project. I find this helpful to see how the various APIs for a given component are called.
Finding examples for specific Creator components
Most components have example project(s) associated with them. You can find these projects by simply right-clicking on the component. See the image below. When I right click on the themistor component, one of my options is Find Example Project .
You can bring up this menu from the Component browser as well. While this feature has been around for a while, I still run across folks who have just not noticed it. I'm out to fix that! I use "Open Datasheet" and "Open Component Web Page" frequently as well.
In the future, we plan on adding both more examples AND more ways to search for the examples such as by solution space or by "degree of difficulty". What examples would you like to see? How would you like to search for them? Hit me up in the comments or email me directly at email@example.com.
Best regards to my brothers and sisters in PSoC.
Matt Landrum, PSoC Software Customer Advocate
Cypress Semiconductor- Portland, OR