MPAE-18790 - Initial Commit after reset

Author: aku-work

.citd/Jenkinsfilek8s

@@ -0,0 +1,60 @@
+// Jenkinsfile v2.0.0
+
+pipeline {
+    agent {
+        kubernetes {
+
+			defaultContainer 'xc8-mplabx'
+            yamlFile '.citd/cloudprovider.yml'
+        }
+    }
+    parameters {
+        string( name: 'NOTIFICATION_EMAIL',
+                defaultValue: '[email protected]',
+                description: "Email to send build failure and fixed notifications.")
+    }
+	
+	environment {
+		GITHUB_OWNER = 'microchip-pic-avr-examples'	
+		GITHUB_URL ='https://github.com/microchip-pic-avr-examples/pic18f56q24-curiosity-nano-explorer-vcnl4200-ambient-sensor'
+		BITBUCKET_URL = 'https://bitbucket.microchip.com/scm/ebe/pic18f56q24-curiosity-nano-explorer-vcnl4200-ambient-sensor.git'
+		SEMVER_REGEX = '^(0|[1-9]\\d*)+\\.(0|[1-9]\\d*)+\\.(0|[1-9]\\d*)+$'
+		ARTIFACTORY_SERVER = 'https://artifacts.microchip.com:7999/artifactory'
+	}	
+	options {
+		timestamps()
+		timeout(time: 30, unit: 'MINUTES')
+	}
+
+	stages {
+		stage('setup') {
+		    steps {
+				script {
+					execute("git clone https://bitbucket.microchip.com/scm/citd/mpae-buildpipeline-groovy-scripts.git")
+					def buildPipeline = load ('mpae-buildpipeline-groovy-scripts/xc8mplabx-buildpipeline.groovy')
+					buildPipeline.runStages()
+				}
+            }
+		}
+	}
+	
+	post {
+        failure {			
+            script {			
+				sendPipelineFailureEmail()
+            }
+        }	
+	}
+}
+def execute(String cmd) {
+	if(isUnix()) {
+		sh cmd
+	} else {
+		bat cmd
+	}
+}
+def sendPipelineFailureEmail() {			  
+    mail to: "${env.EMAILLIST},${params.NOTIFICATION_EMAIL}",
+    subject: "Failed Pipeline: ${currentBuild.fullDisplayName}",
+    body: "Pipeline failure. ${env.BUILD_URL}"
+}

.citd/cloudprovider.yml

@@ -0,0 +1,18 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: xc8-mplabx
+spec:
+  containers:
+    - name: xc8-mplabx
+      image: artifacts.microchip.com:7999/microchip/citd/bundles/xc8-mplabx:latest
+      imagePullPolicy: Always
+      command: ['cat']
+      tty: true
+      resources:
+        requests:
+          cpu: 0.25
+          memory: 500Mi
+        limits:
+          cpu: 0.5
+          memory: 750Mi

.gitignore

