Skip to content

Commit 2859ffd

Browse files
committed
MPAE-8667 added CI support and readme
1 parent 1557a21 commit 2859ffd

File tree

6 files changed

+187
-0
lines changed

6 files changed

+187
-0
lines changed

.citd/Jenkinsfile

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

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Untracked files in Studio projects
2+
/**/.vs
3+
/**/*.atsuo
4+
/**/[Dd]ebug/*
5+
/**/[Rr]elease/*
6+
7+
# Uncomment these to include hex/elf files
8+
#!/**/[Dd]ebug/*.hex
9+
#!/**/[Dd]ebug/*.elf
10+
#!/**/[Rr]elease/*.hex
11+
#!/**/[Rr]elease/*.elf

.main-meta/main.json

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
{
2+
"metaDataVersion": "1.0.0",
3+
"category": "com.microchip.ide.project",
4+
"content": {
5+
"metaDataVersion": "1.1.0",
6+
"name": "com.microchip.mcu8.studio.project.avr128db48-constant-current-driver-using-opamp-studio-start",
7+
"version": "",
8+
"displayName": "",
9+
"projectName": "avr128db48-constant-current-driver-using-opamp-studio-start",
10+
"shortDescription": "",
11+
"ide": {
12+
"name": "STUDIO",
13+
"semverRange": ""
14+
},
15+
"compiler": [
16+
{
17+
"name": "",
18+
"semverRange": ""
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": "",
36+
"versionRange": "*"
37+
}
38+
},
39+
"author": "",
40+
"subcategories": [
41+
],
42+
"peripherals": [
43+
],
44+
"keywords": [
45+
],
46+
"additionalData": {
47+
"longDescription": {
48+
"metaDataVersion": "1.0.0",
49+
"category": "com.microchip.portal.fileRef",
50+
"content": {
51+
"metaDataVersion": "1.0.0",
52+
"fileName": "./README.md",
53+
"mimeType": "text/markdown"
54+
}
55+
}
56+
}
57+
}
58+
}

LICENSE.txt

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

images/microchip.png

5.47 KB
Loading

0 commit comments

Comments
 (0)