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

Author: Glen-Nilsen

.main-meta/main.json

@@ -4,8 +4,8 @@
     "content": {
         "metaDataVersion": "1.3.0",
         "name": "com.microchip.mcu8.mplabx.project.avr128db48-i2c-io-expander1-leds-callbacks-printf",
-        "version": " ",
-        "displayName": "",
+        "version": "1.0.0",
+        "displayName": "avr128db48-i2c-io-expander1-leds-callbacks-printf",
         "projectName": "avr128db48-i2c-io-expander1-leds-callbacks-printf",
         "shortDescription": "LED chaser increments binary on 6 LEDs every 100 ms. When all on, toggles 8 LEDs every sec. Uses Timer driver callbacks to switch from 100 to 1000 ms. Shows hex/binary of I/O pins via UART printf.",
         "ide": {
@@ -18,13 +18,13 @@
                 "semverRange": "^3.0.0"
             }
         ],
-        "dfp": {
-            "name": "",
-            "semverRange": ""
+         "dfp": {
+            "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

@@ -10,53 +10,61 @@
 
 # AVR128DB48 I2C_Host Example Component for CNano Explorer: I/O Expander 1 LEDs (Callbacks, Printf)
 
-The following is the output for this example. 
-Notice the delta 99.6 ms in the B and the 1.11 s in the C columns, respectively of the time plot. The difference from 100 ms, is simply due to the positioning of the cursor. 
+The [I<sup>2</sup>C Host IO Expander 1 - LEDs Example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EX.RUNNING.I2C.HOST.IOEXPANDER1.LEDS&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 Callbacks implementation, with the Printf visualization. 
+
+![alt text](images\avr128db48-i2c-io-expander1-leds-callbacks-printf_avrDB_intro.png)
+
+The example implements an LED chaser, incrementing the binary number on the lower six LEDs every 100 ms. Once the six active-low LEDs are all on, the pattern changes to toggle all eight LEDs every second.
+
+The callbacks implementation uses the Timer driver. To handle the change from 100 to 1000 ms, the timer period is changed and a new timer callback is used. The hex and binary values of the I/O expander pins are displayed as a printf message over the Universal Asynchronous Receiver and Transmitter (UART).
+
+## 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. 
 
 ![alt text](images/avr128db48-i2c-io-expander1-leds-callbacks-printf_avrDB.png)
+**Note:** the delta 99.6 ms in the B and the 1.11 s in the C columns, respectively of the time plot. The difference from 100 ms, is simply due to the positioning of the cursor. 
 
-The MCC Melody configuration is as shown in the following image. 
+## 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/avr128db48-i2c-io-expander1-leds-callbacks-printf_avrDB_configuration.png)
 
 
 
 <!-- This is where the introduction to the example goes, including mentioning the peripherals used -->
 
-## Related Documentation
 
-<!-- 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) -->
+## 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. 
 
-## Software Used
 
-<!-- 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/) -->
+## Related Documentation
 
-- 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)
+- [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")
 
-## Hardware Used
+- [Curiosity Nano Explorer User Guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/AVR128DB48-Curiosity-Nano-HW-UserGuide-DS40002186B.pdf "Curiosity Nano Explorer Users Guide")
 
-<!-- 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) -->
+- [AVR128DB48 Data Sheet](https://ww1.microchip.com/downloads/en/DeviceDoc/AVR128DB28-32-48-64-DataSheet-DS40002247A.pdf "AVR128DB48 Data Sheet")
 
-## Setup
+## 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
 
-<!-- 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 -->
+- [MPLAB® Code Configurator](https://www.microchip.com/en-us/tools-resources/configure/mplab-code-configurator) (MCC) Plug-in Version 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 Version v1.4.1926 or newer (*Tools>Plugins>Installed*, search: "Data Visualizer")
+- MCC Melody I2C_Host Example Component for the Curiosity Nano Explorer 1.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
 
-## Operation
+Open the MCC Content Manager ![CM_icon](images/Icon-MPLAB-CM24.png) to verify the MCC Core and MCC Melody Core versions. 
 
-<!-- Explain how to operate the example. Depending on complexity, step-by-step instructions and/or tables and/or images can be used -->
+![alt text](images/MCC_Core_ContentLibrary_Versions_SPA.png) 
 
-## Summary
+## Hardware Used
+- AVR128DB48 Curiosity Nano [(EV35L43A)](https://www.microchip.com/en-us/development-tool/EV35L43A)
+- Curiosity Nano Explorer [(EV58G97A)](https://www.microchip.com/en-us/development-tool/EV58G97A)
 
-<!-- Summarize what the example has shown -->

avr128db48-i2c-io-expander1-leds-callbacks-printf.X/avr128db48-i2c-io-expander1-leds-callbacks-printf.mc3

@@ -1,5 +1,5 @@
 /*
-© [2025] Microchip Technology Inc. and its subsidiaries.
+? [2025] 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. 
@@ -25,15 +25,14 @@
  * 
  * @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:           2. I2C IO Expander 1 - LEDs 
  *        Implementation:    Interrupts with callbacks 
  *        Visualization:     Printf   
  *        MCU Device family: AVR
 */
-
 #include "mcc_generated_files/system/system.h"
 #include <util/delay.h>
 
@@ -51,34 +50,38 @@
 #define DATALENGTH                  2
 #define I2C_ERROR_NONE              0
 
+static uint8_t MCP23008_Write(uint8_t address, uint8_t reg, uint8_t data);
+static void to_binary(uint8_t num, char *str);
+static void TIMER_Callback_100ms(void);
+static void TIMER_Callback_1s(void);
+
 // TODO: Replace TimerX with number of Timer chosen as dependency. 
-//       Matches name of const struct TIMER_INTERFACE, from MCC Generated Files > timer > tmrx.c  
-static const struct TIMER_INTERFACE *Timer = &Timer1;  
+//       Matches name of const struct TIMER_INTERFACE, from MCC Generated Files > timer > tcXX.c
+static const struct TIMER_INTERFACE *Timer = &Timer1; 
 
 // TODO: Go to Header Files/MCC Generated Files/timer/tcXX.h - replace xx in TCxx_CLOCK_FREQ, e.g. TCA1_CLOCK_FREQ. ----------------------
-#define MS_TO_TICKS(ms) (((TCA1_CLOCK_FREQ * (ms)) / 1000UL) - 1UL)   
+#define MS_TO_TICKS(ms) (((TCA1_CLOCK_FREQ * (ms)) / 1000UL) - 1UL)
 #define LED_100_MS (MS_TO_TICKS(100UL))           
 #define LED_1000_MS (MS_TO_TICKS(1000UL))
 
-uint8_t errorState = I2C_ERROR_NONE;
-uint8_t *data;
-uint8_t *data_length;
-uint8_t pins = 0; 
-uint8_t pins_inverted = 0; 
-char binaryStr[9]; // 8 bits + null terminator
+static i2c_host_error_t errorState = I2C_ERROR_NONE;
+static uint8_t *data;
+static uint8_t *data_length;
+static uint8_t pins = 0; 
+static uint8_t pins_inverted = 0; 
+static char binaryStr[9]; // 8 bits + null terminator
 static volatile bool incrementLEDs = false;
 static volatile bool updateLEDs = false;
 
-uint8_t MCP23008_write(uint8_t address, uint8_t reg, uint8_t data)
+static uint8_t MCP23008_Write(uint8_t address, uint8_t reg, uint8_t data)
 {
-    uint8_t errorState = I2C_ERROR_NONE;
     size_t txLength = 2;
-    uint8_t txBuffer[2] = {};
+    uint8_t txBuffer[2] = {0};
 
     txBuffer[0] = reg;
     txBuffer[1] = data;
 
-    I2C_Host.Write(MCP23008_1_I2C_ADDRESS, txBuffer, txLength);
+    I2C_Host.Write(address, txBuffer, txLength);
     while (I2C_Host.IsBusy())
     {
     }
@@ -88,27 +91,25 @@ uint8_t MCP23008_write(uint8_t address, uint8_t reg, uint8_t data)
 }
 
 // Function to convert a number to a binary string
-void to_binary(uint8_t num, char *str) 
+static void to_binary(uint8_t num, char *str) 
 {
-    for (int i = 7; i >= 0; i--) {
-        str[7 - i] = (num & (1 << i)) ? '1' : '0';
+    for (uint8_t i = 0U; i < 8U; i++) {
+        str[7U - i] = ((num & (uint8_t)(1U << (7U - i))) != 0U) ? '1' : '0';
     }
     str[8] = '\0'; // Null-terminate the string
 }
 
-void TIMER_Callback_100ms(void)
+static void TIMER_Callback_100ms(void)
 {
     IO_LED_Toggle();
     IO_Debug_Toggle(); 
-    
     incrementLEDs = true; 
 }
 
-void TIMER_Callback_1s(void)
+static void TIMER_Callback_1s(void)
 {
     IO_LED_Toggle();
     IO_Debug_Toggle(); 
-    
     updateLEDs = true;
 }
 
@@ -118,30 +119,31 @@ int main(void)
 
     SYSTEM_Initialize();
     Timer->TimeoutCallbackRegister(TIMER_Callback_100ms);
-    printf("Example: 2. I2C IO Expander 1 - LEDs, Implementation: Interrupts with callbacks, Visualization: Printf\r\n");
-    printf("Note: LEDs assumed to be active LOW \r\n");
+    (int) printf("Example: 2. I2C IO Expander 1 - LEDs, Implementation: Interrupts with callbacks, Visualization: Printf\r\n");
+    (int) printf("MCU Device family: AVR \r\n\r\n");
+    (int) printf("Note: LEDs assumed to be active LOW \r\n");
 
-    errorState = MCP23008_write(MCP23008_1_I2C_ADDRESS, MCP23008_REG_ADDR_IODIR, PINS_DIGITAL_OUTPUT);
+    errorState = MCP23008_Write(MCP23008_1_I2C_ADDRESS, MCP23008_REG_ADDR_IODIR, PINS_DIGITAL_OUTPUT);
 
      while(1)
     {
         if(incrementLEDs)
         {
-            if (pins < 64)
+            if (pins < 64U)
             {
                 pins_inverted = ~(pins << 2); 
-                errorState = MCP23008_write(MCP23008_1_I2C_ADDRESS, MCP23008_REG_ADDR_GPIO, pins_inverted); 
+                errorState = MCP23008_Write(MCP23008_1_I2C_ADDRESS, MCP23008_REG_ADDR_GPIO, pins_inverted); 
 
                 to_binary(pins_inverted, binaryStr);
-                printf("LED state: 0x%02X 0b%s\n", pins_inverted, binaryStr);
+                (int) printf("LED state: 0x%02X 0b%s\n", pins_inverted, binaryStr);
                 pins++;
                 incrementLEDs = false; 
             }
             else
             {
-                printf("\r\n");
-                pins = 0xFF;  // Turn off active LOW LEDs
-                errorState = MCP23008_write(MCP23008_1_I2C_ADDRESS, MCP23008_REG_ADDR_GPIO, pins); 
+                (int) printf("\r\n");
+                pins = (uint8_t) 0xFF;  // Turn off active LOW LEDs
+                errorState = MCP23008_Write(MCP23008_1_I2C_ADDRESS, MCP23008_REG_ADDR_GPIO, pins); 
                 Timer->Stop();
                 Timer->PeriodSet(LED_1000_MS);                      // Change timer period to 1s
                 Timer->TimeoutCallbackRegister(TIMER_Callback_1s);  // Change timer callback
@@ -151,12 +153,12 @@ int main(void)
         }
         if(updateLEDs)
         {
-            errorState = MCP23008_write(MCP23008_1_I2C_ADDRESS, MCP23008_REG_ADDR_GPIO, pins); 
+            errorState = MCP23008_Write(MCP23008_1_I2C_ADDRESS, MCP23008_REG_ADDR_GPIO, pins); 
 
             to_binary(pins, binaryStr);
-            printf("LED state: 0x%02X 0b%s\n", pins_inverted, binaryStr);
+            (int) printf("LED state: 0x%02X 0b%s\n", pins_inverted, binaryStr);
             pins = ~pins;   // Toggle LEDs  
             updateLEDs = false; 
         } 
     }
-}
+}