This is an old revision of the document!
! - You need to fix the header here, the page names itself after this heading.
! - Add text, picture, images, that describe what you are doing. Focus on the application, sensor types, end goal, any important themes or theories, equations or other important tables/information. The more info here the better.
! - Add text, part numbers, hyper links and other important information and where to get it in order to recreate this demo.
The following is a list of items needed in order to replicate this demo.
! - Add text, picture, images, that describe how to setup the example application hardware. A list of boards, sensors, equipment, cables, etc needed to recreate the demo. Step by step picture here are helpful with block diagrams on how to connect things, how to setup options on the boards (Like what UART switch position is the ADICUP3029 in? What power switch position? Is there a chip select jumper on the add-on board that needs to be set?)
! - Add text, picture, images, code blocks that describe how to configure the software. Things like changing the accelerometer range from 2g to 4g should be a trivial change for the customer. We don't have to show them everything, but think of the application, and what parameters are most likely need to be customized by the user. (like providing a an ID or password for a local gateway using WI-FI)
! - Add text, picture, images, that describe how to output data from the setup/application. Is this a UART output, then show the customer a putty serial terminal with the correct baud rate and commands that need to be entered to get data. Are there any calibrations that need to happen? Show/explain how customers can run the calibration steps. If this is a wireless demo, how do you get the information after it is sent to the cloud? We can use our apps and tools, but the customer should be able to recreate this demo using the same tools/plugins/components you used to view the data.
! - make sure this is correct for your application Once the hardware and software is configured, user needs to follow on screen instructions to run Visible Light Detection\Measurement demo.
Following is the UART configuration.
Select COM Port Baud rate: 9600 Data: 8 bit Parity: none Stop: 1 bit Flow Control: none
! - Make sure you point out which app is correct and then talk about the data that gets output. (Pictures are great) and link over to the app page so customers can figure out how to download/install it. If it's not Bluetooth compatible remove this section
! - Make sure you talk about how to display the data, and link over to the Wi-Fi wiki page for more details. It the example isn't Wi-Fi enabled delete this section.
We recommend not opening the project directly, but rather import it into CrossCore Embedded Studios and make a local copy in your workspace.
The source code and include files of the !file_name_of_demo can be found here:
! - This will be either a link to a Git repository or a pack file somewhere, but make sure this is accessible to the customer. We want them to take our code and use it because that means they are going to use our hardware, and we get paid when that happens.
The official tool we promote for use with the EVAL-ADICUP3029 is CrossCore Embedded Studio. For more information on downloading the tools and a quick start guide on how to use the tool basics, please check out the Tools Overview page.
For more detailed instructions on importing this application/demo example into the CrossCore Embedded Studios tools, please view our How to import existing projects into your workspace section.
For more detailed instructions on importing this application/demo example into the CrossCore Embedded Studios tools, please view our How to configure the debug session section.
! - Add text, picture, images, that describe the project structure. Any software flow diagrams or decision trees can be added her to help customers understand how the applications are structures.
End of Document