Merge pull request #3 in MCU16CE/pic24f-lcd-usb-curiosity-lcd-power from develop to master

* commit 'fce61fd151025b300eb0c7518538da4ae834c935':
  Updated the board image and board link
  removed additionalData from main.json
  Call to SYSTEM_Initialize blowing away RTCC time. Call needed to initialize the SPI and associated pins so the TC77 can shutdown properly.
  fixing issue if starting in battery mode.  Microchip and BoE not printed.
  USB mode working.
  Updated code
  Project updated
  Removed BSL entry from MC3 file
  Removed unwanted pin configurations
  Updated the project using MCC Generated files
  Addressed review comments
  Repo setup
  pic24f-lcd-usb-curiosity-lcd-power repository initial setup

Author: harishagari

.citd/Jenkinsfilek8s

@@ -0,0 +1,262 @@
+pipeline {
+    agent {
+        kubernetes {
+            label 'github_deployment'
+			defaultContainer 'xc16-mplabx-sonar-fmpp-python'
+            yamlFile '.citd/cloudprovider.yml'
+        }
+    }
+   
+
+	environment {
+	    NOTIFICATION_EMAIL = '[email protected]'	
+		//Branch to be deployed, if multiple branches use comma separated string
+		//This is the BitBucket source repo URL to be deployed
+		BITBUCKET_SOURCE_URL = 'https://bitbucket.microchip.com/scm/mcu16ce/pic24f-lcd-usb-curiosity-lcd-power.git'
+		BITBUCKET_CREDENTIAL_ID = 'BITBUCKET_INTERNAL_TOKEN'
+		GITHUB_PRODUCTION_DEPLOY_URL ='https://github.com/microchip-pic-avr-examples'
+		GITHUB_TEST_DEPLOY_URL ='https://github.com/mchpTestArea'
+		//Selects the deployment URL(production or test) based on the merge target branch, selects "microchip-pic-avr-examples" if target branch is "master" , if target branch is "test_deploy" selects "mchpTestArea" else null
+		GITHUB_URL = getGitHubUrl("${GITHUB_PRODUCTION_DEPLOY_URL}","${GITHUB_TEST_DEPLOY_URL}")
+		GITHUB_PRODUCTION_DEPLOY_CREDENTIAL_ID ='GITHUB_MICROCHIP_PIC_AVR_EXAMPLES_TOKEN'
+		GITHUB_TEST_DEPLOY_CREDENTIAL_ID ='GITHUB_PIC_AVR_TEST_TOKEN'
+		//Gets the Github credential id based on the deployment organization
+	    GITHUB_CREDENTIAL_ID = getGitHubCredentialId("${GITHUB_URL}","${GITHUB_PRODUCTION_DEPLOY_URL}","${GITHUB_TEST_DEPLOY_URL}","${GITHUB_PRODUCTION_DEPLOY_CREDENTIAL_ID}","${GITHUB_TEST_DEPLOY_CREDENTIAL_ID}")
+		//Files or folders to be excluded from deployment, if multiple files or folders use comma separator
+		DEPLOY_EXCLUDE_FOLDER_FILE_LIST = 'mchp_private'
+		//Branch(s) to be deployed, if multiple branches use comma separator. ${env.BRANCH_NAME} is the target branch of the PR.
+		DEPLOY_BRANCH_LIST = "${env.BRANCH_NAME}"
+		CHANGE_LOG_PATH = 'changelog.md'
+		SOURCE_PROJECT_META_DATA = '.main-meta/main.json'
+		DEPLOY_TOOL_URL = 'https://bitbucket.microchip.com/scm/citd/tool-github-deploy.git'
+	}
+
+    options {
+        timestamps()
+        timeout(time: 20, unit: 'MINUTES')
+    }
+
+    stages {
+
+        stage('Checkout') {
+            steps {
+                checkout scm
+            }
+        }
+
+        stage('Build') {
+            steps {
+                script {
+                   execute("git clone https://bitbucket.microchip.com/scm/citd/tool-mplabx-c-build.git")
+                   execute("cd ./tool-mplabx-c-build && node buildLauncher.js sp=../ rp=./output genMK=true")
+               }
+            }
+        }
+	   
+	    // Cloning the tool used for GitHub deployment
+	   	stage('GitHub tool clone'){
+			when {
+                    anyOf {
+                        allOf {
+                            not { changeRequest() }
+                            anyOf {branch 'master'; branch 'test_deploy';}
+                        }
+                    }
+            }
+            steps{
+               script{
+                    execute("git clone https://bitbucket.microchip.com/scm/citd/tool-github-deploy.git")
+                    execute("chmod +x ./tool-github-deploy/tool-github-deploy/tool-github-deploy.py")                    
+                }
+            }
+        } 
+		
+		// Creating tag in Bitbucket repo
+	   	stage('Bitbucket Tag Creation'){
+			when {
+                    anyOf {
+                        allOf {
+                            not { changeRequest() }
+                            anyOf {branch 'master';}
+                        }
+                    }
+            }
+            steps{
+               script{
+                    def jsonObj = readJsonObject();
+                    
+                    withCredentials([usernamePassword(credentialsId: "${env.BITBUCKET_CREDENTIAL_ID}", passwordVariable: 'PASS', usernameVariable: 'USER_NAME')]) {
+                        execute("python tool-github-deploy/tool-github-deploy/tool-github-deploy.py -bto=true -rpn=\"${jsonObj.content.projectName}\" -bid=$USER_NAME -bpat=$PASS -bpn=MCU16CE -btv=\"${jsonObj.content.version}\" -bch=${env.GIT_COMMIT} -btd=\"${jsonObj.content.version}\"")
+                    }
+                }
+            }
+        }
+		
+	    // GitHub repo creation 
+	    stage('GitHub Repo Creation'){
+			when {
+                    anyOf {
+                        allOf {
+                            not { changeRequest() }
+                            anyOf {branch 'master'; branch 'test_deploy';}
+                        }
+                    }
+            }
+            steps{
+                script{
+                    def jsonObj = readJsonObject();
+                    
+                    String [] topics = jsonObj.content.keywords
+                    def asString = topics.join(", ")
+					Boolean visibility =  true
+					if(env.GITHUB_URL == env.GITHUB_PRODUCTION_DEPLOY_URL)
+					{
+					   visibility = false
+					}
+                    
+                    withCredentials([usernamePassword(credentialsId: "${env.GITHUB_CREDENTIAL_ID}", passwordVariable: 'PASS', usernameVariable: 'USER_NAME')]) {
+                        execute("python tool-github-deploy/tool-github-deploy/tool-github-deploy.py -rpo=true -gpat=$PASS -rporg=${env.GITHUB_URL} -rpn=${jsonObj.content.projectName} -rpd=\"${jsonObj.content.shortDescription}\" -rpt=\"${asString}\" -rpp=${visibility}")
+                    }
+                }
+            }
+        } 
+	
+	    // Deploying the code to GitHub 
+		stage('GitHub Deploy Source'){
+			when {
+                    anyOf {
+                        allOf {
+                            not { changeRequest() }
+                            anyOf {branch 'master'; branch 'test_deploy';}
+                        }
+                    }
+            }
+            steps{
+                script{
+                    def jsonObj = readJsonObject();
+                    def gitHubUrl = "${env.GITHUB_URL}" + "/" + jsonObj.content.projectName
+                    gitHubUrl = gitHubUrl.replace(" ", "").replace("\n", "")
+                    
+                    withCredentials([usernamePassword(credentialsId: "${env.GITHUB_CREDENTIAL_ID}", passwordVariable: 'PASS', usernameVariable: 'USER_NAME')]) {
+                        execute("python tool-github-deploy/tool-github-deploy/tool-github-deploy.py -deploy=true -gpat=$PASS -dgid=$USER_NAME -dburl=${env.BITBUCKET_SOURCE_URL} -dgurl=${gitHubUrl}  -dbranch=${env.DEPLOY_BRANCH_LIST} -def=${env.DEPLOY_EXCLUDE_FOLDER_FILE_LIST}")
+                    }
+                }
+            }
+        }
+		
+		// Creating GitHub release  
+		stage('GitHub release'){
+			when {
+                    anyOf {
+                        allOf {
+                            not { changeRequest() }
+                            anyOf {branch 'master'; branch 'test_deploy';}
+                        }
+                    }
+            }
+            steps{
+               script{
+                    def jsonObj = readJsonObject();
+                    
+                    withCredentials([usernamePassword(credentialsId: "${env.GITHUB_CREDENTIAL_ID}", passwordVariable: 'PASS', usernameVariable: 'USER_NAME')]) {
+                        execute("python tool-github-deploy/tool-github-deploy/tool-github-deploy.py -rlo=true -gpat=$PASS -rporg=${env.GITHUB_URL} -rpn=\"${jsonObj.content.projectName}\" -rltv=\"${jsonObj.content.version}\" -rltt=\"${jsonObj.content.version}\" -rlnp=${env.CHANGE_LOG_PATH}")
+                    }
+                }
+            }
+        }
+		
+		//Deploying the Github content to portal
+		stage('Portal-Deploy') {
+			when {
+				allOf {
+                    not { changeRequest() }
+                    anyOf {branch 'master';}
+                }
+			}
+			steps {
+				script {
+					def jsonObj = readJsonObject();			
+					def version = jsonObj.content.version
+					def project = jsonObj.content.projectName
+					
+                    String[] splitPreTag = "${env.GITHUB_URL}".split("/")
+                    def gitHubOrg = (splitPreTag[splitPreTag.size() - 1])
+
+					def cmdArgs = "'{\"repoOwnerName\":\"$gitHubOrg\",\"repoName\":\"$project\",\"tagName\":\"$version\"}'"
+					cmdArgs = cmdArgs.replaceAll("\"","\\\\\"")						
+					
+					execute("git clone https://bitbucket.microchip.com/scm/portal/bundles.git")
+					execute("cd bundles && chmod 755 ./portal-client-cli-linux")
+					execute("git clone https://bitbucket.microchip.com/scm/citd/tool-portal-client-launcher.git")
+					execute("cd tool-portal-client-launcher && node portalLauncher.js -app=../bundles/portal-client-cli-linux -cmd=\"uploadGitHub ${cmdArgs}\"")
+				}
+			}
+		}
+        
+      }
+
+    post {
+        success{
+            script {
+                if (!"${env.CHANGE_AUTHOR_EMAIL}".equalsIgnoreCase("null")) {
+				    archiveArtifacts artifacts: "tool-mplabx-c-build/output/**", fingerprint: true
+                    mail to: "${env.CHANGE_AUTHOR_EMAIL}, ${env.NOTIFICATION_EMAIL}",
+                    subject: "Successful Pipeline: ${currentBuild.fullDisplayName}",
+                    body: "Something is right with ${env.BUILD_URL}"
+                } else {
+				    archiveArtifacts artifacts: "tool-mplabx-c-build/output/**", fingerprint: true
+                    mail to: "${env.NOTIFICATION_EMAIL}",
+                    subject: "Successful Pipeline: ${currentBuild.fullDisplayName}",
+                    body: "Something is right with ${env.BUILD_URL}"
+                }
+            }
+        }
+        failure {
+            script {
+                if (!"${env.CHANGE_AUTHOR_EMAIL}".equalsIgnoreCase("null")) {
+				    archiveArtifacts artifacts: "tool-mplabx-c-build/output/**", fingerprint: true
+                    mail to: "${env.CHANGE_AUTHOR_EMAIL}, ${env.NOTIFICATION_EMAIL}",
+                    subject: "Failed Pipeline: ${currentBuild.fullDisplayName}",
+                    body: "Pipeline failure. ${env.BUILD_URL}"
+                } else {
+				    archiveArtifacts artifacts: "tool-mplabx-c-build/output/**", fingerprint: true
+                    mail to: "${env.NOTIFICATION_EMAIL}",
+                    subject: "Failed Pipeline: ${currentBuild.fullDisplayName}",
+                    body: "Pipeline failure. ${env.BUILD_URL}"
+                }
+            }
+        }
+    }
+}
+
+def execute(String command) {
+    if (isUnix()) {
+        sh command
+    } else {
+        bat command
+    }
+}
+
+String readJsonObject() {
+    def jsonObj  = readJSON interpolate: true, file: "${env.SOURCE_PROJECT_META_DATA}"
+    return jsonObj
+}
+def getGitHubUrl(String productionUrl, String testDeployUrl) {
+    String branchName = "${env.BRANCH_NAME}";
+    if(branchName == 'master') {
+        return productionUrl;
+    } else if(branchName == 'test_deploy') {
+        return testDeployUrl;
+    } else {
+        return null
+    }
+}
+def getGitHubCredentialId(String deployUrl, String productionDeployUrl, String testDeployUrl, String githubProductionDeployCredential, String githubTestDeployCredential) {    
+    if(deployUrl == productionDeployUrl) {
+        return githubProductionDeployCredential;
+    } else if(deployUrl == testDeployUrl) {
+        return githubTestDeployCredential;
+    } else {
+        return null
+    }
+}

