Merge branch 'develop'

Update Readme and updated license dates. Removed header guards as well, because they are not needed anymore
Infineon · Feb 4, 2021 · 8e49371 · 8e49371
2 parents ae966ac + e7f3271
commit 8e49371
Show file tree

Hide file tree

Showing 20 changed files with 36 additions and 127 deletions.
diff --git a/README.md b/README.md
@@ -5,6 +5,9 @@
 
 C++ library for the **XMC 3 channels RGB LED Lighting Shield with the XMC1202 and the XMC1302**.
 
+### Release Repository
+Please be aware that this repository is **only a release repository** for the Arduino framework. The whole documentation can be found in the corresponding [Cross-Platform-Library](https://github.com/Infineon/rgb-led-lighting-shield/tree/master).
+
 ### Supported Shields
 <table>
     <tr>
@@ -23,10 +26,10 @@ C++ library for the **XMC 3 channels RGB LED Lighting Shield with the XMC1202 an
         <td align="center"><img src="https://github.com/Infineon/rgb-led-lighting-shield/wiki/img/ino-logo.jpg" width=100></td>
     </tr>
     <tr>
-        <td style"text-align: center"><a href="">Arduino API</a></td>
+        <td style"text-align: center"><a href="https://github.com/Infineon/rgb-led-lighting-shield/wiki/Arduino-API">Arduino API</a></td>
     </tr>
     <tr>
-        <td style"text-align: center"><a href="">Ino-Getting-Started</a></td>
+        <td style"text-align: center"><a href="https://github.com/Infineon/rgb-led-lighting-shield/wiki/Ino-Getting-Started">Ino-Getting-Started</a></td>
     </tr>
 </table>
 

diff --git a/examples/Change_Color_Multi_Channel/Change_Color_Multi_Channel.ino b/examples/Change_Color_Multi_Channel/Change_Color_Multi_Channel.ino
@@ -1,5 +1,3 @@
-#if RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO
-
 #include <Arduino.h>
 #include <rgb-led-lighting-shield-ino.hpp>
 
@@ -41,6 +39,4 @@ void loop()
     Serial.println("Black\n");
     Serial.println("To start the example again press ENTER\n\n");
     while(Serial.read() != '\r'){}
-}
-
-#endif /** LED_DALI_KIT_FRAMEWORK == LED_DALI_KIT_FRMWK_ARDUINO **/
+}
diff --git a/examples/Change_Color_Predefined/Change_Color_Predefined.ino b/examples/Change_Color_Predefined/Change_Color_Predefined.ino
@@ -1,5 +1,3 @@
-#if RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO
-
 #include <Arduino.h>
 #include <rgb-led-lighting-shield-ino.hpp>
 
@@ -42,6 +40,4 @@ void loop()
     Serial.println("Black\n");
     Serial.println("To start the example again press ENTER\n\n");
     while(Serial.read() != '\r'){}
-}
-
-#endif /** RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO **/
+}
diff --git a/examples/Change_Color_Single_Channel/Change_Color_Single_Channel.ino b/examples/Change_Color_Single_Channel/Change_Color_Single_Channel.ino
@@ -1,5 +1,3 @@
-#if RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO
-
 #include <Arduino.h>
 #include <rgb-led-lighting-shield-ino.hpp>
 
@@ -37,6 +35,4 @@ void loop()
     Serial.println("Black\n");
     Serial.println("To start the example again press ENTER\n\n");
     while(Serial.read() != '\r'){}
-}
-
-#endif /** RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO **/
+}
diff --git a/examples/Change_Faderate/Change_Faderate.ino b/examples/Change_Faderate/Change_Faderate.ino
@@ -1,5 +1,3 @@
-#if RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO
-
 #include <Arduino.h>
 #include <rgb-led-lighting-shield-ino.hpp>
 
@@ -40,6 +38,4 @@ void loop()
     RGB_Shield.setColor(BLACK);
     Serial.println("To start the example again press ENTER\n\n");
     while(Serial.read() != '\r'){}
