MPAE-16817: updated readme and code

Author: Diana Loles

.main-meta/main.json

@@ -2,29 +2,29 @@
     "metaDataVersion": "1.0.0",
     "category": "com.microchip.ide.project",
     "content": {
-        "metaDataVersion": "1.1.0",
+        "metaDataVersion": "1.3.0",
         "name": "com.microchip.mcu8.mplabx.project.pic16f18446-sensor-board-battery-measurement",
-        "version": "1.0.1",
-        "displayName": "PIC16F18446 Sensor Board Battery Measurement",
+        "version": "2.0.0",
+        "displayName": "Sensor Board Temperature Measurement Using the PIC16F18446 Microcontroller",
         "projectName": "pic16f18446-sensor-board-battery-measurement",
         "shortDescription": "Battery (Vdd) level measurement is performed while the display is turned on. The percentage level of the remaining charge in the batteries is shown as a battery icon with proportional filling in the top-right corner of the display. Additionally, the battery voltage in Volts and percentage graph are displayed.",
         "ide": {
             "name": "MPLAB X",
-            "semverRange": ">=5.30.0"
+            "semverRange": ">=6.15.0"
         },
         "compiler": [
 			{
 				"name": "XC8",
-				"semverRange": "^2.10.0"
+				"semverRange": "^2.45.0"
 			}
 		],
         "dfp": {
             "name": "PIC16F1xxxx_DFP",
-            "semverRange": "^1.2.99"
+            "semverRange": "^1.21.368"
         },
         "configurator": {
             "name": "MCC",
-            "semverRange": ">=3.95.0"
+            "semverRange": ">=5.3.7"
         },
         "device": {
             "metaDataVersion": "1.0.0",
@@ -37,17 +37,14 @@
             }
         },
         "author": "Microchip",
