Moves all of STMicroelectronics source files to their own subfolder

edspark · edspark · commit 87f8575f32a1 · 2022-03-01T13:41:46.000-07:00
* Updated source file pathing in the source files that needed to be changed
* Updates examples that were unnecessarily including files that should probably just
   be included in SparkFun's source files
*  Moves BSD_3 License to the "st_src" subfolder to reflect the correct licensing for those source files
* Adds MIT license to the main repository directory to reflect SparkFun's software contribution with the correct license
* Updates the README to reflect the licensing updates
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,23 +1,12 @@
-COPYRIGHT(c) 2018 STMicroelectronics
+Copyright © 2022 SparkFun Electronics
 
-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 STMicroelectronics nor the names of its contributors
-     may be used to endorse or promote products derived from this software
-     without specific prior written permission.
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), 
+to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-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.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 
+IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ Products that use this Library
 License Information
 -------------------
 
-This product is _**open source**_! 
+SparkFun's source files are _**open source**_! 
 
 Please review the LICENSE.md file for license information. 
 
@@ -57,4 +57,6 @@ Please use, reuse, and modify these files as you see fit. Please maintain attrib
 
 Distributed as-is; no warranty is given.
 
+The source files included in the subfolder **st_src** are licensed differently. They are licensed under the BSD-3 license, check the License.md in
+that subfolder for specifics.
 - Your friends at SparkFun.
diff --git a/examples/Example1_ReadDistance/Example1_ReadDistance.ino b/examples/Example1_ReadDistance/Example1_ReadDistance.ino
@@ -1,9 +1,3 @@
-#include <ComponentObject.h>
-#include <RangeSensor.h>
-#include <SparkFun_VL53L1X.h>
-#include <vl53l1x_class.h>
-#include <vl53l1_error_codes.h>
-
 /*
   Reading distance from the laser based VL53L1X
   By: Nathan Seidle
diff --git a/examples/Example7_Calibration/Example7_Calibration.ino b/examples/Example7_Calibration/Example7_Calibration.ino
@@ -1,11 +1,3 @@
-#include <Arduino.h>
-
-#include <ComponentObject.h>
-#include <RangeSensor.h>
-#include <SparkFun_VL53L1X.h>
-#include <vl53l1x_class.h>
-#include <vl53l1_error_codes.h>
-
 /*
  Calling distance offset calibration for the laser based VL53L1X
  By: Armin Joachimsmeyer
diff --git a/src/SparkFun_VL53L1X.cpp b/src/SparkFun_VL53L1X.cpp
@@ -31,9 +31,7 @@
 */
 
 #include <stdlib.h>
-#include "Arduino.h"
 #include "SparkFun_VL53L1X.h"
-#include "vl53l1x_class.h"
 
 SFEVL53L1X::SFEVL53L1X(TwoWire &i2cPort, int shutdownPin, int interruptPin)
 {
diff --git a/src/SparkFun_VL53L1X.h b/src/SparkFun_VL53L1X.h
@@ -34,9 +34,11 @@
 
 #include "Arduino.h"
 #include "Wire.h"
-#include "RangeSensor.h"
-#include "vl53l1_error_codes.h"
-#include "vl53l1x_class.h"
+#include "st_src/RangeSensor.h"
+#include "st_src/vl53l1_error_codes.h"
+#include "st_src/vl53l1x_class.h"
+#include "st_src/ComponentObject.h"
+#include "st_src/RangeSensor.h"
 
 #define DISTANCE_SHORT 	1
 #define DISTANCE_LONG 	2
diff --git a/src/st_src/ComponentObject.h b/src/st_src/ComponentObject.h
diff --git a/src/st_src/LICENSE.md b/src/st_src/LICENSE.md
@@ -0,0 +1,23 @@
+COPYRIGHT(c) 2018 STMicroelectronics
+
+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 STMicroelectronics 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.
diff --git a/src/st_src/RangeSensor.h b/src/st_src/RangeSensor.h
@@ -41,7 +41,7 @@
 #define __RANGE_SENSOR_CLASS_H
 
 /* Includes ------------------------------------------------------------------*/
-#include <ComponentObject.h>
+#include <st_src/ComponentObject.h>
 
 /* Classes  ------------------------------------------------------------------*/
 /** An abstract class for range sensors
diff --git a/src/st_src/vl53l1_error_codes.h b/src/st_src/vl53l1_error_codes.h
diff --git a/src/st_src/vl53l1x_class.cpp b/src/st_src/vl53l1x_class.cpp
diff --git a/src/st_src/vl53l1x_class.h b/src/st_src/vl53l1x_class.h

Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,7 @@`
`31`	`31`	`*/`
`32`	`32`
`33`	`33`	`#include <stdlib.h>`
`34`		`-#include "Arduino.h"`
`35`	`34`	`#include "SparkFun_VL53L1X.h"`
`36`		`-#include "vl53l1x_class.h"`
`37`	`35`
`38`	`36`	`SFEVL53L1X::SFEVL53L1X(TwoWire &i2cPort, int shutdownPin, int interruptPin)`
`39`	`37`	`{`