MPAE-20124: Update code and readme

Author: Gabriel Urs

.main-meta/main.json

@@ -4,7 +4,7 @@
     "content": {
         "metaDataVersion": "1.3.0",
         "name": "com.microchip.mcu8.mplabx.project.pic18f56q71-mtch9010-dynamic-cfg-change",
-        "version": "1.0.1",
+        "version": "1.0.2",
         "displayName": "MTCH9010 Dynamic Configuration Change Using the PIC18F56Q71 Microcontroller with MCC Melody",
         "projectName": "pic18f56q71-mtch9010-dynamic-cfg-change",
         "shortDescription": "This repository contains two MPLAB X projects demonstrating dynamic configuration changes for MTCH9010 using Enhanced Configuration mode or configuration input pins, with the PIC18F56Q71 microcontroller as the host device.",
@@ -24,7 +24,7 @@
         },
         "configurator": {
             "name": "MCC",
-            "semverRange": ">=5.7.1"
+            "semverRange": ">=5.6.2"
         },
         "device": {
             "metaDataVersion": "1.0.0",
@@ -40,12 +40,17 @@
         "peripherals": ["UART",
                         "DAC",
                         "OPA",
+                        "TMR",
                         "GPIO"
                         ],
-        "keywords": ["Capacitive Touch",
-                     "Sensor",
-                     "GPIO",
-                     "MCC Melody"
+        "keywords": [
+                    "MTCH9010",
+                    "Liquid Detection",
+                    "Human Machine Interface",
+                    "Capacitive Touch",
+                    "Sensor",
+                    "GPIO",
+                    "MCC Melody"
     ],
         "additionalData": {
             "longDescription": {

Enhanced_Configuration_Mode/README.md

@@ -1,28 +1,36 @@
 <!-- Please do not change this html logo with link -->
 
-<a href="https://www.microchip.com" rel="nofollow"><img src="images/microchip.png" alt="MCHP" width="300"/></a>
+<a target="_blank" href="https://www.microchip.com/" id="top-of-page">
+   <picture>
+      <source media="(prefers-color-scheme: light)" srcset="images/mchp_logo_light.png" width="350">
+      <source media="(prefers-color-scheme: dark)" srcset="images/mchp_logo_dark.png" width="350">
+      <img alt="Microchip Technologies Inc." src="https://www.microchip.com/content/experience-fragments/mchp/en_us/site/header/master/_jcr_content/root/responsivegrid/header/logo.coreimg.100.300.png/1605828081463/microchip.png">
+   </picture>
+</a>
 
 # MTCH9010 Dynamic Enhanced Configuration Change Using the PIC18F56Q71 Microcontroller with MCC Melody
 
 This MPLAB® X project shows how to dynamically change the configuration for MTCH9010 using the Enhanced Configuration mode. The PIC18F56Q71 microcontroller is used as a host device and the configuration is realized using the Universal Asynchronous Receiver Transmitter (UART) peripheral.
 
 ## Related Documentation
 - [MTCH9010 Product Page](https://www.microchip.com/en-us/product/MTCH9010?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08)
+- [MTCH9010 Data Sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/DataSheets/MTCH9010-DataSheet-DS40002635.pdf)
+- [MTCH9010 Code Examples on GitHub](https://github.com/microchip-pic-avr-examples/?q=MTCH9010)
+- [MTCH9010 Resources on MPLAB Discover](https://mplab-discover.microchip.com/v2?dsl=MTCH9010)
 - [PIC18F56Q71 Product Page](https://www.microchip.com/en-us/product/PIC18F56Q71?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08)
-- [PIC18F56Q71 Code Examples on Discover](https://mplab-discover.microchip.com/v2?dsl=PIC18F56Q71)
 - [PIC18F56Q71 Code Examples on GitHub](https://github.com/microchip-pic-avr-examples/?q=PIC18F56Q71)
+- [PIC18F56Q71 Resources on MPLAB Discover](https://mplab-discover.microchip.com/v2?dsl=PIC18F56Q71)
 
 ## Software Used
-- [MPLAB X IDE v6.25 or newer](https://www.microchip.com/en-us/tools-resources/develop/mplab-x-ide?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08)
-- [MPLAB® XC8 v3.00 or newer](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08)
-- [PIC18F-Q_DFP 1.28.451 or newer](https://packs.download.microchip.com/)
+- [MPLAB X IDE v6.25](https://www.microchip.com/en-us/tools-resources/develop/mplab-x-ide?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08)  or newer
+- [MPLAB® XC8 v3.00](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08)  or newer
+- [PIC18F-Q_DFP 1.28.451](https://packs.download.microchip.com/) or newer
 
 ## Hardware Used
-
-- The [PIC18F56Q71 Curiosity Nano Development board](https://www.microchip.com/en-us/development-tool/EV01G21A?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08) is used as a test platform:
-    <br><img src="images/pic18f56q71-curiosity-nano-board.png" width="600">
 - [MTCH9010](https://www.microchip.com/en-us/product/MTCH9010?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08)
-    <br><img src="images/mtch9010.png" width="600">
+    <br><img src="images/mtch9010.png" width="400">
+- [PIC18F56Q71 Curiosity Nano Development board](https://www.microchip.com/en-us/development-tool/EV01G21A?utm_source=GitHub&utm_medium=TextLink&utm_campaign=MCU8_PIC18-Q71&utm_content=pic18f56q71-mtch9010-dynamic-cfg-change-github&utm_bu=MCU08)
+    <br><img src="images/pic18f56q71-curiosity-nano-board.png" width="600">
 
 ## Operation
 
@@ -33,15 +41,14 @@ To program the Curiosity Nano board with this MPLAB X project, follow the steps
 In Enhanced Configuration mode, the MTCH9010 device can be configured using the UART communication protocol. To enter in this configuration mode, the following settings should be done on the MTCH9010 configuration pins:
 - The SYS_LK pin should be set to high (disabled)
 - The CFG_EN pin should be set to low (enabled)
-- The UART_EN pin should be set to low (enabled)
 
 A Reset of the device is needed after the pins are configured to enter the configuration mode. This can be done using the RESET pin by making it low for a period of time (10 ms are used in this example) and then restore it to high.
 
 After the Reset operation, the device will send the firmware version on the serial port and then wait for the configuration commands. Each command sent should be followed by a validation key (with the ASCII code equal to 0x0D in hexadecimal system). After a command is sent, the device will respond with ACK (Acknowledge, 0x06 in hexadecimal system) or NAK (Negative Acknowledge, 0x15 in hexadecimal system) followed by the validation key. If a NAK signal is received, the command must be sent again until it is validated by the device with an ACK signal.
 
-In this code example, the `MTCH9010.h` and `MTCH9010.c` files contains the implementation of the functions used to configure the device in Enhanced Configuration mode. The `mtch9010_config_t` structure is used to simply define the parameters of the configuration that need to be sent.  The `MTCH9010_Config(mtch9010_config_t configData)` function can be used to configure the device. This function sets the pins for configuration mode, reset the device and then send the configuration parameters using the UART1 peripheral. The function also implements a mechanism that verifies if each command is validated by the ACK signal. If it is validated, the program continues with the next command in the same way. If it is not validated, the program repeats the transmission. Each command is repeated for a maximum number of five times. After that the function returns an error code and the program blocks in an infinite loop. A message about the error code is also displayed on serial port using the UART2 peripheral.
+In this code example, the `MTCH9010.h` and `MTCH9010.c` files contains the implementation of the functions used to configure the device in Enhanced Configuration mode. The `mtch9010_config_t` structure is used to simply define the parameters of the configuration that need to be sent. The `MTCH9010_Config(mtch9010_config_t configData)` function can be used to configure the device. This function sets the pins for configuration mode, reset the device and then send the configuration parameters using the UART1 peripheral. The function also implements a mechanism that verifies if each command is validated by the ACK signal. If it is validated, the program continues with the next command in the same way. If it is not validated, the program repeats the transmission. Each command is repeated for a maximum number of five times. After that the function returns an error code and the program blocks in an infinite loop. A message about the error code is also displayed on serial port using the UART2 peripheral.
 
-This example contains two configurations of the MTCH9010. The user can switch between configurations using the on-board button of the PIC18F56Q71 Curiosity Nano. An Interrupt-on-Change (IOC) is generated on the negative edge of the button input. After the interrupt occurs, a debouncing mechanism is implemented using a software delay. The state of the button is verified in the main loop after a 10 ms delay to determine if the pressed state is maintained. The parameters of the two configurations are shown below:
+This example contains two configurations of the MTCH9010. The user can switch between configurations using the on-board button of the PIC18F56Q71 Curiosity Nano. An Interrupt-on-Change (IOC) is generated on the negative edge of the button input. After the interrupt occurs, a debouncing mechanism is implemented using TMR0 peripheral. The button state is verified after a 20ms delay, triggered by the TMR0 overflow interrupt, to ensure that the pressed state is maintained. The parameters of the two configurations are shown below:
 - Configuration 1:
     - SYS_LK: Enabled
 	- CFG_EN: Disabled
@@ -98,10 +105,18 @@ The following peripheral and clock configurations are set up using the MPLAB Cod
     - Enable UART: Enabled
     <br><img src="images/mcc-uart2-plib.png" width="600">
 
-6. Pin Grid View
+6. TMR0
+    - Timer Enable: Disabled
+    - Clock Source: LFINTOSC
+    - Prescaler: 1:4
+    - Requested Period: 20ms
+    - TMR Interrupt Enable: Enabled
+    <br><img src="images/mcc-tmr0.png" width="600">
+
+7. Pin Grid View
     <br><img src="images/mcc-pin-grid.png" width="600">
 
-7. Pins
+8. Pins
     <br><img src="images/mcc-pins.png" width="600"> 
 
 The following pins are used to control MTCH9010:
@@ -114,7 +129,6 @@ The following pins are used to control MTCH9010:
 | RD1 | Digital output |     MTCH9010 RESET pin       |    RESET    |
 | RD2 | Digital output |     MTCH9010 CFG_EN pin      |    CFG_EN   |
 | RD3 | Digital output |     MTCH9010 SYS_LK pin      |    SYS_LK   |
-| RD4 | Digital output |     MTCH9010 UART_EN pin     |   UART_EN   |
 
 ## Demo