MPAE-19438 project working, readme and main-meta updated

Author: Glen-Nilsen

.main-meta/main.json

@@ -4,8 +4,8 @@
     "content": {
         "metaDataVersion": "1.3.0",
         "name": "com.microchip.mcu8.mplabx.project.pic18f57q43-i2c-io-expander2-leds-and-buttons-polled-printf",
-        "version": " ",
-        "displayName": "",
+        "version": "1.0.0",
+        "displayName": "pic18f57q43-i2c-io-expander2-leds-and-buttons-polled-printf",
         "projectName": "pic18f57q43-i2c-io-expander2-leds-and-buttons-polled-printf",
         "shortDescription": "I/O Expander 1 pins (8 LEDs) set as outputs, low (LEDs on). I/O Expander 2 pins (SW1-3, 5 joystick inputs) as digital inputs. Button/joystick turns LED off. Curiosity Nano SW resets LEDs on.",
         "ide": {
@@ -19,12 +19,12 @@
             }
         ],
         "dfp": {
-            "name": "",
-            "semverRange": ""
+            "name": "PIC18F-Q_DFP",
+            "semverRange": "^3.0.0"
         },
         "configurator": {
-            "name": "",
-            "semverRange": ""
+            "name": "MCC",
+            "semverRange": "^5.6.2"
         },
         "device": {
             "metaDataVersion": "1.0.0",
@@ -37,8 +37,23 @@
             }
         },
         "author": "Glen Nilsen",