.citd/cloudprovider.yml

@@ -0,0 +1,18 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: xc16-mplabx-sonar-fmpp-python
+spec:
+  containers:
+    - name: xc16-mplabx-sonar-fmpp-python
+      image:  artifacts.microchip.com:7999/microchip/citd/bundles/xc16-mplabx-sonar-fmpp-python-yarn-node:1.50-5.40-4.2-0.9.16-3.x-1.17.3-12.x
+      imagePullPolicy: Always
+      command: ['cat']
+      tty: true
+      resources:
+        requests:
+          cpu: 1
+          memory: 1Gi
+        limits:
+          cpu: 2
+          memory: 2Gi

.main-meta/main.json

@@ -0,0 +1,49 @@
+{
+   "metaDataVersion":"1.0.0",
+   "category":"com.microchip.ide.project",
+   "content":{
+      "metaDataVersion":"1.0.0",
+      "name":"com.microchip.mplabx.project.pic24f-lcd-usb-curiosity-lcd-power",
+      "version":"1.0.0",
+      "displayName":"PIC24F LCD USB Curiosity Development Board LCD and Power Demo",
+      "projectName":"pic24f-lcd-usb-curiosity-lcd-power",
+      "shortDescription":"This is the LCD and Power demo software which runs on PIC24F LCD USB Curiosity Development Board.",
+      "ide":{
+         "name":"MPLABX",
+         "semverRange":">=5.40.0"
+      },
+      "compiler":{
+         "name":"XC16",
+         "semverRange":"^1.50.0"
+      },
+      "dfp":{
+         "name":"PIC24F_GL_GU_DFP",
+         "semverRange":"^1.3.38"
+      },
+      "configurator": {
+         "name": "MCC",
+         "semverRange": ">=4.0.1"
+      },
+      "device":{
+         "metaDataVersion":"1.0.0",
+         "category":"com.microchip.portal.contentRef",
+         "content":{
+            "metaDataVersion":"1.0.0",
+            "category":"com.microchip.device",
+            "name":"PIC24FJ512GU410",
+            "versionRange":"*"
+         }
+      },
+      "peripherals":[
+         "SPI",
+         "LCD",
+         "USB"
+      ],
+      "keywords":[
+         "PIC24F",
+         "Segmented LCD",
+         "LCD",
+         "USB"
+      ]
+   }
+}

