Skip to content

Commit 3458216

Browse files
MPAE-15914: updates after tech editor review.
1 parent e12e13d commit 3458216

File tree

1 file changed

+27
-28
lines changed

1 file changed

+27
-28
lines changed

README.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,40 @@
22

33
# Analog-to-Digital Converter with Computation (ADCC) and Context Switching — Differential Reading Using PIC18F56Q71 Microcontroller with MCC Melody
44

5-
This code example demonstrates how to perform a differential coversion using the Analog-to-Digital Coverter with Computation (ADCC) and Context Switching and visualize the voltage difference of two input channels using the Data Visualizer tool. The application starts with the initialization of the ADCC with Context Switching and UART peripherals, and then a conversion is performed every 10 ms. The conversion result is sent via serial communication using the UART peripheral in the Data Visualizer format, in which a real-time plot is displayed.
5+
This code example demonstrates how to perform a differential coversion using the Analog-to-Digital Converter with Computation (ADCC) and Context Switching and visualize the voltage difference of two input channels using the Data Visualizer tool. The application starts with the initialization of the ADCC with Context Switching and Universal Asynchronous Receiver Transmitter (UART) peripherals, and then a conversion is performed every 10 ms. The conversion result is sent via serial communication using the UART peripheral in the Data Visualizer format, in which a real-time plot is displayed.
66

77
## Related Documentation
88

9-
More details and code examples on the PIC18F56Q71 can be found at the following links:
9+
More details and code examples for the PIC18F56Q71 can be found at the following links:
1010

