Merge pull request #9 from Infineon/devel

Devel

.gitignore

@@ -0,0 +1,34 @@
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+.cproject
+.project
+.settings/
+.version
+.accepted
+/build/
+/downloads/
+/packages/
+
+package_adafruit_index.json
+package_index.json
+package_infineon_index.json

.travis.yml

@@ -1,32 +1,58 @@
+os:
+  - linux
+
 language: python
+
 python:
     - 3.7
 
 sudo: required
-
-cache: pip
 
 branches:
-    - master
-
+  only:
+    - gh-pages
+    - /.*/
+
+cache: pip
+
+# Builds Test
 env:
     global:
         - USR_NAME="OlafFilies"
         - USR_EMAIL="[email protected]"
     matrix:
-        - PLATFORMIO_CI_SRC=examples/Control2Motors 
+        - PLATFORMIO_CI_SRC=examples/basicTest
         - PLATFORMIO_CI_SRC=examples/rampSpeedTest
-        - PLATFORMIO_CI_SRC=examples/rampTest
+        - PLATFORMIO_CI_SRC=examples/control2Motors 
         - PLATFORMIO_CI_SRC=examples/speedControl
 
-install:
-    # build with stable core
-    - pip install -U platformio
-    - platformio platform install -f infineonxmc
-    - platformio platform install -f atmelavr
+install: 
+  - pip install -U platformio
+  - platformio platform install -f infineonxmc
+  - platformio platform install -f atmelavr
+
+script: 
+  - platformio ci --lib="." --board=xmc1100_boot_kit --board=xmc4700_relax_kit --board=uno --project-option="lib_deps=Wire"
+
+jobs:
+  include:   
+    - stage: "Deploy" 
+      name: "GitHub Pages Deployment"
+      if: tag IS present
+      addons:
+        apt:
+            packages:
+            - doxygen
+            - graphviz
+            sources:
+                - ubuntu-toolchain-r-test
+      install:
+        - git clone https://github.com/Infineon/InfineonDoxyGenerator.git --branch v.0.2.1
+      script: 
+        - cd InfineonDoxyGenerator
 
-script:
-    - platformio ci --lib="."  --board=xmc1100_boot_kit --board=xmc4700_relax_kit --board=uno
+        - python doxyifx.py html
+        - python doxyifx.py release $GH_USER $GH_PASS_TOKEN
 
 after_success:
 

Contributing.md

