Skip to content

Commit 4ae9539

Browse files
aku-workaku-work
committed
MPAE-18221 added CI support and readme
1 parent 7ea81a5 commit 4ae9539

File tree

8 files changed

+209
-0
lines changed

8 files changed

+209
-0
lines changed

‎.citd/Jenkinsfilek8s‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
// Jenkinsfile v2.0.0
2+
3+
pipeline {
4+
agent {
5+
kubernetes {
6+
7+
defaultContainer 'xc8-mplabx'
8+
yamlFile '.citd/cloudprovider.yml'
9+
}
10+
}
11+
parameters {
12+
string( name: 'NOTIFICATION_EMAIL',
13+
defaultValue: 'PICAVR_Examples_GateKeepers@microchip.com',
14+
description: "Email to send build failure and fixed notifications.")
15+
}
16+
17+
environment {
18+
GITHUB_OWNER = 'microchip-pic-avr-examples'
19+
GITHUB_URL ='https://github.com/microchip-pic-avr-examples/pic18f57q43-adcc-spike-detection-callbacks-mcc'
20+
BITBUCKET_URL = 'https://bitbucket.microchip.com/scm/ebe/pic18f57q43-adcc-spike-detection-callbacks-mcc.git'
21+
SEMVER_REGEX = '^(0|[1-9]\\d*)+\\.(0|[1-9]\\d*)+\\.(0|[1-9]\\d*)+$'
22+
ARTIFACTORY_SERVER = 'https://artifacts.microchip.com:7999/artifactory'
23+
}
24+
options {
25+
timestamps()
26+
timeout(time: 30, unit: 'MINUTES')
27+
}
28+
29+
stages {
30+
stage('setup') {
31+
steps {
32+
script {
33+
execute("git clone https://bitbucket.microchip.com/scm/citd/mpae-buildpipeline-groovy-scripts.git")
34+
def buildPipeline = load ('mpae-buildpipeline-groovy-scripts/xc8mplabx-buildpipeline.groovy')
35+
buildPipeline.runStages()
36+
}
37+
}
38+
}
39+
}
40+
41+
post {
42+
failure {
43+
script {
44+
sendPipelineFailureEmail()
45+
}
46+
}
47+
}
48+
}
49+
def execute(String cmd) {
50+
if(isUnix()) {
51+
sh cmd
52+
} else {
53+
bat cmd
54+
}
55+
}
56+
def sendPipelineFailureEmail() {
57+
mail to: "${env.EMAILLIST},${params.NOTIFICATION_EMAIL}",
58+
subject: "Failed Pipeline: ${currentBuild.fullDisplayName}",
59+
body: "Pipeline failure. ${env.BUILD_URL}"
60+
}

