Skip to content

Commit d0926ad

Browse files
committed
MPAE-18170 fixing readme comments from MCU8_TEJ-1518
1 parent d54c4f6 commit d0926ad

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
</picture>
77
</a>
88

9-
## Video Building this Example
9+
## Video Building This Example
1010

1111
[![Video Building this Example](images/Video-TimerToggleLED-Callbacks.png "Change the values of these settings until the needed Requested Period is between the indicated min., max values.")](https://youtu.be/yPfu0OuIhqY)
1212

@@ -16,28 +16,28 @@
1616
# MCC Melody Timer Toggle LED Example - Callbacks Implementation (PIC18F57Q43)
1717

1818
The [TIMER Toggle LED example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES.RUNNING.TIMER.PIC16F18F.TOGGLE.LED&version=latest&redirect=true
19-
), of the MCC Melody Timer Example Component, is used in the **Callbacks implementation**. The LED on the PIC18F57Q43 Curiosity Nano is toggled, as well as a Debug I/O, which can be used to verify the 100 ms period.
19+
), of the MCC Melody Timer Example Component is used in the **Callbacks implementation**. The LED on the PIC18F57Q43 Curiosity Nano is toggled, as well as a Debug I/O, which can be used to verify the 100 ms period.
2020

2121
## MCC Melody Example Components
22-
Example Components are a tight integration of learning material directly into MCC. This allows users to conveniently place configuration instructions side-by-side to the components they are configuring. For more information, refer to the [MCC Melody Example Components Introduction](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES&version=latest&redirect=true).
22+
Example Components are tightly integrated learning material directly into MCC. This allows users to conveniently place configuration instructions side-by-side with the components they are configuring. For more information, refer to the [MCC Melody Example Components Introduction](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES&version=latest&redirect=true).
2323

2424

2525
![MCC Melody Example Components](images/GUID-ADDC2E58-F16C-46BD-A42F-D8FF02459622-high_12cm.png)
2626

2727

