MPAE-19448 created working project, 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.pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors",
-        "version": " ",
-        "displayName": "",
+        "version": "1.0.0",
+        "displayName": "pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors",
         "projectName": "pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors",
         "shortDescription": "Reads proximity sensor value. With printf   error handling, sends values to MPLAB Data Visualizer every 250 ms. Uses Timer driver callbacks for sampling frequency.",
         "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

@@ -10,42 +10,59 @@
 
 # Update the title for pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors here
 
-<!-- This is where the introduction to the example goes, including mentioning the peripherals used -->
+The [I<sup>2</sup>C Proximity Sensor Example](https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=I2C.HOST.EX.RUNNING.I2C.HOST.FIND.CLIENTS&version=latest&redirect=true "I2C Proximity Sensor 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 with error handling visualization. 
 
-## 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) -->
 
-## Software Used
+![alt text](images/pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors_intro.png)
 
-<!-- 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/) -->
+This example reads the value of the VCNL4200 proximity sensor on the Curiosity Nano Explorer, using the Printf with error handling visualization output. Every 250 ms, an LED and a Debug I/O pin are toggled. An appropriately formatted Printf string is then sent to the [MPLAB® Data Visualizer](https://www.microchip.com/en-us/tools-resources/debug/mplab-data-visualizer "MPLAB® Data Visualizer").  
 
-- 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)
+## Operation
+The below image of the MPLAB Data Visualizer shows the application running, where proximityValue is displayed in a Printf string. Any I<sup>2</sup>C errors would also be displayed. 
 
-## Hardware Used
+When running the application using the MPLAB Data Visualizer, you should see something similar to the following: 
 
-<!-- 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) -->
+![alt text](images/pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors.png)
 
 ## Setup
 
-<!-- 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 -->
+The following outlines the complete MPLAB Code Configuration (MCC) Melody configuration, including all the selected tasks implemented in this example.
+
+![alt text](images\pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors_configuration.png)
+
+![alt text](images\pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors_configuration_pins.png)
 
-## Operation
 
-<!-- Explain how to operate the example. Depending on complexity, step-by-step instructions and/or tables and/or images can be 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. 
 
-## Summary
 
