Merge pull request #176 from sparkfun/feature/move-to-open-source

Moved to a MIT license for the repo
sparkfun · Nov 13, 2024 · c503870 · c503870
2 parents 5f20268 + ab2175e
commit c503870
Show file tree

Hide file tree

Showing 266 changed files with 1,035 additions and 1,036 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,3 +1,8 @@
+#
+# Copyright (c) 2022-2024, SparkFun Electronics Inc.
+#
+# SPDX-License-Identifier: MIT
+#
 # $id$ FLUX_SDK_PATH/CMakeLists.txt
 #
 

diff --git a/LICENSE.md b/LICENSE.md
@@ -3,5 +3,25 @@ SparkFun Flux License Information
 
 Code
 --------
-Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved. This software includes information which is proprietary to and a trade secret of SparkFun Electronics Inc.  It is not to be disclosed to anyone outside of this organization. Reproduction by any means whatsoever is  prohibited without express written permission.
-
+
+MIT License
+
+Copyright (c) 2022-24 SparkFun Electronics
+
+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:
+
+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
@@ -3,19 +3,18 @@
 
 SDK and Framework to simplify the development of embedded applications
 
-## Status -  In Development
+## Status
 
 ## Using Flux SDK
 
-The flux-sdk is a development framework/SDK intended for use as a component within other Firmware applications. As such, it's incorporated into other projects as an Arduino library. 
+The flux-sdk is a development framework/SDK intended for use as a component within other Firmware applications. As such, it's incorporated into other projects as an Arduino library.
 
 To build firmware using Flux, see [Building with Flux](docs/build_with_flux.md)
 
-
-## Framework Development 
+## Framework Development
 
 Adding new capabilities to the Flux Framework
 
-* Implementing a [Device Class](docs/device_writing.md) 
-* Implementing [Properties](docs/properties.md) 
-* Implementing [Parameters](docs/parameters.md) 
+* Implementing a [Device Class](docs/device_writing.md)
+* Implementing [Properties](docs/properties.md)
+* Implementing [Parameters](docs/parameters.md)
diff --git a/examples/Example-01_Hello/Example-01_Hello.ino b/examples/Example-01_Hello/Example-01_Hello.ino
@@ -1,17 +1,16 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*
- * Spark Framework demo - simple output
+ * Flux Framework demo - simple output
+ *
+ * Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
+ *      into the Arduino libraries folder, or via the --library option in the Arduino CLI.
  *
  */
 

diff --git a/examples/Example-02_Params/Example-02_Params.ino b/examples/Example-02_Params/Example-02_Params.ino
@@ -1,17 +1,17 @@
+
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*
- * Spark Framework demo - simple output
+ * Flux Framework demo - use of output parameters
+ *
+ * Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
+ *      into the Arduino libraries folder, or via the --library option in the Arduino CLI.
  *
  */
 

diff --git a/examples/Example-04_Logger/Example-04_Logger.ino b/examples/Example-04_Logger/Example-04_Logger.ino
@@ -1,21 +1,20 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*
- * Spark Framework demo - logging
+ * Flux Framework demo - simple logging output on a ESP32 device
+ *
+ * Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
+ *      into the Arduino libraries folder, or via the --library option in the Arduino CLI.
  *
  */
 
-// Spark framework
+// Flux framework
 #include <Flux.h>
 #include <Flux/flxFmtCSV.h>
 #include <Flux/flxFmtJSON.h>
@@ -41,12 +40,6 @@
 // NTP
 #include <Flux/flxNTPESP32.h>
 
-//#define OPENLOG_ESP32
-#ifdef OPENLOG_ESP32
-#define EN_3V3_SW 32
-#define LED_BUILTIN 25
-#endif
-
 //------------------------------------------
 // Default log interval in milli secs
 #define kDefaultLogInterval 6000
@@ -102,11 +95,6 @@ void setup()
         ;
     Serial.println("\n---- Startup ----");
 