@@ -0,0 +1,95 @@
+## How to contribute to Infineon examples, libraries and code
+
+
+
+#### **Did you find a bug?**
+
+
+
+* **verify that the library belongs to you hardware**, sometimes certain sensors look similar but have different functionality and
+
+different software repositories. Check if you have the right combination.
+
+
+
+* **Ensure the bug was not already reported** by searching on GitHub under issues for this particular repository
+
+
+
+* If you're unable to find an open issue addressing the problem, open a new one. Be sure to include
+
+    - a **title and clear description**, as much relevant information as possible
+
+    - a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring
+
+    - a **hardware list** the exact name of a sensors or microcontollers you used
+
+    - a **circuit diagram** if you have a such a problem
+
+
+
+#### **Did you write a patch that fixes a bug?**
+
+
+
+* Before you write a patch open an issue and wait for answer an answer from the repository admin. Maybe a patch or a new release is already and the way.
+
+
+
+* Open a new GitHub pull request with the patch.
+
+
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+
+
+#### **Did you fix whitespace, format code, or make a purely cosmetic patch?**
+
+
+
+Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Rails will generally not be accepted
+
+as a patch, but you can still raise an issue so that these changes can be fixed with a new official release.
+
+
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+
+
+* Suggest your change in by raising an issue before you start writing code.
+
+
+
+* Do not open an issue on GitHub until you have collected positive feedback about the change.
+
+
+
+* Start a discussion with the [Infineon Maker Team](https://github.com/orgs/Infineon/teams/maker-hackathon-team)
+
+
+
+#### **Do you have questions about the source code?**
+
+
+
+* Please start a discussion with the [Infineon Maker Team](https://github.com/orgs/Infineon/teams/maker-hackathon-team)
+
+
+
+#### **Do you want to contribute to the documentation?**
+
+
+
+* Same, start a discussion with the [Infineon Maker Team](https://github.com/orgs/Infineon/teams/maker-hackathon-team)
+
+
+
+
+
+Thanks! :heart: :heart: :heart:
+
+
+
+Infineon Technologies AG, GitHub Team

Jenkinsfile

@@ -0,0 +1,158 @@
+/*
+ * ##################################################################################
+ * #
+ * # Attention: this file is used for compilation checks together with
+ * # Jenkins, SonarQube and OpenShift cluster
+ * #
+ */
+pipeline {
+	agent {
+		node {
+			label 'x64 || rpi'
+			customWorkspace "/home/jenkins/Arduino/libraries/Tle94112"
+		}
+	}
+
+	options {
+		buildDiscarder(
+			logRotator(
+				numToKeepStr: '5',
+				artifactNumToKeepStr: '5'
+			)
+		)
+		disableConcurrentBuilds()
+	}
+
+	/*
+	triggers {
+		cron('H H(0-1) * * *')
+	}
+	*/
+
+	stages {
+		stage('Build documentation') {
+			parallel {
+				/*-----------------------------------------------------------------------------
+				 * html
+				 *-----------------------------------------------------------------------------
+				 */
+				stage('HTML') {
+					steps {
+						echo "html"
+						sh ("export DOXY_BIN_PATH=/usr/local/bin/;cd ${env.WORKSPACE}/docs;/usr/bin/make html")
+					}
+				}
+				/*-----------------------------------------------------------------------------
+				 * latex/pdf
+				 *-----------------------------------------------------------------------------
+				 */
+				stage('PDF') {
+					steps {
+						echo "latex/pdf"
+						/*
+						sh ("export DOXY_BIN_PATH=/usr/local/bin/;cd ${env.WORKSPACE}/docs;/usr/bin/make pdf")
+						build(
+							job: 'dev/doxy_maker_pdf',
+							propagate: true,
+							parameters: [
+								[
+									$class: 'StringParameterValue',
+									name: 'WORKSPACE',
+									value: "${env.WORKSPACE}"
+								],
+							]
+						)
+						*/
+					}
+				}
+			} // end parallel
+		} // end docu build
+
+		stage('Check') {
+			parallel {
+
+				/*-----------------------------------------------------------------------------
+				 * cppcheck
+				 *-----------------------------------------------------------------------------
+				 */
+				stage('CPP') {
+					steps {
+						sh "cd  ${env.WORKSPACE};mkdir -p build;/usr/local/bin/cppcheck -v --enable=all --xml-version=2 -I examples src 2> build/cppcheck-report.xml"
+					} // end steps
+				} // end stage
+
+				/*-----------------------------------------------------------------------------
+				 * cppcheck
+				 *-----------------------------------------------------------------------------
+				 */
+				stage('CLI') {
+					steps {
+						echo "Compile"
+						sh ("cd ${env.WORKSPACE};/usr/bin/make all")
+					} // end steps
+				} // end stage
+
+			} // parallel
+		} // end stage
+
+		stage('SonarQube') {
+			environment {
+				scannerHome = tool 'SonarQubeScanner'
+			}
+			steps {
+				withSonarQubeEnv('SonarQube') {
+					sh "${scannerHome}/bin/sonar-scanner -X"
+				}
+				catchError(buildResult: 'SUCCESS', stageResult: 'FAILURE') {
+					timeout(time: 10, unit: 'MINUTES') {
+						waitForQualityGate abortPipeline: true
+					}
+				}
+			} // end steps
+		} // end stage
+
+		stage('Deploy') {
+			parallel {
+				/*-----------------------------------------------------------------------------
+				 * development
+				 *-----------------------------------------------------------------------------
+				 */
+				stage('Docu') {
+					steps {
+						echo "html deploy"
+						sh("mkdir -p /mnt/raspel/Public/doxygen/Tle94112/;cd ${env.WORKSPACE}/docs;cp -r html /mnt/raspel/Public/doxygen/Tle94112/;")
+					}
+				}
+
+
+				/*-----------------------------------------------------------------------------
+				 * production
+				 *-----------------------------------------------------------------------------
+				 */
+				stage('PRODUCTION') {
+					steps {
+						echo "Production"
+					}
+				}
+
+			} // end parallel
+		} // end stage
+	} // end stages
+
+	/*-----------------------------------------------------------------------------
+	 * post
+	 *-----------------------------------------------------------------------------
+	 */
+	post {
+		failure {
+			/*
+			mail(
+				to: '',
+				subject: "[EPE JENKINS] ${IFXLIB} pipeline:",
+				body: "Something during Jenkins pipeline run went wrong."
+			)
+			*/
+		}
+	}
+
+}