Pull request #40: Release of version 1.0.0

Merge in XFPL/high-side-switch from develop to master

* commit 'b6dfb59c06181fc50ad0687cd253e6714a57a3ad': (151 commits)
  Updated Arduino README img links
  Updating documentation for Arduino framework
  Updated main library README.md and arduino metafiles
  Added hss stack diagram
  Updates in documentation and doxygen comments
  Added using namespace in test mocks
  Removed config folder from cmake
  Wiki work in progress. Rearranging sections, mixing breathe and exhale
  minor fixes
  Reverted rootFileTitle as it is not working in ci/cd setup
  Removed rootFileTitle from exhale_args attempt
  Added missing using namespace in examples and fixed minor issues
  Added rootFileTitle. Locally not required, but in CI/CD toolchain required
  Added Doxyfile to keep internal doxygen pipeline compiling
  Added autogenerated docs to gitignore. Added missing exhale_args parameter. Removed link to autogenerated rst files
  Doxygen comments reviewed for consitant documentation, and warning removal from breathe exhale integration. Removed library-api-docs automatic rst files generation
  remove todos, add and fix content
  Fixed failing test in the googleTest environment
  make button reaction quicker for bts700x series
  make button reaction quicker
  ...

.gitignore

@@ -7,3 +7,8 @@ cmake_install.cmake
 CTestTestfile.cmake
 InfineonDoxyGenerator/
 docs/doxygen/doxyfile_auto
+/docs/_build
+/docs/exhale-auto-docs
+docs/doxyoutput
+.pio/
+/workflow/

CMakeLists.txt

@@ -1,9 +1,9 @@
-cmake_minimum_required(VERSION 3.12.4)  
+cmake_minimum_required(VERSION 3.12.4)
 
-# Arduino Library Template 
-set(lib high-side-switch)
+# Arduino Library Template
+set(corelib high-side-switch)
 
-project(${lib} CXX C)
+project(${corelib} CXX C)
 
 set(CMAKE_CXX_STANDARD 11)
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
@@ -14,22 +14,25 @@ set(CMAKE_C_OUTPUT_EXTENSION_REPLACE ON)
 set(CMAKE_CXX_FLAGS "-g -O0 -Wall -fprofile-arcs -ftest-coverage")
 set(CMAKE_C_FLAGS "-g -O0 -Wall -fprofile-arcs -ftest-coverage")
 
+include_directories(
+    src/corelib
+    src/pal
+)
 # Header & Source Files
 set(Headers
-    src/corelib/hss.hpp
+    src/corelib
+    src/pal
     )
 