-}
-
-#endif /** RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO **/
+}
diff --git a/examples/Change_Walktime/Change_Walktime.ino b/examples/Change_Walktime/Change_Walktime.ino
@@ -1,5 +1,3 @@
-#if RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO
-
 #include <Arduino.h>
 #include <rgb-led-lighting-shield-ino.hpp>
 
@@ -38,6 +36,4 @@ void loop()
     RGB_Shield.setWalkTime(0x000);
     Serial.println("To start the example again press ENTER\n\n");
     while(Serial.read() != '\r'){}
-}
-
-#endif /** RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO **/
+}
diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
 name=RGB-LED-Lighting-Shield
-version=1.0.0
+version=1.0.1
 author=Infineon Technologies
 maintainer=Infineon Technologies <www.infineon.com>
-sentence=C++ library for Infineon RGB-LED-Lighting-Shield
-paragraph=C++ library for Infineon RGB-LED-Lighting-Shield with the XMC1302
+sentence=C++ library for Infineons RGB-LED-Lighting-Shields
+paragraph=C++ library for Infineons RGB-LED-Lighting-Shield with the XMC1202 and the XMC1302
 category=Shield
 url=https://www.infineon.com/cms/en/product/evaluation-boards/kit_xmc_led_dali_20_rgb/
 architectures=*

diff --git a/src/rgb-led-lighting-shield-conf-dfl.hpp b/src/rgb-led-lighting-shield-conf-dfl.hpp
diff --git a/src/rgb-led-lighting-shield-conf.hpp b/src/rgb-led-lighting-shield-conf.hpp
diff --git a/src/rgb-led-lighting-shield-ino.cpp b/src/rgb-led-lighting-shield-ino.cpp
@@ -1,16 +1,14 @@
 /** 
  * @file        rgb-led-lighting-shield-ino.cpp
  * @brief       RGB LED LIGHTING SHIELD Library KIT Arduino
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */
 
 #include "rgb-led-lighting-shield-ino.hpp"
 
-#if (RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO)
-
 I2CPAL * custom_i2cpal = nullptr;
 
 RGBShieldIno::RGBShieldIno(TwoWire *wire): RGBShield((custom_i2cpal = new I2CPALIno(wire)))
@@ -35,7 +33,4 @@ Error_t RGBShieldIno::begin()
     Serial.println("Initialization done\n\n\n\n\n\n\n\n\n\n");
 
     return err;
-}
-
-#endif /** RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO **/
-
+}
diff --git a/src/rgb-led-lighting-shield-ino.hpp b/src/rgb-led-lighting-shield-ino.hpp
@@ -1,19 +1,15 @@
 /** 
  * @file        rgb-led-lighting-shield-ino.hpp
  * @brief       RGB LED LIGHTING SHIELD Library KIT Arduino
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */
 
 #ifndef RGB_LED_LIGHTING_SHIELD_INO_HPP_
 #define RGB_LED_LIGHTING_SHIELD_INO_HPP_
 
-#include "rgb-led-lighting-shield-conf.hpp"
-
-#if (RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO)
-
 #include "rgb-led-lighting-shield.hpp"
 #include "rgb-led-lighting-shield-pal-i2c-ino.hpp"
 #include <Arduino.h>
@@ -27,5 +23,4 @@ class RGBShieldIno : virtual public RGBShield
         Error_t begin();
 };
 
-#endif /** RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO **/
 #endif /** RGB_LED_LIGHTING_SHIELD_INO_HPP_ **/
diff --git a/src/rgb-led-lighting-shield-opts.hpp b/src/rgb-led-lighting-shield-opts.hpp
diff --git a/src/rgb-led-lighting-shield-pal-i2c-ino.cpp b/src/rgb-led-lighting-shield-pal-i2c-ino.cpp
@@ -1,16 +1,14 @@
 /** 
  * @file        rgb-led-lighting-shield-pal-i2c-ino.cpp
  * @brief       RGB LED LIGHTING SHIELD I2C Platform Abstraction Layer Arduino
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */
 
 #include "rgb-led-lighting-shield-pal-i2c-ino.hpp"
 