-#ifdef OPENLOG_ESP32
-    pinMode(EN_3V3_SW, OUTPUT); // Enable Qwiic power and I2C
-    digitalWrite(EN_3V3_SW, HIGH);
-#endif
-
     // If not using settings, can use the following lines to test WiFi manually
     // Try WiFi
     // wifiConnection.SSID = "";

diff --git a/examples/Example-06_SimpleEvent/Example-06_SimpleEvent.ino b/examples/Example-06_SimpleEvent/Example-06_SimpleEvent.ino
@@ -1,17 +1,16 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*
- * Spark Framework demo - Simple Events
+ * Flux Framework demo - simple events
+ *
+ * Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
+ *      into the Arduino libraries folder, or via the --library option in the Arduino CLI.
  *
  */
 
@@ -22,9 +21,9 @@
 #include <Flux/flxSerial.h>
 
 /////////////////////////////////////////////////////////////////////////
-// Spark Framework
+// Flux Framework
 /////////////////////////////////////////////////////////////////////////
-// Spark Structure and Object Definition
+// Flux Structure and Object Definition
 //
 // This app implements a "logger", which grabs data from
 // connected devices and writes it to the Serial Console

diff --git a/examples/Example-07_Button_Event_Logger/Example-07_Button_Event_Logger.ino b/examples/Example-07_Button_Event_Logger/Example-07_Button_Event_Logger.ino
@@ -1,21 +1,20 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*
- * Spark Framework demo - event logging
+ * Flux Framework demo - event logging
+ *
+ * Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
+ *      into the Arduino libraries folder, or via the --library option in the Arduino CLI.
  *
  */
 
-// Spark framework
+// Flux framework
 #include <Flux.h>
 #include <Flux/flxFmtCSV.h>
 #include <Flux/flxLogger.h>

diff --git a/examples/test/t_NAU7802_Logger/t_NAU7802_Logger.ino b/examples/test/t_NAU7802_Logger/t_NAU7802_Logger.ino
@@ -1,13 +1,9 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*

diff --git a/examples/test/t_array/t_array.ino b/examples/test/t_array/t_array.ino
@@ -1,17 +1,13 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*
- * Spark Framework demo - logging
+ * Flux Framework demo - logging
  *
  */
 

diff --git a/examples/test/t_array/test_device.cpp b/examples/test/t_array/test_device.cpp
@@ -1,13 +1,9 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*

diff --git a/examples/test/t_array/test_device.h b/examples/test/t_array/test_device.h
@@ -1,13 +1,9 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*

diff --git a/examples/test/t_datalogger/sfeDataLogger.cpp b/examples/test/t_datalogger/sfeDataLogger.cpp
@@ -1,13 +1,9 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*
@@ -19,7 +15,7 @@
 #include "esp_sleep.h"
 
 // TESTING
-//#include <Flux/flxUtils.h>
+// #include <Flux/flxUtils.h>
 
 RTC_DATA_ATTR int boot_count = 0;
 

diff --git a/examples/test/t_datalogger/sfeDataLogger.h b/examples/test/t_datalogger/sfeDataLogger.h
@@ -1,13 +1,9 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*

diff --git a/examples/test/t_datalogger/t_datalogger.ino b/examples/test/t_datalogger/t_datalogger.ino
@@ -1,13 +1,9 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 /*

diff --git a/examples/test/t_editfield/t_editfield.ino b/examples/test/t_editfield/t_editfield.ino
@@ -1,13 +1,9 @@
 /*
- *---------------------------------------------------------------------------------
  *
- * Copyright (c) 2022-2024, SparkFun Electronics Inc.  All rights reserved.
- * This software includes information which is proprietary to and a
- * trade secret of SparkFun Electronics Inc.  It is not to be disclosed
- * to anyone outside of this organization. Reproduction by any means
- * whatsoever is  prohibited without express written permission.
+ * Copyright (c) 2022-2024, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
  *
- *---------------------------------------------------------------------------------
  */
 
 #include <string>