-set(Sources
-    src/corelib/hss.cpp
-    )
+file(GLOB Sources CONFIGURE_DEPENDS src/corelib/*.cpp)
 
 # Add Library
-add_library(${lib} ${Sources} ${Headers})
+add_library(${corelib} ${Sources} ${Headers})
 
 # Enable Testing with CTest
 enable_testing()
 
-# Add GoogleTest 
+# Add GoogleTest
 add_subdirectory(googletest)
 # Add Tests Folder
-add_subdirectory(test)
+add_subdirectory(test/unit)

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

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Infineon Technologies AG
+Copyright (c) 2019-2021 Infineon Technologies AG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,37 +1,47 @@
 # Smart High-Side Switch
 
-[![Build Status](https://travis-ci.com/Infineon/high-side-switch.svg?branch=master)](https://travis-ci.com/github/Infineon/high-side-switch)
-
-C++ library for Infineon's Arduino shield SHIELD_BTS700x-1EPP with the **Smart High-Side Power Switch BTS700x-1EPP**
-
-## Supported Hardware
-
-### SHIELD_BTS7002-1EPP
-The library has been customized for the Arduino-Adapter-Shield ***SHIELD_BTS700x-1EPP*** and for the Arduino environment. It works with all available versions of the board (SHIELD_BTS7002-1EPP, SHIELD_BTS7004-1EPP, SHIELD_BTS7006-1EPP, SHIELD_BTS7008-1EPP).
-
-<img src="docs/img/Profet+2.png" width="250px">
-
-A detailed explanation of the board and its features can be found in the [user manual](https://www.infineon.com/dgdl/Infineon-PROFET+2_12V_Arduino_Shield-UserManual-v01_00-EN.pdf?fileId=5546d4626df6ee62016dfe3f1eff118b). The user manual also contains the pinout as well as the schematics of the board. The data sheet of the BTS7002-1EPP can be found [here](https://www.infineon.com/dgdl/Infineon-BTS7002-1EPP-DataSheet-v01_04-EN.pdf?fileId=5546d4626eab8fbf016ead699aef00b3).
-
-### Verified Hardware
-The shield is designed to be directly stacked on boards which have the Arduino UNO form factor.
-Therefore, the library has been built and successfully deployed to the following platforms:
-
-MCU Platforms |
----           |
-[XMC1100 Boot Kit](https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc11_boot_001/#ispnTab1) |
-[Arduino Uno Rev3](https://store.arduino.cc/arduino-uno-rev3) |
-
-### Additional hardware platforms
-The library should be directly compatible with other platforms that support the Arduino API (Arduino reference language). The library is also written in a way that porting the library to another platform requires the developer only to provide a API for the specific platform, using the platform specific low level drivers. A porting guide is available in the [Wiki](https://github.com/Infineon/high-side-switch/wiki).
-
-## Software documentation
-A detailed explanation of the software structure as well as the API can be found [here](https://github.com/Infineon/high-side-switch/wiki/Library-Details). And there is also a ***Doxygen-File*** available, which can be found [here](https://infineon.github.io/high-side-switch/).
+C++ library for Infineon's Arduino shields for **PROFET™ Smart High-Side Power Switches** Automotive grade
+
+## Supported Products
+
+<table>
+    <tr>
+        <td><img src="docs/img/BTT6020-1EKA.jpg" width="300"></td>
+        <td><img src="docs/img/BTS50015-1TAD.jpg" width="300"></td>
+        <td><img src="docs/img/Profet+2.png" width="300"></td>
+    </tr>
+    <tr>
+        <td style="test-align : center"><a href="https://high-side-switch.readthedocs.io/en/latest/hw-platforms.html#profettrade-24v-family">PROFET™+ 24V BTT60xx Arduino Shield</a></td>
+        <td style="test-align : center"><a href="https://high-side-switch.readthedocs.io/en/latest/hw-platforms.html#power-profettrade-family">Power PROFET™ BTS5001x-1TAD Arduino Shield</a></td>
+        <td style="test-align : center"><a href="https://high-side-switch.readthedocs.io/en/latest/hw-platforms.html#profettrade-2-12v-family">PROFET™+2 12V BTS700x-1EPP Arduino Shield</a></td>
+    </tr>
+</table>
+
+## Supported Frameworks
+
+<table>
+    <tr>
+        <td><img src="img/../docs/img/arduino-logo.png" width="200"></td>
+        <td><img src="img/../docs/img/cross-platform.png" width="200"></td>
+    </tr>
+    <tr>
+        <td style="text-align: center"><a href="https://high-side-switch.readthedocs.io/en/latest/sw-frmwk/arduino/arduino-api.html#arduino-api">Arduino API</a></td>
+        <td style="text-align: center">
+            <a href="https://high-side-switch.readthedocs.io/en/latest/api-reference/profet-24-api.html#btt60xxshield-api">PROFET™+ 24V BTT60xx API</a><br>
+            <a href="https://high-side-switch.readthedocs.io/en/latest/api-reference/power-profet-api.html#power-profettrade-shield">Power PROFET™ BTS5001x API</a><br>
+            <a href="https://high-side-switch.readthedocs.io/en/latest/api-reference/profet2-12-api.html#profettrade-2-12v-shield">PROFET™+2 12V BTS700x API</a>
+        </td>
+    </tr>
+    <tr>
+        <td style="text-align: center"><a href="https://high-side-switch.readthedocs.io/en/latest/sw-frmwk/arduino/arduino-getting-started.html#arduino-getting-started">Getting Started</a></td>
+        <td style="text-align: center"><a href="https://high-side-switch.readthedocs.io/en/latest/lib-details/porting-guide.html#porting-guide">Porting Guide</a></td>
+    </tr>
+</table>
 
 ## More information
-The complete documentation of the library as well as detailed information about the PROFET-shield, can be found in the [Wiki](https://github.com/Infineon/high-side-switch/wiki).
 
-## License
-This project is licensed under the MIT License - click [here](https://github.com/Infineon/high-side-switch/blob/master/LICENSE) for details.
+The complete documentation of the library as well as detailed information about the PROFET-shield, can be found in the [Wiki](https://high-side-switch.readthedocs.io/en/latest/index.html).
 
+## License
 
+This project is licensed under the MIT License - click [here](https://github.com/Infineon/high-side-switch/blob/master/LICENSE) for details.