@@ -0,0 +1,6 @@
+# Untracked files in MPLABX projects
+/**/build/*
+/**/nbproject/*
+!/**/nbproject/*.xml
+/**/dist/*
+/**/.generated_files/*

.main-meta/main.json

@@ -0,0 +1,54 @@
+{
+    "metaDataVersion": "1.0.0",
+    "category": "com.microchip.ide.project",
+    "content": {
+        "metaDataVersion": "1.3.0",
+        "name": "com.microchip.mcu8.mplabx.project.pic18f56q24-curiosity-nano-explorer-vcnl4200-ambient-sensor",
+        "version": "1.0.0",
+        "displayName": "pic18f56q24 Light intensity measurement using MCC",
+        "projectName": "pic18f56q24-curiosity-nano-explorer-vcnl4200-ambient-sensor",
+        "shortDescription": "This example will demonstrate how to interface the VCNL4200-Ambient-LightSensor on-board the Curiosity Nano Explorer development board using I2C protocol, and UART to display light intensity values on the terminal.",
+        "ide": {
+            "name": "MPLAB X",
+            "semverRange": ">=6.20.0"
+        },
+        "compiler": [
+            {
+                "name": "XC8",
+                "semverRange": "^3.00.0"
+            }
+        ],
+        "dfp": {
+            "name": "PIC18F-Q_DFP",
+            "semverRange": "^1.24.430"
+        },
+        "configurator": {
+            "name": "MCC",
+            "semverRange": ">=5.5.1"
+        },
+        "device": {
+            "metaDataVersion": "1.0.0",
+            "category": "com.microchip.portal.contentRef",
+            "content": {
+                "metaDataVersion": "1.0.0",
+                "category": "com.microchip.device",
+                "name": "PIC18F56Q24",
+                "versionRange": "*"
+            }
+        },
+        "author": "Shikhar Tandon",
+        "peripherals": ["I2C","UART","TMR0","EIC"],
+        "keywords": ["Lighting","Melody","MCC"],
+        "additionalData": {
+            "longDescription": {
+                "metaDataVersion": "1.0.0",
+                "category": "com.microchip.portal.fileRef",
+                "content": {
+                    "metaDataVersion": "1.0.0",
+                    "fileName": "./README.md",
+                    "mimeType": "text/markdown"
+                }
+            }
+        }
+    }
+}

LICENSE.txt

@@ -0,0 +1,20 @@
+  (c) 2024 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

@@ -0,0 +1,228 @@
+<!-- Please do not change this logo with link -->
+
+<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>
+
+# Interface VCNL4200 Ambient Light Sensor on Curiosity Nano Explorer with PIC18F56Q24 Curiosity Nano Board
+
+This example demonstrates how the VCNL4200 Ambient Light Sensor on the Curiosity Nano Explorer board operates when interfaced with the PIC18F56Q24 microcontroller. The PIC18F56Q24 Curiosity Nano development board (host) communicates with the VCNL4200 Ambient Light Sensor (client) using the I2C protocol. The example application displays the current light intensity (in lux) every second.
+
+## Related Documentation
+
+- [PIC18F26/45/46/55/56Q24 Data Sheet](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/DataSheets/PIC18F26-45-46-55-56Q24-Microcontroller-Data-Sheet-XLP-DS40002503.pdf)
+- [I2C Host Driver](https://onlinedocs.microchip.com/oxy/GUID-420E6AAC-9141-47BF-A4C7-A6EA17246D0D-en-US-23/GUID-9123ED22-5064-448E-AB55-11C967BB20A4.html?hl=i2c%2Chost)
+- [VCNL4200 Data Sheet](https://www.vishay.com/docs/84430/vcnl4200.pdf)
+- [VCNL4200 App Note](https://www.vishay.com/docs/84327/designingvcnl4200.pdf)
+- [Curiosity Nano Explorer board EV58G97A](https://www.microchip.com/en-us/development-tool/EV58G97A?_ga=2.255984587.1527562019.1718650260-1302344245.1675103399)
+- [MPLAB XC8 C Compiler User's Guide for PIC MCU](https://ww1.microchip.com/downloads/en/DeviceDoc/50002737C%20XC8%20C%20Compiler%20UG%20for%20PIC.pdf)
+
+## Software Used
+
+- MPLAB® X IDE 6.20.0 or newer [(MPLAB® X IDE 6.20)](https://www.microchip.com/en-us/development-tools-tools-and-software/mplab-x-ide)
+- MPLAB® XC8 3.00 or newer compiler [(MPLAB® XC8 3.00)](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8)
+- MPLAB® Code Configurator [(MCC Melody)](https://www.microchip.com/en-us/tools-resources/configure/mplab-code-configurator/melody)
+
+## Hardware Used
+
+- [Curiosity Nano Explorer board EV58G97A](https://www.microchip.com/en-us/development-tool/EV58G97A?_ga=2.255984587.1527562019.1718650260-1302344245.1675103399)
+  - [User guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/CNANO-Explorer-UserGuide-DS50003716.pdf)
+  - [Schematics](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/BoardDesignFiles/Curiosity-Nano-Explorer-Schematics.pdf
+  )
+
+- [PIC18F56Q24 Curiosity Nano](https://www.microchip.com/en-us/development-tool/ev01e86a)
+  - [PIC18F56Q24 Curiosity Nano User Guide](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/UserGuides/PIC18F56Q24-CNANO-UserGuide-DS50003618.pdf)
+  - [Schematics](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/BoardDesignFiles/PIC18F56Q24-Curiosity-Nano-Schematics.PDF)
+
+- [PIC18F56Q24 product page](https://www.microchip.com/en-us/product/pic18f56q24)
+
+## Block Diagram
+
+The block diagram shows a brief summary of the high level connection beween the microcontroller and the sensor.<br>
+ - In the [Schematics](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU08/ProductDocuments/BoardDesignFiles/Curiosity-Nano-Explorer-Schematics.pdf
+  ),  a 47 kΩ resistor is connected between the Interrupt pin of the VCNL4200 sensor and VCC.
+ - To achieve the recommended resistance from the [VCNL4200 App Note](https://www.vishay.com/docs/84327/designingvcnl4200.pdf) a 26.5 kΩ resistor is added in parallel, bringing the total resistance down to around 17 kΩ.  
+![Block Diagram](./images/ALS_sensor_block_diagram.png)
+
+###### Figure 1: Block diagram<br><br><br><br>
+
+## Setup
+
+Connect the PIC18F56Q24 Curiosity Nano development board to the host PC using a USB-C cable. Then, insert the Curiosity Nano into the Curiosity Nano socket on the Curiosity Nano Explorer board, as shown in the figure below.<br><br>
+<img src="./images/setup.png" alt="setup.png" width="619" height="561" style="float: left; margin-right: 10px;">
+
+###### Figure 2: Hardware Setup<br><br>
+
+### Pins utilized
+| Pins     |  Function
+|----------|----------
+| PROX_INT    | Interrupt output from the VCNL4200 for proximity or ambient light changes.   
+| RB0   | Digital input pin on PIC18F56Q24,receives interrupts from PROX_INT   
+| 3.3V(from MikroE BUS)   | Provides 3.3V input voltage to the pull-up resitor used(26.5kohm)   
+|GND(from MikroE BUS)       | Ground pin from MikroE BUS
+
+
+Remove the jumper wire on PROX_INT pin and pin 16 to allow the PIC18F56Q24 to receive interrupts from the VCNL4200.<br><br>
+<img src="./images/prox_int_jumper.png" alt="prox_int_jumper.png" width="250" height="150">
+<br><br>Connect the left pin of the PROX_INT 2-pin header to RB0 (pin 30) as shown in the figure below<br><br>
+<img src="./images/prox_int_rb0.png" alt="prox_int_rb0.png" width="220" height="150">
+
+The next three figures illustrate this setup, which represents the hardware implementation of the connections depicted in the block diagram (Figure 1). In this configuration, PROX_INT and RB0 are connected to one terminal of a resistor, while the opposite terminal is connected to the 3.3V supply via a red wire. Additionally, a wire runs from the GND pin to the breadboard. <br><br>
+<img src="./images/setup_1.png" alt="setup_1.png" width="350" height="350">
+
+###### Figure 3: Setup Part - I<br><br><br><br>
+
+![Setup-II](./images/setup_2.png)
+
+###### Figure 4: Setup Part - II<br><br><br><br>
+
+![Setup-II](./images/setup_3.png)
+
+###### Figure 5: Setup Part - III<br><br><br><br>
+
+
+
+1. Open the project 'pic18f56q24-curiosity-nano-explorer-vcnl4200-ambient-sensor' as shown in figure below.<br><br>
+
+![Open Project Window](./images/open_project.png)
+  ###### Figure 6: Open Project Window<br><br>
+
+2. Right click on the Project in the projects tab and click **Properties** to open the Project Properties window. Select the:
+    - Curiosity Nano device from the **Connected Hardware Tool** drop-down menu, as shown in figure. 7
+    - Select the latest tool pack
+    - Select the latest compiler and click **OK**.<br><br>
+
+![Select Tool](./images/select_hw_tool.png)
+###### Figure 7: Select the Hardware Tool in Project Properties Window<br><br>
+
+3. Once the project is open, click the **MCC** button in the top toolbar to open it.
+
+![MCC](./images/mcc_setup.png)
+###### Figure 8: Open MCC<br><br>
+
+##### Clock Control:
+4. Under <u>*Project Resources*</u>><u>*System*</u>><u>*Clock Control*</u>
+
+   - The Clock Driver settings are as in the image below<br><br>
+
+![Clock Driver](./images/Clock_control.png)
+###### Figure 9: Clock Driver
+  - We choose a High-Frequency Internal Oscillator (64 Mhz) with a clock divider of 2
+      <br><br>
+
+##### Timer Setup:
+5. Under <u>*Project Resources*</u>><u>*Drivers*</u>><u>*Select TMR0*</u>
+
+  - The Timer Driver settings are as in the image below.<br><br>
+
+![TMR Driver](./images/TMR0.png)
+###### Figure 10: Timer Driver
+
+  - Settings for Timer
+      1. Timer Mode - 8-bit
+      2. Clock Pre-Scaler - 1:16384
+      3. Postscaler - 1:16
+      4. Clock source - HFINTOSC
+      5. Requested Period - 1s
+      6. TMR interrupt - Enabled
+      7. Callback function Rate - 1
+    <br><br>
+
+##### UART Setup:
+6. Under Project Resources go to Drivers and Select UART
+
+  - The UART Driver settings are as in the image below.
+
+![Uart Driver](./images/UART2.png)
+###### Figure 11: UART Driver
+
+  - Setting for UART:
+      1. Baud rate - 115200
+      2. Parity  - None
+      3. Data Size - 8 bits
+      4. Stop bits - 1
+      5. Flow Control Mode - None
+      6. Interrupt Driven - Yes
+      7. Software Transmit and Receive Buffer Size - 8 bytes
+      8. UART PLIB Selector - UART2
+
+  - RB5 and RB4 are the UART2 TX and RX pins, respectively, as selected below in the pin grid view (in the red circle).
+
+![UART pins](./images/UART2_Pin_Grid_View.png)
+###### Figure 12: UART Pin Grid View<br><br>
+
+##### I2C Setup:
+7. Under Project Resources go to Drivers and Select I2C1_Host
+
+  - The I2C Host Driver settings are as in the image below.
+
+  ![I2C Driver](./images/I2C1_Host.png)
+  ###### Figure 13: I2C Host <br><br>
+
+  - The I2C Peripheral settings are as in the image below.
+
+  ![I2C Peripheral](./images/I2C1_Peripheral.png)
+  ###### Figure 14: I2C Peripheral <br><br>
+
+  - RB1 and RB2 are the SCL and SDA pins for the I2C1 peripheral as selected below in the pin grid view (in the red circle).
+
+  ![I2C pins](./images/I2C1_Pin_Grid_View.png)
+  ###### Figure 15: I2C Pin Grid View
+
+## Operation
+
+1. After configuring the peripherals in the Setup section, click the **Generate** button on the right side panel in **Project Resources** as shown in the figure below.
+
+![Generate button](./images/MCC_generate.png)
+###### Figure 16: MCC Generate Button<br><br>
+
+2. In the right side panel of the **Projects** tab, you will see "MCC Generated Files" in your project folder.
+
+![Project Tree](./images/project_tree.png)
+###### Figure 17: Project Tree<br><br>
+
+3. The code execution starts from the ``main.c`` file.
+
+4. The ``app.c`` file handles the initialization of the Ambient Light Sensor (ALS) and reads the light intensity value by interfacing the PIC18F56Q24 microcontroller with the VCNL Ambient Light Sensor.
+
+5. To compile the project and generate the binaries, go to the Production menu in the menu bar and select "Clean and Build Main Project".<br>
+![Compile](./images/compile.png)
+###### Figure 18: Compile Button<br><br>
+
+6. To flash the binaries on the PIC18F56Q24 click the 'Make and Program Device Main Project' icon in the toolbar.<br>
+![Flash](./images/Flash.png)
+###### Figure 19: Flash Button<br><br>
+
+7. Now, to observe the live temperature readings follow the below steps:
+    - Click the "MPLAB Data Visualizer" icon in the toolbar (Step 1 in Figure 20).
+    - Click the gear icon for the COM port where the PIC MCU is connected to the host PC (Step 2 in Figure 20).
+    - Set the UART settings as shown below (Step 3 in Figure 20).
+
+    ![Data Visualizer](./images/data_visualizer.png)
+    ###### Figure 20: Data Visualizer<br><br>
+
+8. Now Click the **Play** button next to the gear icon in the COM port and click the **Send to Terminal** button in the window that pops up and then click **Close** to close the window.
+
+![Play button](./images/Play.png)
+###### Figure 21: Play Button<br><br>
+
+![Send to terminal](./images/send_to_terminal.png)
+###### Figure 22: Send to Terminal Button<br><br>
+
+9. On the terminal window live light intensity is observed every one second.
+
+![Light readings](./images/light_readings.png)
+###### Figure 23: Light Intensity Readings<br><br>
+
+## Demo
+<p align="left">
+  <img src="images/demo.gif" alt="Description" width="500">
+</p>
+
+## Summary
+
+This demo demonstrates how to configure the peripherals of the PIC18F56Q24, including Clock, Timer, UART, and I2C, to communicate with the VCNL4200 Ambient Light Sensor using the I2C communication protocol. The light intensity values are then displayed on a UART terminal every second.