-#if (RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO)
-
 /**
  * @brief Constructor of the IC2-Class for Arduino
  * 
@@ -293,6 +291,4 @@ Error_t I2CPALIno::writeDMX(uint16_t addr, uint8_t command)
     _wire->endTransmission(true);
 
     return err;
-}
-
-#endif /** RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO **/
+}
diff --git a/src/rgb-led-lighting-shield-pal-i2c-ino.hpp b/src/rgb-led-lighting-shield-pal-i2c-ino.hpp
@@ -1,19 +1,15 @@
 /** 
  * @file        rgb-led-lighting-shield-pal-i2c-ino.hpp
  * @brief       RGB LED LIGHTING SHIELD I2C Platform Abstraction Layer Arduino
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */
 
 #ifndef RGB_LED_LIGHTING_SHIELD_PAL_I2C_INO_HPP_
 #define RGB_LED_LIGHTING_SHIELD_I2C_INO_HPP_
 
-#include "rgb-led-lighting-shield-conf.hpp"
-
-#if (RGB_LED_LIGHTING_SHIELD_FRAMEWORK == RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO)
-
 #include <Wire.h>
 #include "rgb-led-lighting-shield-pal-i2c.hpp"
 
@@ -37,5 +33,4 @@ class I2CPALIno : virtual public I2CPAL
         TwoWire *_wire;
 };
 
-#endif /** RGB_LED_LIGHTING_SHIELD_FRMWK_ARDUINO **/
-#endif /** RGB_LED_LIGHTING_SHIELD_PAL_I2C_INO_HPP_ **/
+#endif /** RGB_LED_LIGHTING_SHIELD_PAL_I2C_INO_HPP_ **/
diff --git a/src/rgb-led-lighting-shield-pal-i2c.hpp b/src/rgb-led-lighting-shield-pal-i2c.hpp
@@ -1,8 +1,8 @@
 /** 
  * @file        rgb-led-lighting-shield-pal-i2c.hpp
  * @brief       RGB LED LIGHTING SHIELD I2C Platform Abstraction Layer
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */

diff --git a/src/rgb-led-lighting-shield-pal-timer.hpp b/src/rgb-led-lighting-shield-pal-timer.hpp
@@ -1,8 +1,8 @@
 /** 
  * @file        rgb-led-lighting-shield-pal-timer.hpp
  * @brief       RGB LED LIGHTING SHIELD TIMER Platform Abstraction Layer
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */

diff --git a/src/rgb-led-lighting-shield-reg.hpp b/src/rgb-led-lighting-shield-reg.hpp
@@ -1,8 +1,8 @@
 /** 
  * @file        rgb-led-lighting-shield-reg.hpp
  * @brief       RGB LED LIGHTING SHIELD Library KIT REGISTERS
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */

diff --git a/src/rgb-led-lighting-shield-types.hpp b/src/rgb-led-lighting-shield-types.hpp
@@ -1,8 +1,8 @@
 /** 
  * @file        rgb-led-lighting-shield-types.hpp
  * @brief       RGB LED LIGHTING SHIELD Library Types
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */

diff --git a/src/rgb-led-lighting-shield.cpp b/src/rgb-led-lighting-shield.cpp
@@ -1,8 +1,8 @@
 /** 
  * @file        rgb-led-lighting-shield.cpp
  * @brief       RGB LED LIGHTING SHIELD Library KIT
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */

diff --git a/src/rgb-led-lighting-shield.hpp b/src/rgb-led-lighting-shield.hpp
@@ -1,8 +1,8 @@
 /** 
  * @file        rgb-led-lighting-shield.hpp
  * @brief       RGB LED LIGHTING SHIELD Library KIT
- * @date        November 2020
- * @copyright   Copyright (c) 2020 Infineon Technologies AG
+ * @date        February 2021
+ * @copyright   Copyright (c) 2021 Infineon Technologies AG
  * 
  * SPDX-License-Identifier: MIT
  */