28-
Complete projects, available in [MPLAB® Discover](https://mplab-discover.microchip.com) or GitHub, are specific to a board and microcontroller. However, the current project could be recreated on a range of supported microcontrollers by following the steps in the example component.
28+
Complete projects specific to a board and microcontroller are available in [MPLAB® Discover](https://mplab-discover.microchip.com) or GitHub. However, the current project could be recreated on a range of supported microcontrollers by following the steps in the example component.
2929

30-
To explore what an example component is, as well as the difference between example and implementation, see [MCC Melody Example Components - The Basics](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES.BASICS&version=latest&redirect=true).
30+
For more information on example components and differences between example and implementation, see [MCC Melody Example Components - The Basics](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES.BASICS&version=latest&redirect=true).
3131

32-
Example Components are related to [MCC Melody Design Patterns for Control Flow](https://onlinedocs.microchip.com/g/GUID-7CE1AEE9-2487-4E7B-B26B-93A577BA154E), which shows different standard ways to organize main.c and other application-level files, such as Polling, Interrupt and Callback, or State Machine Design Patterns. Users mights be familiar with each of these patterns, but...
32+
Example Components are related to [MCC Melody Design Patterns for Control Flow](https://onlinedocs.microchip.com/g/GUID-7CE1AEE9-2487-4E7B-B26B-93A577BA154E), which shows different standard ways to organize `main.c` and other application-level files, such as Polling, Interrupt and Callback, or State Machine Design Patterns. Users might be familiar with each of these patterns, but:
3333
- What support does MCC Melody provide for each?
3434
- What are the recommended ways of building on the MCC Melody generated code? 
3535

3636
## Software Used
3737
- MPLAB® X IDE 6.20.0 or newer [(MPLAB® X IDE 6.20)](https://www.microchip.com/en-us/development-tools-tools-and-software/mplab-x-ide)
3838
- MPLAB® XC8 2.46.0 or newer [(MPLAB® XC8 2.46)](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8)
3939

40-
- MCC Plugin Version 5.5.1 or newer (Tools > Plugins > Installed, search: "MCC")
40+
- MCC Plug-in Version 5.5.1 or newer (Tools > Plugins > Installed, search: "MCC")
4141
- Timer Example Component 1.0.0 or newer
4242
- MCC Core 5.7.1 or newer
4343
- MCC Melody Core 2.7.1 or newer (Communicates with the MCC core, providing views and other functionality for MCC Melody)
@@ -48,16 +48,16 @@ Example Components are related to [MCC Melody Design Patterns for Control Flow](
4848
## Hardware Used
4949

5050
- PIC18F57Q43 Curiosity Nano [(DM164150)](https://www.microchip.com/en-us/development-tool/DM164150)
51-
- Curiosity Nano Explorer [(EV58G97A)](https://www.microchip.com/en-us/development-tool/EV58G97A) - Not used in this example, but used futher in the series.
51+
- Curiosity Nano Explorer [(EV58G97A)](https://www.microchip.com/en-us/development-tool/EV58G97A) - Not used in this example, but used further in the series.
5252

5353
## Setup
5454

55-
All instructions required to recreate this example are listed below, under Configuration Instructions.
55+
All instructions required to recreate this example are listed below under Configuration Instructions.
5656

5757
![TIMER Toggle LED, Polled Implementation](images/TIMER_Toggle_LED_Callbacks.png)
5858

5959
Once you have loaded the project in MPLAB X IDE, you will also be able to find more information from Tooltips and links next to the instructions
60-
[![Tooltip and link](images/info-circle-fill.png "Change the values of these settings until the needed Requested Period is between the indicated min., max values.")](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.CONFIGHELP.TIMER.PERIOD&version=latest&redirect=true) .
60+
[![Tooltip and link](images/info-circle-fill.png "Change the values of these settings until the needed Requested Period is between the indicated min., max values.")](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.CONFIGHELP.TIMER.PERIOD&version=latest&redirect=true).
6161

6262

6363
![Tooltips and context help](images/HardwareSettings_RequestedPeriod.png)
@@ -66,7 +66,7 @@ Once you have loaded the project in MPLAB X IDE, you will also be able to find m
6666
## Operation
6767

6868
The image below shows the [TIMER Toggle LED example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES.RUNNING.TIMER.PIC16F18F.TOGGLE.LED&version=latest&redirect=true
69-
) running. The period of 100 ms is verified using Debug GPIO on the MPLAB Data Visualizer. A PIC18F57Q43 Curiosity Nano is used.
69+
) running. The period of 100 ms is verified using Debug GPIO on the MPLAB® Data Visualizer. A PIC18F57Q43 Curiosity Nano is used.
7070

7171
**Note:** Achieve the same functionality by adding the Timer Example component to a new or existing MCC Melody project, for one of the supported microcontrollers.
7272

@@ -77,12 +77,12 @@ Two vertical cursors are added to verify the timer frequency. See the configurat
7777

7878
1) Click the ![Data Visualizer icon](images/Icon-MPLAB-DataVisualizer_1cm.png) icon to open the MPLAB Data Visualizer.
7979
2) Under Debug GPIO, click the ![Add to time plot icon](images/Icon-DataVisualizer_TimePlot.png "Display as raw data on time plot.") icon, to add to the time plot.
80-
3) Click the ![Data Visualizer Zoom in icon](images/Icon-DataVisualizer_ZoomIn.png) icon, a few times, to zoom in on the Time Plot.
81-
4) Click the ![Data Visualizer Vertical Cursor icon](images/Icon-DataVisualizer_VerticalCursor.png) icon, a couple of times, to add two vertical cursors. Change the cursor positions by dragging them using the mouse, to measure the timer period.
80+
3) Click the ![Data Visualizer Zoom in icon](images/Icon-DataVisualizer_ZoomIn.png) icon a few times to zoom in on the Time Plot.
81+
4) Click the ![Data Visualizer Vertical Cursor icon](images/Icon-DataVisualizer_VerticalCursor.png) icon, a couple of times, to add two vertical cursors. Change the cursor positions by dragging them using the mouse to measure the timer period.
8282

8383
![DataVisualizer config Timer Toggle LED](images/DataVisualizerConfigTimerToggle_LED_15cm.png)
8484

85-
A logic analyzer can be used instead of Debug GPIO on the MPLAB Data Visualizer.
85+
A logic analyzer can be used instead of Debug GPIO on the MPLAB® Data Visualizer.
8686

8787
## Summary
8888
For more example components, open the stand-alone Content Manager ![CM_icon](images/CM_icon.png) in MCC .

0 commit comments

Comments
 (0)