BME69X release v1.0.1

.github/workflows/ci-cd-pipeline.yml

@@ -0,0 +1,38 @@
+# GitHub CI build pipeline to trigger the tag creation after the merge
+name: CI/CD Pipeline
+
+on:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - master
+
+jobs:
+  TagCreation:
+    if: github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'Release')
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        ref: ${{ github.event.pull_request.merge_commit_sha }}
+        fetch-depth: '0'
+
+    - name: Parsing tag name from the branch
+      id: tagDetails
+      run: |
+        echo "Branch name is ${{ github.event.pull_request.head.ref }}"
+        tagName=$(echo ${{ github.event.pull_request.head.ref }} | grep -oP 'v\d+\.\d+\.\d+' | sed 's/^//')
+        echo "tagName=$tagName" >> $GITHUB_OUTPUT
+
+    - name: Tag name
+      run: |
+        echo ${{ steps.tagDetails.outputs.tagName }}
+
+    - uses: ncipollo/release-action@v1
+      with:
+        tag: ${{ steps.tagDetails.outputs.tagName }}
+        token: "${{ secrets.GITHUB_TOKEN }}"
+        generateReleaseNotes: "true"

LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2024 Bosch Sensortec GmbH. All rights reserved.
+
+BSD-3-Clause
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+    contributors may be used to endorse or promote products derived from
+    this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,21 @@
+# BME69X SensorAPI
+
+> Bosch Sensortec's BME690 SensorAPI
+
+## Sensor Overview
+BME690 is an integrated environmental sensor developed specifically for mobile applications and wearables where size and low power consumption are key requirements. Expanding Bosch Sensortec’s existing family of environmental sensors, the BME690 integrates for the first time high-linearity and high-accuracy gas, pressure, humidity and temperature sensors. It consists of an 8-pin metal-lid 3.0 x 3.0 x 0.93 mm³ LGA package which is designed for optimized consumption depending on the specific operating mode, long term stability and high EMC robustness. The gas sensor within the BME690 can detect a broad range of gases to measure air quality for personal well being. Gases that can be detected by the BME690 include Volatile Organic Compounds (VOC) from paints (such as formaldehyde), lacquers, paint strippers, cleaning supplies, furnishings, office equipment, glues, adhesives and alcohol.
+
+### Features
+
+- Air quality measurement
+- Personalized weather station
+- Context awareness, e.g. skin moisture detection, room change detection
+- Fitness monitoring / well-being
+- Warning regarding dryness or high temperatures
+- Measurement of volume and air flow
+- Home automation control (e.g. HVAC)
+- GPS enhancement (e.g. time-to-first-fix improvement, dead reckoning, slope detection)
+- Indoor navigation (change of floor detection, elevator detection)
+- Altitude tracking and calories expenditure for sports activities
+
+---