-        "peripherals": [],
-        "keywords": [],
+        "peripherals": [
+            "I2C",
+            "GPIO",
+            "UART"
+        ],
+        "keywords": [
+            "Data Visualizer",
+            "MPLAB Data Visualizer",
+            "I2C",
+            "UART",
+            "Getting Started",
+            "Melody",
+            "MCC Melody",
+            "Curiosity Nano Explorer",
+            "Example Components",
+            "MCC Melody Example Components"
+        ],
         "additionalData": {
             "longDescription": {
                 "metaDataVersion": "1.0.0",

README.md

@@ -8,52 +8,61 @@
    </picture>
 </a>
 
-# PIC18F57Q43 I2C_Host Example Component for CNano Explorer: I/O Expander 2 LEDs and BUTTONs (Polled, Printf)
+# PIC18F57Q43 I2C_Host Example Component for CNano Explorer: IO Expander 2 - LEDs and Buttons Example (Polled, Printf)
 
-When running this example using the MPLAB Data Visualizer, the following is what the output will look like. 
+The [I<sup>2</sup>C Host IO Expander 2 - LEDs and Buttons Example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EX.RUNNING.I2C.HOST.IOEXPANDER2.LEDS.BUTTONS&version=latest&redirect=true "I2C Host IO Expander 1 - LEDs Example"
+), of the [MCC Melody I<sup>2</sup>C Example Component (for the Curiosity Nano Explorer)](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EXAMPLE.COMPONENT&version=latest&redirect=true "MCC Melody I<sup>2</sup>C Example Component for the Curiosity Nano Explorer"
+), is used here in the Polled implementation with the Printf visualization. 
 
-![alt text](images/pic18f57q43-i2c-io-expander2-leds-and-buttons-polled-printf.png)
+![alt text](images/pic18f57q43-i2c-io-expander2-leds-buttons-polled-printf_intro.png)
 
-This is the required MCC Melody Configuration to achieve this result. 
+On the Curiosity Nano Explorer, the pins on the I<sup>2</sup>C I/O Expander 1 are connected to active-low LEDs, while the pins on the I<sup>2</sup>C I/O Expander 2 are connected to buttons (SW1, SW2 and SW3) as well as the joystick inputs (left, right, up, down, press).
 
-![alt text](images/pic18f57q43-i2c-io-expander2-leds-and-buttons-polled-printf_configuration.png)
+This example configures the I/O Expander 1 pins as outputs set LOW, so the active-low LEDs are initially all turned on. The I/O Expander 2 pins are configured as digital inputs. As a button press or joystick input is detected, the associated LED is turned off. The Curiosity Nano's SW is configured as a reset, turning on all the LEDs again.  
 
-<!-- This is where the introduction to the example goes, including mentioning the peripherals used -->
+## Operation
+When running the application using the [MPLAB® Data Visualizer](https://www.microchip.com/en-us/tools-resources/debug/mplab-data-visualizer "MPLAB® Data Visualizer"), you should see something similar to the following: 
 
-## Related Documentation
+![alt text](images/pic18f57q43-i2c-io-expander2-leds-polled-printf.png)
 
-<!-- Any information about an application note or tech brief can be linked here. Use unbreakable links!
-     In addition a link to the device family landing page and relevant peripheral pages as well:
-     - [AN3381 - Brushless DC Fan Speed Control Using Temperature Input and Tachometer Feedback](https://microchip.com/00003381/)
-     - [PIC18F-Q10 Family Product Page](https://www.microchip.com/design-centers/8-bit/pic-mcus/device-selection/pic18f-q10-product-family) -->
+**Note:** Behaviour is not as reliable as in the Callbacks version. 
 
-## Software Used
+**Note:** Debug I/O is not actively used. However, since the SW pin on the Curiosity Nano is a Debug I/O pin, so when pushing the IO_Reset, a toggle is picked up on the Debug I/O pin. 
 
-<!-- All software used in this example must be listed here. Use unbreakable links!
-     - 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 PIC10 / PIC12 / PIC16 / PIC18 MCUs [(microchip.com/mplab/mplab-code-configurator)](https://www.microchip.com/mplab/mplab-code-configurator)
-     - Microchip PIC18F-Q Series Device Support (1.4.109) or newer [(packs.download.microchip.com/)](https://packs.download.microchip.com/) -->
+## Setup
+The image below outlines the complete MPLAB Code Configurator (MCC) Melody configuration, including all the selected tasks implemented in this example, as seen in the MCC Melody Builder.
+![alt text](images/pic18f57q43-i2c-io-expander2-leds-buttons-polled-printf_configuration.png)
 
-- MPLAB® X IDE 6.25.0 or newer [(MPLAB® X IDE 6.25)](https://www.microchip.com/en-us/development-tools-tools-and-software/mplab-x-ide)
-- MPLAB® XC8 3.0.0 or newer compiler [(MPLAB® XC8 3.0)](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8)
+![alt text](images/pic18f57q43-i2c-io-expander2-leds-buttons-polled-printf_pins_configuration.png)
 
-## Hardware Used
+## MCC Melody Example Components
+Example Components are a tight integration of learning material directly into MCC. This allows users to conveniently place the configuration instructions side-by-side to the components they are configuring. For more information, refer to the [MCC Melody Example Components](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.EXAMPLES&version=latest&redirect=true) introduction. 
 
-<!-- All hardware used in this example must be listed here. Use unbreakable links!
-     - PIC18F47Q10 Curiosity Nano [(DM182029)](https://www.microchip.com/Developmenttools/ProductDetails/DM182029)
-     - Curiosity Nano Base for Click boards™ [(AC164162)](https://www.microchip.com/Developmenttools/ProductDetails/AC164162)
-     - POT Click board™ [(MIKROE-3402)](https://www.mikroe.com/pot-click) -->
 
-## Setup
+## Related Documentation
 
-<!-- Explain how to connect hardware and set up software. Depending on complexity, step-by-step instructions and/or tables and/or images can be used -->
+- [MCC Melody I<sup>2</sup>C Example Component (for the Curiosity Nano Explorer)](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EXAMPLE.COMPONENT&version=latest&redirect=true "MCC Melody I<sup>2</sup>C Example Component for the Curiosity Nano Explorer")
+- [MCC Melody Design Patterns for Control Flow](https://onlinedocs.microchip.com/g/GUID-7CE1AEE9-2487-4E7B-B26B-93A577BA154E "MCC Melody Design Patterns for Control Flow")
 
-## Operation
+- [Curiosity Nano Explorer User Guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/PIC18F57Q43-Curiosity-Nano-HW-UserGuide-DS40002186B.pdf "Curiosity Nano Explorer Users Guide")
+
+- [PIC18F57Q43 Data Sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/DataSheets/PIC18F27-47-57Q43-Data-Sheet-40002147F.pdf "PIC18F57Q43 Data Sheet")
+
+## Software Used
+- [MPLAB® X IDE](https://www.microchip.com/en-us/development-tools-tools-and-software/mplab-x-ide) v6.25 or newer 
+- [MPLAB® XC8](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8) v3.00 or newer
+
+- [MPLAB® Code Configurator](https://www.microchip.com/en-us/tools-resources/configure/mplab-code-configurator) (MCC) Plug-in v5.6.2 or newer (*Tools>Plugins>Installed*, search: "MCC")
+- [MPLAB® Data Visualizer](https://www.microchip.com/en-us/tools-resources/debug/mplab-data-visualizer) Plug-in v1.4.1926 or newer (*Tools>Plugins>Installed*, search: "Data Visualizer")
+- MCC Melody I2C_Host Example Component for the Curiosity Nano Explorer v1.0.0 or newer
+- MCC Core v5.8.2 or newer 
+- Single Page Application (SPA) Host v1.0.0 or newer
+- MCC Melody Core v2.9.1 or newer
 
-<!-- Explain how to operate the example. Depending on complexity, step-by-step instructions and/or tables and/or images can be used -->
+Open the MCC Content Manager ![CM_icon](images/Icon-MPLAB-CM24.png) to verify the MCC Core and MCC Melody Core versions. 
 
-## Summary
+![alt text](images/MCC_Core_ContentLibrary_Versions_SPA.png) 
 
-<!-- Summarize what the example has shown -->
+## Hardware Used
+- PIC18F57Q43 Curiosity Nano [(DM164150)](https://www.microchip.com/en-us/development-tool/DM164150)
+- Curiosity Nano Explorer [(EV58G97A)](https://www.microchip.com/en-us/development-tool/EV58G97A)

images/Icon-MPLAB-CM24.png

@@ -25,13 +25,13 @@
  * 
  * @ingroup i2c_host example
  * 
- * @version I2C_HOST EXAMPLE Example Version 1.0.0
+ * @version I2C_HOST EXAMPLE Example Version 1.0.1
  *
  * @brief Generated file for
  *        Example:           3. I2C IO Expander 2 - LEDs and Buttons 
  *        Implementation:    Polled 
  *        Visualization:     Printf   
- *        MCU Device family: PIC18F/18F
+ *        MCU Device family: PIC18
 */
 
 #include "mcc_generated_files/system/system.h"
@@ -58,16 +58,16 @@
 #define MCP23008_OLAT       0x0A
 
 extern void DELAY_milliseconds(uint16_t milliseconds);  
-uint8_t MCP23008_Read(uint8_t i2c_address, uint8_t reg, uint8_t* data);
-uint8_t MCP23008_Write(uint8_t i2c_address, uint8_t reg, uint8_t data);
-void printButtonPressed(int pressedButton);
-void button_led_control(void);
+static uint8_t MCP23008_Read(uint8_t i2c_address, uint8_t reg, uint8_t* data);
+static uint8_t MCP23008_Write(uint8_t i2c_address, uint8_t reg, uint8_t data);
+static void printButtonPressed(int pressedButton);
+static void button_led_control(void);
 
 static volatile bool resetFlag = false; 
 // All joystick pins re-mapped as they are not connected to Curiosity Nano GPIO by default
 static const char* buttonLabels[8] = {"J-UP", "J-LEFT", "J-DOWN", "J-RIGHT", "J-PUSH", "SW3", "SW2", "SW1"};
 
-uint8_t MCP23008_Read(uint8_t i2c_address, uint8_t reg, uint8_t* data)
+static uint8_t MCP23008_Read(uint8_t i2c_address, uint8_t reg, uint8_t* data)
 {
     i2c_host_error_t errorState = I2C_ERROR_NONE;
     size_t txLength = 1;
@@ -79,6 +79,10 @@ uint8_t MCP23008_Read(uint8_t i2c_address, uint8_t reg, uint8_t* data)
     uint8_t waitCounter = 100;
     if(I2C_Host.WriteRead((uint16_t)(i2c_address), txBuffer, txLength, data, rxLength))
     {   
+        while(!I2C_Host.IsBusy())
+        {
+            //Wait here until I2C bus can start transmitting
+        }
         while (I2C_Host.IsBusy() && (waitCounter > 0U)) 
         {
             I2C_Host.Tasks();
@@ -91,7 +95,7 @@ uint8_t MCP23008_Read(uint8_t i2c_address, uint8_t reg, uint8_t* data)
 }
 
 
-uint8_t MCP23008_Write(uint8_t i2c_address, uint8_t reg, uint8_t data)
+static uint8_t MCP23008_Write(uint8_t i2c_address, uint8_t reg, uint8_t data)
 {
     i2c_host_error_t errorState = I2C_ERROR_NONE;
     size_t txLength = 2;
@@ -103,6 +107,10 @@ uint8_t MCP23008_Write(uint8_t i2c_address, uint8_t reg, uint8_t data)
     uint8_t waitCounter = 100;
     if(I2C_Host.Write((uint16_t)i2c_address, txBuffer, txLength))
     {   
+        while(!I2C_Host.IsBusy())
+        {
+            //Wait here until I2C bus can start transmitting
+        }
         while (I2C_Host.IsBusy() && (waitCounter > 0U)) 
         {
             I2C_Host.Tasks();
@@ -114,15 +122,15 @@ uint8_t MCP23008_Write(uint8_t i2c_address, uint8_t reg, uint8_t data)
     return errorState;
 }
 
-void printButtonPressed(int pressedButton) {
-    if (pressedButton >= 0 && pressedButton < 8) {
+static void printButtonPressed(int pressedButton) {
+    if ((pressedButton >= 0) && (pressedButton < 8)) {
         (int) printf("Button pressed: %s\n", buttonLabels[pressedButton]);
     } else {
         (int) printf("Invalid button pressed\n");
     }
 }
 
-void button_led_control(void)
+static void button_led_control(void)
 {      
     uint8_t mcp23008_1_activeLEDs = 0;
     uint8_t mcp23008_2_previousInputs = 0;
@@ -170,7 +178,7 @@ int main(void)
     DELAY_milliseconds(200); // Prevent program running when programming
     SYSTEM_Initialize();    
     (int) printf("Example: 3. I2C IO Expander 2 - LEDs and Buttons, Implementation: Polled, Visualization: Printf \r\n");
-    (int) printf("MCU Device family: PIC18F/18F \r\n");
+    (int) printf("MCU Device family: PIC18 \r\n\r\n");
     (int) printf("Press Curiosity Nano Explorer touch buttons and use Joystick to turn off all LEDS. Press SW0 on Curiosity Nano to exit. \r\n");
     button_led_control();     
 

images/MCC_Core_ContentLibrary_Versions_SPA.png

@@ -2,31 +2,35 @@
 
 manifest_file_version: 1.0.0
 project: pic18f57q43-i2c-io-expander2-leds-and-buttons-polled-printf
-creation_date: 2025-04-14T11:20:52.416+02:00[Europe/Berlin]
+creation_date: 2025-10-17T12:15:58.144+02:00[Europe/Berlin]
 operating_system: Windows 11
 mcc_mode: IDE
 mcc_mode_version: v6.25
 device_name: PIC18F57Q43
 compiler: XC8 3.00
-mcc_version: 5.5.2
-mcc_core_version: 5.7.1
-content_manager_version: 5.0.1
+mcc_version: 5.6.2
+mcc_core_version: 5.8.2
+content_manager_version: 6.0.3-rc.a
 is_mcc_offline: false
-is_using_prerelease_versions: true
-mcc_content_registries: https://registry.npmjs.org/,https://artifacts.microchip.com/artifactory/api/npm/npm/
-device_library: {library_class: com.microchip.mcc.melody.Library, name: Melody, version: 2.8.1}
-packs: {name: PIC18F-Q_DFP, version: 1.28.451}
+is_using_prerelease_versions: false
+mcc_content_registries: https://registry.npmjs.org/
+device_library: {library_class: com.microchip.mcc.melody.Library, name: Melody, version: 2.10.0}
+packs: {name: N/A, version: N/A}
 modules:
+- {name: '@mchp-mcc/i2c-host-driver', type: MELODY, version: 1.0.5}
+- {name: '@mchp-mcc/pic18-pin-manager', type: MELODY, version: 3.7.1}
 - {name: '@mchp-mcc/delay-blocking-driver', type: MELODY, version: 3.2.0}
-- {name: '@mchp-mcc/example-i2c-host', type: MELODY, version: 1.0.0}
-- {name: '@mchp-mcc/i2c-host-driver', type: MELODY, version: 1.1.0-dev.1}
-- {name: '@mchp-mcc/main-manager', type: MELODY, version: 3.1.2}
-- {name: '@mchp-mcc/pic-8bit', type: MELODY, version: 5.29.2-dev.1}
 - {name: '@mchp-mcc/pic18-configuration-bits-v1', type: MELODY, version: 5.3.5}
-- {name: '@mchp-mcc/pic18-pin-manager', type: MELODY, version: 3.7.1}
-- {name: '@mchp-mcc/pin-content-processor', type: MELODY, version: 3.9.1-feat.6}
-- {name: '@mchp-mcc/scf-pic8-i2c-v1', type: MELODY, version: 6.1.4}
-- {name: '@mchp-mcc/scf-pic8-interrupt-v1', type: MELODY, version: 5.2.11}
+- {name: '@mchp-mcc/example-i2c-host', type: MELODY, version: 1.0.1}
 - {name: '@mchp-mcc/scf-pic8-osc-v1', type: MELODY, version: 4.4.0}
-- {name: '@mchp-mcc/scf-pic8-uart-v1', type: MELODY, version: 7.2.0}
+- {name: '@mchp-mcc/main-manager', type: MELODY, version: 3.1.2}
 - {name: '@mchp-mcc/uart-driver', type: MELODY, version: 1.10.2}
+- {name: '@mchp-mcc/scf-pic8-interrupt-v1', type: MELODY, version: 5.2.11}
+- {name: '@mchp-mcc/scf-pic8-uart-v1', type: MELODY, version: 7.2.1}
+- {name: '@mchp-mcc/pin-content-processor', type: MELODY, version: 3.11.0}
+- {name: '@mchp-mcc/pic-8bit', type: MELODY, version: 5.29.1}
+- {name: '@mchp-mcc/scf-pic8-i2c-v1', type: MELODY, version: 6.1.4}
+- {name: '@mchp-mcc/melody', type: CLASSIC, version: 2.10.0}
+- {name: '@mchp-mcc/pic-8bit', type: MELODY, version: 5.29.1}
+- {name: '@mchp-mcc/i2c-host-driver', type: MELODY, version: 1.0.5}
+- {name: '@mchp-mcc/scf-pic8-uart-v1', type: MELODY, version: 7.2.1}