Skip to content

Commit 9d6c027

Browse files
committed
MPAE-19451 updated readme, fixed certain images
1 parent 1160379 commit 9d6c027

File tree

5 files changed

+31
-45
lines changed

5 files changed

+31
-45
lines changed

README.md

Lines changed: 29 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- MPAE-19445 Please do not change this logo with link -->
1+
<!-- MPAE-19451 Please do not change this logo with link -->
22

33
<a target="_blank" href="https://www.microchip.com/" id="top-of-page">
44
<picture>
@@ -14,16 +14,26 @@ The [I<sup>2</sup>C Proximity Sensor example](https://onlinedocs.microchip.com/v
1414
), 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"
1515
), is used here in the Polled implementation, with the Data Streamer visualization.
1616

17-
![alt text](images/pic18f57q43-i2c-proximity-sensor-polled-dvrt_intro.png)
17+
![alt text](images\avr128db48-i2c-proximity-sensor-callbacks-dataStreamer_avrDB_intro.png)
1818

19-
This example demonstrates how to read the value of the VCNL4200 proximity sensor on the Curiosity Nano Explorer, with the DV Run Time Visualization Output selected. Every 100 ms, an LED and a Debug I/O pin are toggled. Depending on the DVRT streaming tick setting (default is 100 ms), the appropriately formatted values of the variables added to the DVRT Streaming Table are sent to the [MPLAB® Data Visualizer](https://www.microchip.com/en-us/tools-resources/debug/mplab-data-visualizer "MPLAB® Data Visualizer").
19+
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.
20+
21+
## Operation
22+
In the MCC Melody Data Streamer library configuration, the appropriately typed variables are added to the Data Streamer table.
23+
24+
![alt text](images/avr128db48-i2c-proximity-sensor-callbacks-datastreamerTable_uartPins.png)
2025

2126
The below image of the MPLAB Data Visualizer shows the application running, where proximityValue and framecount have been added to the DVRT Streaming Table and Time Plot:
22-
![alt text](images/pic18f57q43-i2c-proximity-sensor-polled-dvrt.png)
27+
![alt text](images/avr128db48-i2c-proximity-sensor-polled-dvrt.png)
28+
**Note:** In the HEX terminal output, at the bottom of the image, An individual Data Streamer Frame is highlighted in red. The frame can be identified by the StartByte of 0x03 and the EndByte of 0xFC.
29+
30+
31+
## Setup
32+
The image below outlines the complete MPLAB Code Configurator (MCC) Melody configuration, including all the selected tasks implemented in this example, 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").
2333

24-
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").
34+
![alt text](images\avr128db48-i2c-proximity-sensor-callbacks-dataStreamer_avrDB_configuration.png)
2535

26-
![alt text](images/pic18f57q43-i2c-proximity-sensor-polled-dvrt_builder.png)
36+
![alt text](images\avr128db48-i2c-proximity-sensor-callbacks-dataStreamer_avrDB_configuration_pins.png)
2737

2838
## MCC Melody Example Components
2939
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.
@@ -32,52 +42,28 @@ Example Components are a tight integration of learning material directly into MC
3242
## Related Documentation
3343

3444
- [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")
35-
- [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")
45+
- [MCC Melody Design Patterns for Control Flow](https://onlinedocs.microchip.com/g/GUID-7CE1AEE9-2487-4E7B-B26B-93A577BA154E "MCC Melody Design Patterns for Control Flow")
3646

37-
- [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")
47+
- [Curiosity Nano Explorer User Guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/CNANO-Explorer-UserGuide-DS50003716.pdf "Curiosity Nano Explorer Users Guide")
3848

39-
- [PIC18F57Q43 Data Sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/DataSheets/PIC18F27-47-57Q43-Data-Sheet-40002147F.pdf "PIC18F57Q43 Data Sheet")
49+
- [AVR128DB48 Data Sheet](https://ww1.microchip.com/downloads/en/DeviceDoc/AVR128DB28-32-48-64-DataSheet-DS40002247A.pdf "AVR128DB48 Data Sheet")
4050

4151
## Software Used
42-
- 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)
43-
- 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)
52+
- [MPLAB® X IDE](https://www.microchip.com/en-us/development-tools-tools-and-software/mplab-x-ide) v6.25 or newer
53+
- [MPLAB® XC8](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8) v3.00 or newer
4454

45-
- MPLAB® Code Configurator (MCC) Plug-in Version 5.5.2 or newer (*Tools>Plugins>Installed*, search: "MCC")
46-
- MPLAB Data Visualizer Plug-in Version 1.4.1926 or newer (*Tools>Plugins>Installed*, search: "Data Visualizer")
55+
- [MPLAB® Code Configurator](https://www.microchip.com/en-us/tools-resources/configure/mplab-code-configurator) (MCC) Plug-in Version v5.6.2 or newer (*Tools>Plugins>Installed*, search: "MCC")
56+
- [MPLAB® Data Visualizer](https://www.microchip.com/en-us/tools-resources/debug/mplab-data-visualizer) Plug-in Version v1.4.1926 or newer (*Tools>Plugins>Installed*, search: "Data Visualizer")
4757
- MCC Melody I2C_Host Example Component for the Curiosity Nano Explorer 1.0.0 or newer
48-
- MCC Core 5.7.1 or newer
49-
- MCC Melody Core 2.8.1 or newer
58+
- MCC Core v5.8.2 or newer
59+
- Single Page Application (SPA) Host v1.0.0 or newer
60+
- MCC Melody Core v2.9.1 or newer
5061

51-
Open the MCC Content Manager to verify the MCC Core and MCC Melody Core versions.
62+
Open the MCC Content Manager ![CM_icon](images/Icon-MPLAB-CM24.png) to verify the MCC Core and MCC Melody Core versions.
5263

53-
![alt text](images/MCC_Melody_Core_and_MCC_Core.png)
64+
![alt text](images/MCC_Core_ContentLibrary_Versions_SPA.png)
5465

5566
## Hardware Used
56-
- PIC18F57Q43 Curiosity Nano [(DM164150)](https://www.microchip.com/en-us/development-tool/DM164150)
67+
- AVR128DB48 Curiosity Nano [(EV35L43A)](https://www.microchip.com/en-us/development-tool/EV35L43A)
5768
- Curiosity Nano Explorer [(EV58G97A)](https://www.microchip.com/en-us/development-tool/EV58G97A)
5869

59-
60-
## Setup
61-
62-
The following outlines the complete MCC Melody configuration, including all the selected tasks that have been implemented in this example.
63-
64-
![alt text](images/pic18f57q43-i2c-proximity-sensor-polled-dvrt_configurations.png)
65-
66-
[Data Visualizer Setup](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.DATA.VISUALIZER.SETUP&version=latest&redirect=true)
67-
68-
To run the example, follow the steps in the Data Visualizer Setup section:
69-
70-
![Data Visualizer Setup](images/I2C_Host_Example_Data_Visualizer_Setup.png)
71-
72-
- [Data Visualizer Debug GPIO Setup](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EX.DV.DEBUG.IO&version=latest&redirect=true)
73-
- [Data Visualizer Setup for DV Run Time](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EX.DVRUNTIME.CONFIG&version=latest&redirect=true)
74-
75-
## Summary
76-
For more example components, follow these steps:
77-
78-
1) Open the stand-alone Content Manager ![CM_icon](images/Icon-MPLAB-CM24.png) in MPLAB X IDE.
79-
2) Filter on Melody content.
80-
3) Filter on MCU device (optional, leave blank to find all).
81-
4) Expand Examples category under Content Libraries.
82-
83-
![Standalone_CM](images/MCC_Melody_Example_Components_CM_Filters.png)

0 commit comments

Comments
 (0)