-        "subcategories": [
-            [
-               "Peripherals",
-			   "ADCC"
-            ]
-        ],
         "peripherals": [
-            "ADCC"
+            "ADCC", 
+            "MSSP", 
+            "CLC"
         ],
         "keywords": [
-            "Battery Level"		
+            "LCD", 
+            "Battery Monitoring"		
         ],
 		"additionalData": {
 			"longDescription": {

README.md

@@ -1,56 +1,145 @@
 [![MCHP](images/microchip.png)](https://www.microchip.com)
 
 
-# PIC16F18446 Sensor Board Battery Measurement
+## Sensor Board Battery Measurement Using the PIC16F18446 Microcontroller
 
-The PIC16F184xx family has a new Analog to Digital Converter with Computation (ADCC) with a 12-bit resolution. This project shows how the PIC can internally measure its Vdd using the ADCC and FVR.
+The PIC16F184xx family has a new Analog-to-Digital Converter with Computation (ADCC) with a 12-bit resolution. This project shows how the PIC can internally measure its Vdd using the ADCC and FVR.
 
-In this example we will be using the PIC16F18446 Sensor Board. Battery (Vdd) level measurement is performed while the display is turned on. The percentage level of the remaining charge in the batteries is shown as a battery icon with proportional filing in the top-right corner of the display. Additionally, the battery voltage in Volts and percentage graph are displayed.
+This example showcases the PIC16F18446 Sensor Board. Battery (Vdd) level measurement is performed while the display is turned on. The percentage level of the remaining charge in the batteries is shown as a battery icon with proportional filing in the top-right corner of the display. Additionally, the battery voltage in Volts and percentage graph are displayed.
 
 ## Related Documentation
 - [PIC16F18446 Product Family Page](https://www.microchip.com/design-centers/8-bit/pic-mcus/device-selection/pic16f18446)
 - [PIC16F18446 datasheet](http://ww1.microchip.com/downloads/en/DeviceDoc/40001985B.pdf) for more information or specifications.
 
 
 ## Software Used
-- 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 8-bit AVR MCUs 2.3.0 or newer [(microchip.com/mplab/mplab-code-configurator)](https://www.microchip.com/mplab/mplab-code-configurator)
-- PIC16F1xxxx DFP 1.2.99 or newer Device Pack
+- [MPLAB® X IDE](http://www.microchip.com/mplab/mplab-x-ide) v6.15 or newer
+- [MPLAB® XC8](http://www.microchip.com/mplab/compilers) v2.45 or newer
+- [PIC16F1xxxx_DFP](https://packs.download.microchip.com/) v1.2.99
 
 ## Hardware Used
-- [PIC16F18446 Sensor Board Demonstration](https://www.microchip.com/promo/pic16f18446-sensor-board-demonstration)
+- [PIC16F18446 Sensor Board Quick Start Guide](http://ww1.microchip.com/downloads/en/DeviceDoc/30010172A.pdf)
+  <br><img src="images/PIC16F18446_Sensor_board.PNG" width="800">
 
+## Operation
+
+To program the microcontroller with this MPLAB® X project, follow the steps provided in the [How to Program the Microcontroller](#how-to-program-the-microcontroller) chapter.<br><br>
 
 ## Setup
 
-To get the Vdd voltage, ADCC is used to measure the FVR (which is configured to 1.024V) with Vdd as positive reference. Then the Vdd is calculated using this formula: Vdd = 1.024V * 4096 / ADC_Reading.
+The following configurations must be made for this project:
+
+- Clock Control:
+  - Clock Source: HFINTOSC
+  - HF Internal Clock: 32 MHz
+  - Clock Divider: 1
+
+  <br><img src="images/clock_control.PNG" width="600">
+
+- Configuration bits:
+  - External Oscillator Selection bits: Oscillator disabled
+  - Reset Oscillator Selection bits: HFINTOSC (1 MHz)
+  - WDT Operating Mode bits: WDT Disabled, SWDTEN is ignored
+
+  <br><img src="images/config_bits.jpg" width="600">
+
+- MSSP1 (SPI):
+  - Mode: Host
+  - SPI Mode: SPI Mode 0
+  - Input data sampled at: Middle
+  - Clock source selection: F<sub>OSC</sub>/4
+
+  <br><img src="images/mssp1(spi).PNG" width="600">
+
+- CLC1:
+  - Enable CLC: Yes
+  - Logic Cell mode: AND-OR
+
+  <br><img src="images/CLC1.PNG" width="600">
+  
+- CLC2:
+  - Enable CLC: Yes
+  - Logic Cell mode: AND-OR
+
+  <br><img src="images/CLC2.PNG" width="600">
+
+- FVR:
+  - Enable FVR: Yes
+  - FVR buffer gain to ADC: 1x
+  - FVR buffer gain to other peripherals: 1x
+
+  <br><img src="images/FVR.PNG" width="600">
+
+- ADCC:
+  - Enable ADC: Yes
+  - Operating Mode: Burst Average mode
+  - Result Alignment: Right
+  - Positive Input Channel: ANA0
+  - Positive Reference: V<sub>DD</sub>
+  - Negative Reference: V<sub>SS</sub>
+  - Auto-conversion Trigger: Disabled
+  - Acquisition Count: 0
+  - Clock Source: F<sub>OSC</sub>
+  - Clock Divider: F<sub>OSC</sub>/128
+  - Repeat: 64
+  
+  <br><img src="images/adc_hardware_settings.PNG" width="600"> 
+  <br><img src="images/adc_clock_and_computation_feature.PNG" width="600">
+
+| Pin | Configuration  |        Description        |        Custom Name        |
+| :-: | :------------: | :-----------------------: | :-----------------------: |
+| RC1 |      SCK1      |        Serial Clock       |            SCK1           |        
+| RB4 |      SDI1      |       Serial Data In      |            SDI1           |
+| RC5 |      CLC2      |       Analog output       |           IO_RC5          | 
+| RC6 |      CLC1      |       Analog output       |           IO_RC6          |
+| RB5 |      GPIO      |       Digital input       |             S2            |
+| RC4 |      GPIO      |       Digital input       |             S3            |
+| RB7 |      GPIO      |       Digital output      |         LCD_RESET         |
+| RC2 |      GPIO      |       Digital output      |       LCD_BACKLIGHT       | 
+| RC7 |      GPIO      |       Digital output      |           LCD_CS          |
+
+   <br><img src="images/pin_grid_view.PNG" width="600">
+   <br><img src="images/pins.PNG" width="600">
+
+## Demo
 
-### MCC Settings
+To get the Vdd voltage, ADCC is used to measure the FVR, which is configured to 1.024V, with Vdd as positive reference. Then the Vdd is calculated using this formula: Vdd = 1.024V * 4096 / ADC_Reading.
 
-Here are the settings used for MSSP, CLC, FVR, and ADCC. MSSP + CLC are used for the LCD control.
-### MSSP Settings
-<br><img src="images/MSSP1.png" width="600">
+<br><img src="images/display.png" width="600">
 
-### CCL Settings
-<br><img src="images/CLC1.png" width="600">
+## Summary
 
-<br><img src="images/CLC2.png" width="600">
+This code example shows how to use the Battery level measurement feature on the Sensor Board, using MSSP and CLC for LCD control, FVR and ADCC. 
 
-### FVR Settings
-<br><img src="images/FVR.png" width="600">
+## How to Program the Microcontroller
 
-### ADCC settings
-<br><img src="images/ADCC1.png" width="600">
-ADRPT register is set to 0x40, to average a burst of 64 samples.
-<br><img src="images/ADCC2.png" width="600">
+This chapter demonstrates how to use the MPLAB X IDE to program a PIC® device with an `Example_Project.X`. This applies to other projects.
 
-### PIN Grid
-<br><img src="images/PIN_Grid.png" width="600">
+1.  Connect the Sensor board to the PC.
 
-### PIN Module
-<br><img src="images/PIN_Module.png" width="600">
+2.  Open the `Example_Project.X` project in MPLAB X IDE.
 
-## Demo
-<br><img src="images/display.png" width="600">
+3.  Set the `Example_Project.X` project as main project.
+    <br>Right click the project in the **Projects** tab and then Set as Main Project.
+    <br><img src="images/Program_Set_as_Main_Project.PNG" width="600">
+
+4.  Clean and build the `Example_Project.X` project.
+    <br>Right click the `Example_Project.X` project and select Clean and Build.
+    <br><img src="images/Program_Clean_and_Build.PNG" width="600">
+
+5.  Select Starter Kits (PKOB) in the Connected Hardware Tool section of the project settings:
+    <br>Right click the project and **Properties**.
+    <br>Click the arrow under the Connected Hardware Tool, and from the dropdown, select Starter Kits (PKOB) by clicking the SN.
+    <br>Click **Apply** and then **OK**.
+    <br><img src="images/Program_Tool_Selection.PNG" width="600">
+
+6.  Program the project to the microcontroller.
+    <br>Right click the project and then Make and Program Device.
+    <br><img src="images/Program_Make_and_Program_Device.PNG" width="600">
+
+<br>
+
+- [Back to Top](#sensor-board-battery-measurement-using-the-pic16f18446-microcontroller)
+- [Back to Setup](#setup)
+- [Back to Demo](#demo)
+- [Back to Summary](#summary)