1111
- [PIC18F56Q71 Product Page](https://www.microchip.com/en-us/product/PIC18F56Q71)
1212
- [PIC18F56Q71 Code Examples on GitHub](https://github.com/orgs/microchip-pic-avr-examples/repositories?q=pic18f56q71&type=all&language=&sort=)
1313

1414
## Software Used
1515

1616
- [MPLAB® X IDE](http://www.microchip.com/mplab/mplab-x-ide) v6.10 or newer
17-
- [MPLAB® XC8](http://www.microchip.com/mplab/compilers) v2.41 or newer
17+
- [MPLAB XC8](http://www.microchip.com/mplab/compilers) v2.41 or newer
1818
- [PIC18F-Q Series Device Pack](https://packs.download.microchip.com/) v1.18.389 or newer
19-
- [MPLAB® Code Configurator](https://www.microchip.com/en-us/tools-resources/configure/mplab-code-configurator) v5.3.7 or newer
20-
- [MPLAB® Code Configurator Melody](https://www.microchip.com/en-us/tools-resources/configure/mplab-code-configurator/melody) v2.5.0 or newer
19+
- [MPLAB Code Configurator](https://www.microchip.com/en-us/tools-resources/configure/mplab-code-configurator) v5.3.7 or newer
20+
- [MPLAB Code Configurator Melody](https://www.microchip.com/en-us/tools-resources/configure/mplab-code-configurator/melody) v2.5.0 or newer
2121
- PIC10/PIC12/PIC16/PIC18 Devices Library v5.17.1 or newer
2222

2323
## Hardware Used
2424

25-
- The [PIC18F56Q71 Curiosity Nano Development Board](https://www.microchip.com/en-us/development-tool/EV01G21A) is used as a test platform:
25+
- The [PIC18F56Q71 Curiosity Nano Development board](https://www.microchip.com/en-us/development-tool/EV01G21A) is used as a test platform:
2626
<br><img src="images/pic18f56q71-curiosity-nano-board.png">
2727

2828
- [Curiosity Nano Adapter](https://www.microchip.com/en-us/development-tool/AC164162):
2929
<br><img src="images/Curiosity-Nano-Adapter.jpg" height="400">
3030

31-
- POT 3 CLICK Board:
31+
- POT 3 Click board™:
3232
<br><img src="images/pot-3-click-board.jpg" height="400">
3333

3434
<br>
3535

3636
## Operation
3737

38-
To program the Curiosity Nano board with this MPLAB® X project, follow the steps provided in the [How to Program the Curiosity Nano Board](#how-to-program-the-curiosity-nano-board) chapter.<br><br>
38+
To program the Curiosity Nano board with this MPLAB X project, follow the steps provided in the [How to Program the Curiosity Nano Board](#how-to-program-the-curiosity-nano-board) chapter.<br><br>
3939

4040
## Setup
4141

@@ -72,23 +72,23 @@ The following configurations must be made for this project:
7272

7373
## Demo
7474

75-
In this example, the ADC reads data from the two potentiometers and displays the result on the serial terminal.
75+
In this example, the Analog-to-Digital Converter (ADC) reads data from the two potentiometers and displays the result on the serial terminal.
7676

7777
<br><img src="images/potentiometer_cnano.png" width="300">
7878

7979
To visualize the ADCC with Content Switching readings in a graphical format use the Data Visualizer time plot.
8080

8181
Follow the procedure below to open the Graph/Time plot in Data Visualizer:
8282

83-
- Open the Data Visualizer tool, available as a plugin in MPLAB® X IDE
83+
- Open the Data Visualizer tool, available as a plugin in MPLAB X IDE
8484

85-
- Click on **Connections** > **Serial Ports**
85+
- Click on **_Connections_** > **_Serial Ports_**
8686

87-
- Open the COMx Settings window corresponding to the port that your device is connected to. Set the Baud Rate to **115200**.
87+
- Open the COMx Settings window corresponding to the port that your device is connected to. Set the Baud Rate to 115200.
8888

8989
- Click **Play** to start streaming
9090

91-
- Click **Variable Streamer** > **New...**
91+
- Click **_Variable Streamers_**>**_New..._**
9292

9393
- Add new variables as shown in the image below and click **Save**
9494
<br><img src="images/New Variable Streamer.jpg">
@@ -101,34 +101,28 @@ Follow the procedure below to open the Graph/Time plot in Data Visualizer:
101101
This method determines if the result is positive or negative.
102102

103103
**Note**: The COM port number can differ depending on the port availability.
104-
<br>
105-
106-
## Summary
107-
108-
This code example shows how to configure the ADCC with Context Switching using the MPLAB® Code Configurator and demonstrates the use of the peripheral by sending the result via the UART interface and plotting it with Data Visualizer.
109104
<br><br>
110-
[Back to Top](#analog-to-digital-converter-with-computation-adcc-and-context-switching--differential-reading-using-pic18f56q71-microcontroller-with-mcc-melody)
111105

112106
## How to Program the Curiosity Nano Board
113107

114-
This chapter demonstrates how to use the MPLAB® X IDE to program a PIC® device with an Example_Project.X. This is applicable to other projects.
108+
This chapter demonstrates how to use the MPLAB X IDE to program a PIC® device with an ``Example_Project.X``. This is applicable to other projects.
115109

116110
1. Connect the board to the PC.
117111

118-
2. Open the Example_Project.X project in MPLAB® X IDE.
112+
2. Open the ``Example_Project.X`` project in MPLAB X IDE.
119113

120-
3. Set the Example_Project.X project as main project.
121-
<br>Right click the project in the **Projects** tab and click **Set as Main Project**.
114+
3. Set the ``Example_Project.X`` project as main project.
115+
<br>Right click the project in the **Projects** tab and click Set as Main Project.
122116
<br><img src="images/Program_Set_as_Main_Project.PNG" width="600">
123117

124-
4. Clean and build the Example_Project.X project.
125-
<br>Right click the **Example_Project.X** project and select **Clean and Build**.
118+
4. Clean and build the ``Example_Project.X`` project.
119+
<br>Right click the ``Example_Project.X`` project and select Clean and Build.
126120
<br><img src="images/Program_Clean_and_Build.PNG" width="600">
127121

128-
5. Select **PICxxxxx Curiosity Nano** in the Connected Hardware Tool section of the project settings:
129-
<br>Right click the project and click **Properties**.
122+
5. Select PICxxxxx Curiosity Nano in the Connected Hardware Tool section of the project settings:
123+
<br>Right click the project and click Properties.
130124
<br>Click the arrow under the Connected Hardware Tool.
131-
<br>Select **PICxxxxx Curiosity Nano** (click the **SN**), click **Apply** and then click **OK**:
125+
<br>Select PICxxxxx Curiosity Nano (click the SN), click **Apply** and then **OK**:
132126
<br><img src="images/Program_Tool_Selection.PNG" width="600">
133127

134128
6. Program the project to the board.
@@ -137,6 +131,11 @@ This chapter demonstrates how to use the MPLAB® X IDE to program a PIC® device
137131

138132
<br>
139133

134+
## Summary
135+
136+
This code example shows how to configure the ADCC with Context Switching using the MPLAB Code Configurator and demonstrates the use of the peripheral by sending the result via the UART interface and plotting it with Data Visualizer.
137+
<br><br>
138+
140139
- [Back to Setup](#setup)
141140
- [Back to Demo](#demo)
142141
- [Back to Summary](#summary)

0 commit comments

Comments
 (0)