‎.citd/cloudprovider.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
apiVersion: v1
2+
kind: Pod
3+
metadata:
4+
name: xc8-mplabx
5+
spec:
6+
containers:
7+
- name: xc8-mplabx
8+
image: artifacts.microchip.com:7999/microchip/citd/bundles/xc8-mplabx:latest
9+
imagePullPolicy: Always
10+
command: ['cat']
11+
tty: true
12+
resources:
13+
requests:
14+
cpu: 0.25
15+
memory: 500Mi
16+
limits:
17+
cpu: 0.5
18+
memory: 750Mi

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Untracked files in MPLABX projects
2+
/**/build/*
3+
/**/nbproject/*
4+
!/**/nbproject/*.xml
5+
/**/dist/*
6+
/**/.generated_files/*

‎.main-meta/main.json‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
"metaDataVersion": "1.0.0",
3+
"category": "com.microchip.ide.project",
4+
"content": {
5+
"metaDataVersion": "1.3.0",
6+
"name": "com.microchip.mcu8.mplabx.project.pic18f57q43-adcc-spike-detection-callbacks-mcc",
7+
"version": " ",
8+
"displayName": "",
9+
"projectName": "pic18f57q43-adcc-spike-detection-callbacks-mcc",
10+
"shortDescription": "The ADCC Spike Detection Example, of the MCC Melody ADCC Example Component, used in the Polled implementation. ADCC Spike Detection is visualized with the Data Streamer. Modify the Spike Detection Sensitivity to observe the change in sensitivity.",
11+
"ide": {
12+
"name": "MPLAB X",
13+
"semverRange": ">=6.20.0"
14+
},
15+
"compiler": [
16+
{
17+
"name": "XC8",
18+
"semverRange": "^2.46.0"
19+
}
20+
],
21+
"dfp": {
22+
"name": "",
23+
"semverRange": ""
24+
},
25+
"configurator": {
26+
"name": "",
27+
"semverRange": ""
28+
},
29+
"device": {
30+
"metaDataVersion": "1.0.0",
31+
"category": "com.microchip.portal.contentRef",
32+
"content": {
33+
"metaDataVersion": "1.0.0",
34+
"category": "com.microchip.device",
35+
"name": "PIC18F57Q43",
36+
"versionRange": "*"
37+
}
38+
},
39+
"author": "Glen Nilsen",
40+
"peripherals": [],
41+
"keywords": [],
42+
"additionalData": {
43+
"longDescription": {
44+
"metaDataVersion": "1.0.0",
45+
"category": "com.microchip.portal.fileRef",
46+
"content": {
47+
"metaDataVersion": "1.0.0",
48+
"fileName": "./README.md",
49+
"mimeType": "text/markdown"
50+
}
51+
}
52+
}
53+
}
54+
}

‎LICENSE.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
(c) 2024 Microchip Technology Inc. and its subsidiaries.
2+
3+
Subject to your compliance with these terms, you may use Microchip software
4+
and any derivatives exclusively with Microchip products. You're responsible
5+
for complying with 3rd party license terms applicable to your use of 3rd
6+
party software (including open source software) that may accompany Microchip
7+
software.
8+
9+
SOFTWARE IS "AS IS." NO WARRANTIES, WHETHER EXPRESS, IMPLIED OR STATUTORY,
10+
APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT,
11+
MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
12+
13+
IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
14+
INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
15+
WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP
16+
HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO
17+
THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL
18+
CLAIMS RELATED TO THE SOFTWARE WILL NOT EXCEED AMOUNT OF FEES, IF ANY,
19+
YOU PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
20+

‎README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<!-- Please do not change this logo with link -->
2+
3+
<a target="_blank" href="https://www.microchip.com/" id="top-of-page">
4+
<picture>
5+
<source media="(prefers-color-scheme: light)" srcset="images/mchp_logo_light.png" width="350">
6+
<source media="(prefers-color-scheme: dark)" srcset="images/mchp_logo_dark.png" width="350">
7+
<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">
8+
</picture>
9+
</a>
10+
11+
# Update the title for pic18f57q43-adcc-spike-detection-callbacks-mcc here
12+
13+
<!-- This is where the introduction to the example goes, including mentioning the peripherals used -->
14+
15+
## Related Documentation
16+
17+
<!-- Any information about an application note or tech brief can be linked here. Use unbreakable links!
18+
In addition a link to the device family landing page and relevant peripheral pages as well:
19+
- [AN3381 - Brushless DC Fan Speed Control Using Temperature Input and Tachometer Feedback](https://microchip.com/00003381/)
20+
- [PIC18F-Q10 Family Product Page](https://www.microchip.com/design-centers/8-bit/pic-mcus/device-selection/pic18f-q10-product-family) -->
21+
22+
## Software Used
23+
24+
<!-- All software used in this example must be listed here. Use unbreakable links!
25+
- MPLAB® X IDE 5.30 or newer [(microchip.com/mplab/mplab-x-ide)](http://www.microchip.com/mplab/mplab-x-ide)
26+
- MPLAB® XC8 2.10 or a newer compiler [(microchip.com/mplab/compilers)](http://www.microchip.com/mplab/compilers)
27+
- MPLAB® Code Configurator (MCC) 3.95.0 or newer [(microchip.com/mplab/mplab-code-configurator)](https://www.microchip.com/mplab/mplab-code-configurator)
28+
- 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)
29+
- Microchip PIC18F-Q Series Device Support (1.4.109) or newer [(packs.download.microchip.com/)](https://packs.download.microchip.com/) -->
30+
31+
- 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)
32+
- MPLAB® XC8 2.46.0 or newer compiler [(MPLAB® XC8 2.46)](https://www.microchip.com/en-us/tools-resources/develop/mplab-xc-compilers/xc8)
33+
34+
## Hardware Used
35+
36+
<!-- All hardware used in this example must be listed here. Use unbreakable links!
37+
- PIC18F47Q10 Curiosity Nano [(DM182029)](https://www.microchip.com/Developmenttools/ProductDetails/DM182029)
38+
- Curiosity Nano Base for Click boards™ [(AC164162)](https://www.microchip.com/Developmenttools/ProductDetails/AC164162)
39+
- POT Click board™ [(MIKROE-3402)](https://www.mikroe.com/pot-click) -->
40+
41+
## Setup
42+
43+
<!-- 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 -->
44+
45+
## Operation
46+
47+
<!-- Explain how to operate the example. Depending on complexity, step-by-step instructions and/or tables and/or images can be used -->
48+
49+
## Summary
50+
51+
<!-- Summarize what the example has shown -->

‎images/mchp_logo_dark.png‎

21.6 KB
Loading

‎images/mchp_logo_light.png‎

22.8 KB
Loading

0 commit comments

Comments
 (0)