MPAE-19450 updated to SPA version, added readme

Author: Glen-Nilsen

README.md

@@ -1,5 +1,6 @@
 <!-- MPAE-19450 Please do not change this logo with link -->
 
+
 <a target="_blank" href="https://www.microchip.com/" id="top-of-page">
    <picture>
       <source media="(prefers-color-scheme: light)" srcset="images/mchp_logo_light.png" width="350">
@@ -8,44 +9,81 @@
    </picture>
 </a>
 
-# Update the title for pic18f57q43-i2c-proximity-sensor-callbacks-data-streamer here
+# PIC18F57Q43 I<sup>2</sup>C_Host Example Component for CNano Explorer: I<sup>2</sup>C Proximity Sensor (Callbacks, Data Streamer)
+
+The [I<sup>2</sup>C Proximity Sensor example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EX.RUNNING.I2C.HOST.PROXIMITY.SENSOR&version=latest&redirect=true "I2C Proximity Sensor example"
+), of the [MCC Melody I<sup>2</sup>C Example Component (for the Curiosity Nano Explorer)](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EXAMPLE.COMPONENT&version=latest&redirect=true "MCC Melody I<sup>2</sup>C Example Component for the Curiosity Nano Explorer"
+), is used here in the Callbacks implementation, with the Data Streamer visualization. 
+
+![alt text](images/pic18f57q43-i2c-proximity-sensor-callbacks-datastreamer_intro.png)
+
+This example demonstrates how to read the value of the VCNL4200 proximity sensor on the Curiosity Nano Explorer, with the Data Streamer Visualization Output selected. Every 100 ms, an LED and a Debug I/O pin are toggled. A Timer overflow callback is used to send a Data Streamer frame every 100 ms. 
+
+In the MCC Melody Data Streamer library configruation, the appropriately typed variables are added to the Data Streamer table.  
+
+![alt text](images/pic18f57q43-i2c-proximity-sensor-callbacks-datastreamerTable_uartPins.png)
+
+
+The below image of the MPLAB Data Visualizer shows the application running, where the variable configured in the Data Streamer Table have been imported as a Variable Streamer in the [MPLAB® Data Visualizer](https://www.microchip.com/en-us/tools-resources/debug/mplab-data-visualizer "MPLAB® Data Visualizer"), via a generated .ds (data streamer file). 
+![alt text](images/pic18f57q43-i2c-proximity-sensor-dataStreamer.png)
+
+The following is a block diagram view of the application, as seen in the [MCC Melody Builder](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.BUILDER&version=latest&redirect=true "MCC Melody Builder"). 
+
+![Data Streamer configuration showing Data Streamer Table and UART pins](images/pic18f57q43-i2c-proximity-sensor-Callbacks-DataStreamer_builder.png)
+
+## MCC Melody Example Components
+Example Components are a tight integration of learning material directly into MCC. This allows users to conveniently place the configuration instructions side-by-side to the components they are configuring. For more information, refer to the [MCC Melody Example Components](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES&version=latest&redirect=true) introduction. 
 
-<!-- This is where the introduction to the example goes, including mentioning the peripherals used -->
 
 ## Related Documentation
 
-<!-- Any information about an application note or tech brief can be linked here. Use unbreakable links!
-     In addition a link to the device family landing page and relevant peripheral pages as well:
-     - [AN3381 - Brushless DC Fan Speed Control Using Temperature Input and Tachometer Feedback](https://microchip.com/00003381/)
-     - [PIC18F-Q10 Family Product Page](https://www.microchip.com/design-centers/8-bit/pic-mcus/device-selection/pic18f-q10-product-family) -->
+- [MCC Melody I<sup>2</sup>C Example Component (for the Curiosity Nano Explorer)](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EXAMPLE.COMPONENT&version=latest&redirect=true "MCC Melody I<sup>2</sup>C Example Component for the Curiosity Nano Explorer")
+- [MCC Melody Design Patterns for Control Flow](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EXAMPLE.COMPONENT&version=latest&redirect=true "MCC Melody I<sup>2</sup>C Example Component for the Curiosity Nano Explorer")
+
+- [Curiosity Nano Explorer User Guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/PIC18F57Q43-Curiosity-Nano-HW-UserGuide-DS40002186B.pdf "Curiosity Nano Explorer Users Guide")
+
+- [PIC18F57Q43 Data Sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/DataSheets/PIC18F27-47-57Q43-Data-Sheet-40002147F.pdf "PIC18F57Q43 Data Sheet")
 
 ## Software Used
+- MPLAB® X IDE 6.25.0 or newer [(MPLAB® X IDE 6.25.0)](https://www.microchip.com/en-us/development-tools-tools-and-software/mplab-x-ide)
+- MPLAB® XC8 3.00.0 or newer [(MPLAB® XC8 3.00.0)](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8)
+
+- MPLAB® Code Configurator (MCC) Plug-in Version 5.6 or newer (*Tools>Plugins>Installed*, search: "MCC")
+- MPLAB Data Visualizer Plug-in Version 1.4.1926 or newer (*Tools>Plugins>Installed*, search: "Data Visualizer")
+- MCC Melody I2C_Host Example Component for the Curiosity Nano Explorer 1.0.0 or newer
+- MCC Core 5.8.0 or newer 
+- MCC Melody Core 2.9.0 or newer
 
-<!-- All software used in this example must be listed here. Use unbreakable links!
-     - MPLAB® X IDE 5.30 or newer [(microchip.com/mplab/mplab-x-ide)](http://www.microchip.com/mplab/mplab-x-ide)
-     - MPLAB® XC8 2.10 or a newer compiler [(microchip.com/mplab/compilers)](http://www.microchip.com/mplab/compilers)
-     - MPLAB® Code Configurator (MCC) 3.95.0 or newer [(microchip.com/mplab/mplab-code-configurator)](https://www.microchip.com/mplab/mplab-code-configurator)
-     - MPLAB® Code Configurator (MCC) Device Libraries PIC10 / PIC12 / PIC16 / PIC18 MCUs [(microchip.com/mplab/mplab-code-configurator)](https://www.microchip.com/mplab/mplab-code-configurator)
-     - Microchip PIC18F-Q Series Device Support (1.4.109) or newer [(packs.download.microchip.com/)](https://packs.download.microchip.com/) -->
+Open the MCC Content Manager to verify the MCC Core and MCC Melody Core versions. 
 
-- MPLAB® X IDE 6.25.0 or newer [(MPLAB® X IDE 6.25)](https://www.microchip.com/en-us/development-tools-tools-and-software/mplab-x-ide)
-- MPLAB® XC8 3.0.0 or newer compiler [(MPLAB® XC8 3.0)](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8)
+![alt text](images/MCC_Core_ContentLibrary_Versions_SPA.png)
 
 ## Hardware Used
+- PIC18F57Q43 Curiosity Nano [(DM164150)](https://www.microchip.com/en-us/development-tool/DM164150)
+- Curiosity Nano Explorer [(EV58G97A)](https://www.microchip.com/en-us/development-tool/EV58G97A)
 
-<!-- All hardware used in this example must be listed here. Use unbreakable links!
-     - PIC18F47Q10 Curiosity Nano [(DM182029)](https://www.microchip.com/Developmenttools/ProductDetails/DM182029)
-     - Curiosity Nano Base for Click boards™ [(AC164162)](https://www.microchip.com/Developmenttools/ProductDetails/AC164162)
-     - POT Click board™ [(MIKROE-3402)](https://www.mikroe.com/pot-click) -->
 
 ## Setup
 
-<!-- Explain how to connect hardware and set up software. Depending on complexity, step-by-step instructions and/or tables and/or images can be used -->
+The following outlines the complete MCC Melody configuration, including all the selected tasks that have been implemented in this example.
 
-## Operation
+![alt text](images/pic18f57q43-i2c-proximity-sensor-callbacks-dataStreamer_configurations.png)
 
-<!-- Explain how to operate the example. Depending on complexity, step-by-step instructions and/or tables and/or images can be used -->
+[Data Visualizer Setup](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.DATA.VISUALIZER.SETUP&version=latest&redirect=true) 
+
+To run the example, follow the steps in the Data Visualizer Setup section: 
+
+![Data Visualizer Setup](images/I2C_Host_Example_Data_Visualizer_Setup.png)
+
+- [Data Visualizer Debug GPIO Setup](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EX.DV.DEBUG.IO&version=latest&redirect=true)
+- [Data Visualizer Setup for Data Streamer](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EX.DV.DATA.STREAMER.CONFIG&version=latest&redirect=true) 
 
 ## Summary
+For more example components, follow these steps: 
+
+1) Open the stand-alone Content Manager ![CM_icon](images/Icon-MPLAB-CM24.png) in MPLAB X IDE. 
+2) Filter on Melody content.
+3) Filter on MCU device (optional, leave blank to find all).
+4) Expand Examples category under Content Libraries. 
 
-<!-- Summarize what the example has shown -->
+![Standalone_CM](images/MCC_Melody_Example_Components_CM_Filters.png)