-<!-- Summarize what the example has shown -->
+## Related Documentation
+
+- [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")
+
+- [Curiosity Nano Explorer User Guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/CNANO-Explorer-UserGuide-DS50003716.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
+
+Open the MCC Content Manager ![CM_icon](images/Icon-MPLAB-CM24.png) to verify the MCC Core and MCC Melody Core versions. 
+
+![alt text](images/MCC_Core_ContentLibrary_Versions_SPA.png) 
+
+## 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,33 +25,37 @@
  * 
  * @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:           4. I2C Proximity Sensor 
  *        Implementation:    Interrupts with callbacks 
  *        Visualization:     Printf with error handling   
- *        MCU Device family: PIC18F/18F
+ *        MCU Device family: PIC18
 */
+
 #include "mcc_generated_files/system/system.h"
 
-// TODO: Replace TimerX with name of const struct TIMER_INTERFACE, from MCC Generated Files > timer > {timer_header}X 
-static const struct TIMER_INTERFACE *Timer = &Timer2;    // TODO: Replace TimerX with the timer instance number
-
-uint8_t VCNL4200_Initialize(void);
-uint8_t VCNL4200_ProximityRead(uint16_t* proximityValue);
-void Timer_Callback_250ms(void); 
-const uint8_t* I2CErrorToString(uint8_t error);
 
 // Note:  VCNL4200 - High Sensitivity Long Distance Proximity and Ambient Light Sensor With I2C Interface
 //        Reference to the VCNL4200 data sheet:  https://www.vishay.com/docs/84430/vcnl4200.pdf
 //        The VCNL4200 command codes are located in Table 1 (page 9) of the VCNL4200 data sheet
 #define PROXIMITY_I2C_ADDRESS  ((uint8_t)0x51)
 #define PROXIMITY_REGISTER     ((uint8_t)0x08)
 
-uint16_t proximityValue;           // VCNL4200 sensor result
-uint8_t errorState = I2C_ERROR_NONE;
-volatile bool timerTick = 0;       // volatile because this variable is used inside & outside the ISR.
+uint8_t VCNL4200_Initialize(void);
+uint8_t VCNL4200_ProximityRead(uint16_t* proximityValue);
+void Timer_Callback_250ms(void); 
+const uint8_t* I2CErrorToString(uint8_t error);
+
+// 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 = &Timer2; 
+
+static volatile bool timerTick = false; // volatile because this variable is used inside & outside the ISR.
+static uint16_t proximityValue; // VCNL4200 sensor result
+static volatile uint8_t frameCount; 
+static i2c_host_error_t errorState = I2C_ERROR_NONE;
 
 uint8_t VCNL4200_ProximityRead(uint16_t* proximityValue)
 {
@@ -79,19 +83,26 @@ uint8_t VCNL4200_ProximityRead(uint16_t* proximityValue)
 
 const uint8_t* I2CErrorToString(uint8_t error)
 {
+    const uint8_t* errorString;
     switch (error)
     {
         case I2C_ERROR_NONE:
-            return "I2C_ERROR_NONE";
+            errorString = "I2C_ERROR_NONE";
+            break;
         case I2C_ERROR_ADDR_NACK:
-            return "I2C_ERROR_ADDR_NACK";
+            errorString = "I2C_ERROR_ADDR_NACK";
+            break;
         case I2C_ERROR_DATA_NACK:
-            return "I2C_ERROR_DATA_NACK";
+            errorString = "I2C_ERROR_DATA_NACK";
+            break;
         case I2C_ERROR_BUS_COLLISION:
-            return "I2C_ERROR_BUS_COLLISION";
+            errorString = "I2C_ERROR_BUS_COLLISION";
+            break;
         default:
-            return "UNKNOWN_ERROR";
+            errorString = "UNKNOWN_ERROR";
+            break;
     }
+    return errorString;
 }
 
 uint8_t VCNL4200_Initialize(void)
@@ -115,36 +126,34 @@ uint8_t VCNL4200_Initialize(void)
 
 void Timer_Callback_250ms(void)
 {
-    timerTick = 1; 
+    timerTick = true; 
 }
 
 int main(void)
 {
     __delay_ms(500);  // Prevent program running when programming
-    
     SYSTEM_Initialize();   
     INTERRUPT_GlobalInterruptEnable();
-    printf("Example: 4. I2C Proximity Sensor, Implementation: Interrupts with callbacks, Visualization: Printf with error handling \r\n");
-    printf("MCU Device family: PIC18F/18F \r\n\r\n");
+    (int) printf("Example: 4. I2C Proximity Sensor, Implementation: Interrupts with callbacks, Visualization: Printf with error handling \r\n");
+    (int) printf("MCU Device family: PIC18 \r\n\r\n");
 
     errorState = VCNL4200_Initialize();     // Initializes the proximity sensor (VCNL4200) over the I2C bus
-    printf("I2C proximity sensor initialize status: %d - %s \r\n\r\n", errorState, I2CErrorToString(errorState));
+    (int) printf("I2C proximity sensor initialize status: %d - %s \r\n\r\n", errorState, I2CErrorToString(errorState));
     Timer->TimeoutCallbackRegister(Timer_Callback_250ms);
-    INTERRUPT_GlobalInterruptEnable();
 
     while(1)
     {
-        if(timerTick == 1)
+        if(timerTick == true)
         {
             errorState = VCNL4200_ProximityRead(&proximityValue);
             if (errorState != I2C_ERROR_NONE) 
             {
-                printf("The proximity sensor error is: %d - %s\r\n", errorState, I2CErrorToString(errorState));
+                (int) printf("The proximity sensor error is: %d - %s\r\n", errorState, I2CErrorToString(errorState));
             }
-            printf("The proximityValue is: %d\r\n", proximityValue); 
+            (int) printf("The proximityValue is: %d\r\n", proximityValue); 
             IO_LED_Toggle();
             IO_Debug_Toggle();
-            timerTick = 0;
+            timerTick = false;
         }
     }    
 }

images/MCC_Core_ContentLibrary_Versions_SPA.png

@@ -2,32 +2,32 @@
 
 manifest_file_version: 1.0.0
 project: pic18f57q43-i2c-proximity-sensor-callbacks-printf-errors
-creation_date: 2025-04-03T14:51:17.525+02:00[Europe/Berlin]
+creation_date: 2025-10-23T14:20:26.520+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.b
 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/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/example-i2c-host', type: MELODY, version: 1.0.1}
+- {name: '@mchp-mcc/i2c-host-driver', type: MELODY, version: 1.0.5}
 - {name: '@mchp-mcc/main-manager', type: MELODY, version: 3.1.2}
-- {name: '@mchp-mcc/pic-8bit', type: MELODY, version: 5.29.1-dev.6}
+- {name: '@mchp-mcc/pic-8bit', type: MELODY, version: 5.29.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/pin-content-processor', type: MELODY, version: 3.11.0}
 - {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/scf-pic8-osc-v1', type: MELODY, version: 4.4.0}
-- {name: '@mchp-mcc/scf-pic8-tmr2-v1', type: MELODY, version: 5.1.1-dev.2}
-- {name: '@mchp-mcc/scf-pic8-uart-v1', type: MELODY, version: 7.2.0}
+- {name: '@mchp-mcc/scf-pic8-tmr2-v1', type: MELODY, version: 5.1.1}
+- {name: '@mchp-mcc/scf-pic8-uart-v1', type: MELODY, version: 7.2.1}
 - {name: '@mchp-mcc/timer', type: MELODY, version: 1.2.3}
 - {name: '@mchp-mcc/uart-driver', type: MELODY, version: 1.10.2}