Merge pull request #13 from Infineon/develop

New release to version 3.0.0 of this library based on the Infineon XFB framework.

.github/workflows/arduino_ci.yml

@@ -0,0 +1,51 @@
+name: Arduino CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    strategy:
+      matrix:
+        example: [
+            examples/E9000SPC,
+            examples/readAngleSpeedRevolutions,
+            examples/readAngleTest,
+            examples/readAngleValueProcessing,
+            examples/readMultipleRegisters,
+            examples/readSpeedProcessing,
+            examples/sensorRegisters,
+            examples/sensorType,
+            examples/testSensorMainValues,
+            examples/useMultipleSensors,
+            examples/writeRegisters
+        ]
+
+        arduino-platform: ["arduino:avr"]
+
+        include:
+          - arduino-platform: "arduino:avr"
+            fqbn: "arduino:avr:uno"
+
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Setup Arduino CLI
+        uses: arduino/setup-arduino-cli@v1.1.1
+
+      - name: Install platform
+        run: |
+          arduino-cli core update-index
+          arduino-cli core install ${{ matrix.arduino-platform }}
+
+      - name: Install repo as library
+        run: |
+          mkdir -p "$HOME/Arduino/libraries"
+          ln -s "$PWD" "$HOME/Arduino/libraries/."
+
+      - name: Compile Sketch
+        run: arduino-cli compile --fqbn ${{ matrix.fqbn }} --libraries="." --libraries="$HOME/Arduino/libraries/." ${{ matrix.example }}
+

.github/workflows/doxygen_gh.yml

@@ -0,0 +1,49 @@
+name: Doxygen GH
+
+on: [push, pull_request]
+
+jobs:
+  build-documentation:
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+    - uses: actions/checkout@v2
+    - name: Cache pip
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: ${{ runner.os }}-pip-
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+    - name: Install doxygen
+      run: |
+        sudo apt-get install -y doxygen
+        sudo apt-get install -y graphviz
+
+    - name: Run doxygen
+      run: |
+        git clone https://github.com/Infineon/InfineonDoxyGenerator.git
+        cd InfineonDoxyGenerator
+        python doxyifx.py html
+        #python doxyifx.py release ${{ secrets.GH_USER }} ${{ secrets.GITHUB_TOKEN }}
+    
+    - name: GH Pages Deployment
+      uses: peaceiris/actions-gh-pages@v3
+      if: success()
+      with:
+        publish_dir: ./docs/doxygen/build/html
+        enable_jekyll: false
+        allow_empty_commit: false
+        force_orphan: true
+        publish_branch: gh-pages
+        github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/platformio_ci.yml

@@ -0,0 +1,56 @@
+name: PlatformIO CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    #os: [ubuntu-latest, macos-latest, windows-latest]
+    strategy:
+      matrix:
+        example: [
+            examples/E9000SPC,
+            examples/readAngleSpeedRevolutions,
+            examples/readAngleTest,
+            examples/readAngleValueProcessing,
+            examples/readMultipleRegisters,
+            examples/readSpeedProcessing,
+            examples/sensorRegisters,
+            examples/sensorType,
+            examples/testSensorMainValues,
+            examples/useMultipleSensors,
+            examples/writeRegisters
+        ]
+
+    steps:
+
+    - uses: actions/checkout@v2
+    - name: Cache pip
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: ${{ runner.os }}-pip-
+
+    - name: Cache PlatformIO
+      uses: actions/cache@v2
+      with:
+        path: ~/.platformio
+        key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+
+    - name: Install PlatformIO
+      run: |
+        python -m pip install --upgrade pip
+        pip install --upgrade platformio
+        platformio platform install -f infineonxmc
+        platformio platform install -f atmelavr
+
+    - name: Run PlatformIO
+      run: |
+        pio ci --lib="." --board=xmc1100_xmc2go --board=xmc1100_boot_kit --board=xmc4700_relax_kit --board=uno --project-option="lib_deps=Wire"
+      env:
+        PLATFORMIO_CI_SRC: ${{ matrix.example }}

.gitignore

@@ -0,0 +1,36 @@
+# 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/
+docs/doxygen/doxyfile_auto
+docs/doxygen/build/doxygen-log.txt
+
+package_adafruit_index.json
+package_index.json
+package_infineon_index.json

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 mikrocontrollers 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