MPAE-11426 repo update

Author: mariusnicolae

.main-meta/main.json

@@ -5,7 +5,7 @@
         "metaDataVersion": "1.1.0",
         "name": "com.microchip.mcu8.mplabx.project.pic16f18446-sensor-board-battery-measurement",
         "version": "1.0.1",
-        "displayName": "Sensor Board Battery Measurement",
+        "displayName": "PIC16F18446 Sensor Board Battery Measurement",
         "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": {
@@ -39,14 +39,15 @@
         "author": "Microchip",
         "subcategories": [
             [
-               "Peripherals", "ADCC"
+               "Peripherals",
+			   "ADCC"
             ]
         ],
         "peripherals": [
             "ADCC"
         ],
         "keywords": [
-            "Battery level"		
+            "Battery Level"		
         ],
 		"additionalData": {
 			"longDescription": {

LICENSE.txt

@@ -0,0 +1,20 @@
+  (c) 2021 Microchip Technology Inc. and its subsidiaries.
+
+  Subject to your compliance with these terms, you may use Microchip software
+  and any derivatives exclusively with Microchip products. You're responsible
+  for complying with 3rd party license terms applicable to your use of 3rd
+  party software (including open source software) that may accompany Microchip
+  software.
+
+  SOFTWARE IS "AS IS." NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY,
+  APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,
+  MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
+
+  IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
+  INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
+  WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP
+  HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO
+  THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL
+  CLAIMS RELATED TO THE SOFTWARE WILL NOT EXCEED AMOUNT OF FEES, IF ANY,
+  YOU PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
+  

README.md

@@ -1,38 +1,56 @@
-<div id="readme" class="Box-body readme blob js-code-block-container">
-  <article class="markdown-body entry-content p-3 p-md-6" itemprop="text"><p><a href="https://www.microchip.com" rel="nofollow"><img src="https://camo.githubusercontent.com/5fb5505f69a28ff407841612dfe2b7004f210594/68747470733a2f2f636c6475702e636f6d2f553071684c7742696a462e706e67" alt="MCHP" data-canonical-src="https://cldup.com/U0qhLwBijF.png" style="max-width:100%;"></a></p>
+[![MCHP](images/microchip.png)](https://www.microchip.com)
 
 
-# Introduction
+# PIC16F18446 Sensor Board Battery Measurement
+
 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.
 
-# Description
 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.
 
-![Battery Measurement](image/display.png)
+## 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
+
+## Hardware Used
+- [PIC16F18446 Sensor Board Demonstration](https://www.microchip.com/promo/pic16f18446-sensor-board-demonstration)
+
+
+## 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.
 
-# MCC Settings
+### MCC Settings
 
 Here are the settings used for MSSP, CLC, FVR, and ADCC. MSSP + CLC are used for the LCD control.
 ### MSSP Settings
-![MSSP Settings](image/MSSP1.png)
+<br><img src="images/MSSP1.png" width="600">
 
 ### CCL Settings
-![CCL1 Settings](image/CLC1.png)
+<br><img src="images/CLC1.png" width="600">
 
-![CCL2 Settings](image/CLC2.png)
+<br><img src="images/CLC2.png" width="600">
 
 ### FVR Settings
-![FVR Settings](image/FVR.png)
+<br><img src="images/FVR.png" width="600">
 
 ### ADCC settings
-![ADCC Settings](image/ADCC1.png)
+<br><img src="images/ADCC1.png" width="600">
 ADRPT register is set to 0x40, to average a burst of 64 samples.
-![ADCC Registers](image/ADCC2.png)
+<br><img src="images/ADCC2.png" width="600">
 
 ### PIN Grid
-![PIN Grid](image/PIN_Grid.png)
+<br><img src="images/PIN_Grid.png" width="600">
 
 ### PIN Module
-![PIN Module](image/PIN_Module.png)
+<br><img src="images/PIN_Module.png" width="600">
+
+## Demo
+<br><img src="images/display.png" width="600">