LICENSE.txt

@@ -0,0 +1,9 @@
+© [2020] Microchip Technology Inc. and its subsidiaries
+
+Subject to your compliance with these terms, you may use this Microchip software and any derivatives exclusively with Microchip products. You are responsible 
+for complying with third party license terms applicable to your use of third party software (including open source software) that may accompany this 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,50 @@
+![image](images/microchip.jpg) 
+
+# PIC24F LCD USB Curiosity Development Board LCD and Power Demo.
+
+## Summary
+
+This is the demo software which runs on PIC24F LCD USB Curiosity Development Board (DM240018). The PIC24F LCD USB Curiosity Development Board is a cost-effective, fully integrated development platform targeted at first-time users, Makers, and those seeking a feature-rich rapid prototyping board. Refer to https://www.microchip.com/pic24flcdusbcuriosity for additional details about the board.
+
+
+## Related Documentation
+
+- PIC24F GU/GL Low Power MCUs: https://www.microchip.com/PIC24F-GU-GL
+- PIC24FJ512GU410 microcontroller https://www.microchip.com/PIC24FJ512GU410
+
+
+## Hardware Used 
+
+- PIC24F LCD USB Curiosity Development Board (https://www.microchip.com/pic24flcdusbcuriosity) 
+
+## Software Used 
+
+- MPLAB® X IDE v5.40 or newer (https://www.microchip.com/mplabx)
+- MPLAB® XC16 v1.50 or newer (https://www.microchip.com/xc)
+- MPLAB® Code Configurator v4.0.1 (https://www.microchip.com/mplab/mcc)
+
+
+## Operation
+
+This example has two main modes of operation 
+1. USB powered mode
+2. Battery powered mode.
+
+## USB Powered Mode
+
+The display just toggles between the text "PIC24" and "LCD".  This toggling is done automatically by the LCD module using the alternate display mode of the module.  The core sets up the LCD module with the "PIC24" text in the main display memory and the "LCD" text in the alternate display memory and the LCD automatically toggles between the two texts.
+
+
+## Battery Powered Mode
+
+If the USB power is disconnected, the board can run from a battery backup and will go into battery powered mode.  In order to run in battery mode a CR2032 needs to be inserted in the B1 battery housing and jumper J9 needs a short between pins 2 and 3.
+
+In battery powered mode the moon icon is displayed to indicate that it is in battery mode.  The battery status icon indicates the current battery status.
+
+The time will be displayed on the screen in this mode.  The ":" blinks using the LCD modules blink feature.  The CPU does not need to wake up to update the screen for the ":".
+
+The CPU wakes up once a minute in this mode to update the time on the screen. LED LED1 will blink while the CPU is awake.  The CPU will also wake up when the USB power is detected.
+
+To measure the power consumption of the board, a meter can be placed between the pins 2 and 3 of jumper J9 (that goes to the battery housing.  To measure the current of the CPU, cut the trace on the bottom of the board under jumper J1 and place a meter between the two pins. 
+
+![image](images/pic24f_lcdusbcuriosity.jpg)