Skip to content

Commit c503870

Browse files
gigapodgigapod
authored
Merge pull request #176 from sparkfun/feature/move-to-open-source
Moved to a MIT license for the repo
2 parents 5f20268 + ab2175e commit c503870

File tree

266 files changed

+1035
-1036
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

266 files changed

+1035
-1036
lines changed

‎CMakeLists.txt‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
#
2+
# Copyright (c) 2022-2024, SparkFun Electronics Inc.
3+
#
4+
# SPDX-License-Identifier: MIT
5+
#
16
# $id$ FLUX_SDK_PATH/CMakeLists.txt
27
#
38

‎LICENSE.md‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,25 @@ SparkFun Flux License Information
33

44
Code
55
--------
6-
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.
7-
6+
7+
MIT License
8+
9+
Copyright (c) 2022-24 SparkFun Electronics
10+
11+
Permission is hereby granted, free of charge, to any person obtaining a copy
12+
of this software and associated documentation files (the "Software"), to deal
13+
in the Software without restriction, including without limitation the rights
14+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15+
copies of the Software, and to permit persons to whom the Software is
16+
furnished to do so, subject to the following conditions:
17+
18+
The above copyright notice and this permission notice shall be included in all
19+
copies or substantial portions of the Software.
20+
21+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27+
SOFTWARE.

‎README.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,18 @@
33

44
SDK and Framework to simplify the development of embedded applications
55

6-
## Status - In Development
6+
## Status
77

88
## Using Flux SDK
99

10-
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.
10+
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.
1111

1212
To build firmware using Flux, see [Building with Flux](docs/build_with_flux.md)
1313

14-
15-
## Framework Development
14+
## Framework Development
1615

1716
Adding new capabilities to the Flux Framework
1817

19-
* Implementing a [Device Class](docs/device_writing.md)
20-
* Implementing [Properties](docs/properties.md)
21-
* Implementing [Parameters](docs/parameters.md)
18+
* Implementing a [Device Class](docs/device_writing.md)
19+
* Implementing [Properties](docs/properties.md)
20+
* Implementing [Parameters](docs/parameters.md)

‎examples/Example-01_Hello/Example-01_Hello.ino‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
/*
2-
*---------------------------------------------------------------------------------
32
*
4-
* Copyright (c) 2022-2024, SparkFun Electronics Inc. All rights reserved.
5-
* This software includes information which is proprietary to and a
6-
* trade secret of SparkFun Electronics Inc. It is not to be disclosed
7-
* to anyone outside of this organization. Reproduction by any means
8-
* whatsoever is prohibited without express written permission.
3+
* Copyright (c) 2022-2024, SparkFun Electronics Inc.
4+
*
5+
* SPDX-License-Identifier: MIT
96
*
10-
*---------------------------------------------------------------------------------
117
*/
128

139
/*
14-
* Spark Framework demo - simple output
10+
* Flux Framework demo - simple output
11+
*
12+
* Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
13+
* into the Arduino libraries folder, or via the --library option in the Arduino CLI.
1514
*
1615
*/
1716

‎examples/Example-02_Params/Example-02_Params.ino‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1+
12
/*
2-
*---------------------------------------------------------------------------------
33
*
4-
* Copyright (c) 2022-2024, SparkFun Electronics Inc. All rights reserved.
5-
* This software includes information which is proprietary to and a
6-
* trade secret of SparkFun Electronics Inc. It is not to be disclosed
7-
* to anyone outside of this organization. Reproduction by any means
8-
* whatsoever is prohibited without express written permission.
4+
* Copyright (c) 2022-2024, SparkFun Electronics Inc.
5+
*
6+
* SPDX-License-Identifier: MIT
97
*
10-
*---------------------------------------------------------------------------------
118
*/
129

1310
/*
14-
* Spark Framework demo - simple output
11+
* Flux Framework demo - use of output parameters
12+
*
13+
* Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
14+
* into the Arduino libraries folder, or via the --library option in the Arduino CLI.
1515
*
1616
*/
1717

‎examples/Example-04_Logger/Example-04_Logger.ino‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
/*
2-
*---------------------------------------------------------------------------------
32
*
4-
* Copyright (c) 2022-2024, SparkFun Electronics Inc. All rights reserved.
5-
* This software includes information which is proprietary to and a
6-
* trade secret of SparkFun Electronics Inc. It is not to be disclosed
7-
* to anyone outside of this organization. Reproduction by any means
8-
* whatsoever is prohibited without express written permission.
3+
* Copyright (c) 2022-2024, SparkFun Electronics Inc.
4+
*
5+
* SPDX-License-Identifier: MIT
96
*
10-
*---------------------------------------------------------------------------------
117
*/
128

139
/*
14-
* Spark Framework demo - logging
10+
* Flux Framework demo - simple logging output on a ESP32 device
11+
*
12+
* Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
13+
* into the Arduino libraries folder, or via the --library option in the Arduino CLI.
1514
*
1615
*/
1716

18-
// Spark framework
17+
// Flux framework
1918
#include <Flux.h>
2019
#include <Flux/flxFmtCSV.h>
2120
#include <Flux/flxFmtJSON.h>
@@ -41,12 +40,6 @@
4140
// NTP
4241
#include <Flux/flxNTPESP32.h>
4342

44-
//#define OPENLOG_ESP32
45-
#ifdef OPENLOG_ESP32
46-
#define EN_3V3_SW 32
47-
#define LED_BUILTIN 25
48-
#endif
49-
5043
//------------------------------------------
5144
// Default log interval in milli secs
5245
#define kDefaultLogInterval 6000
@@ -102,11 +95,6 @@ void setup()
10295
;
10396
Serial.println("\n---- Startup ----");
10497

105-
#ifdef OPENLOG_ESP32
106-
pinMode(EN_3V3_SW, OUTPUT); // Enable Qwiic power and I2C
107-
digitalWrite(EN_3V3_SW, HIGH);
108-
#endif
109-
11098
// If not using settings, can use the following lines to test WiFi manually
11199
// Try WiFi
112100
// wifiConnection.SSID = "";

‎examples/Example-06_SimpleEvent/Example-06_SimpleEvent.ino‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
/*
2-
*---------------------------------------------------------------------------------
32
*
4-
* Copyright (c) 2022-2024, SparkFun Electronics Inc. All rights reserved.
5-
* This software includes information which is proprietary to and a
6-
* trade secret of SparkFun Electronics Inc. It is not to be disclosed
7-
* to anyone outside of this organization. Reproduction by any means
8-
* whatsoever is prohibited without express written permission.
3+
* Copyright (c) 2022-2024, SparkFun Electronics Inc.
4+
*
5+
* SPDX-License-Identifier: MIT
96
*
10-
*---------------------------------------------------------------------------------
117
*/
128

139
/*
14-
* Spark Framework demo - Simple Events
10+
* Flux Framework demo - simple events
11+
*
12+
* Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
13+
* into the Arduino libraries folder, or via the --library option in the Arduino CLI.
1514
*
1615
*/
1716

@@ -22,9 +21,9 @@
2221
#include <Flux/flxSerial.h>
2322

2423
/////////////////////////////////////////////////////////////////////////
25-
// Spark Framework
24+
// Flux Framework
2625
/////////////////////////////////////////////////////////////////////////
27-
// Spark Structure and Object Definition
26+
// Flux Structure and Object Definition
2827
//
2928
// This app implements a "logger", which grabs data from
3029
// connected devices and writes it to the Serial Console

‎examples/Example-07_Button_Event_Logger/Example-07_Button_Event_Logger.ino‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
/*
2-
*---------------------------------------------------------------------------------
32
*
4-
* Copyright (c) 2022-2024, SparkFun Electronics Inc. All rights reserved.
5-
* This software includes information which is proprietary to and a
6-
* trade secret of SparkFun Electronics Inc. It is not to be disclosed
7-
* to anyone outside of this organization. Reproduction by any means
8-
* whatsoever is prohibited without express written permission.
3+
* Copyright (c) 2022-2024, SparkFun Electronics Inc.
4+
*
5+
* SPDX-License-Identifier: MIT
96
*
10-
*---------------------------------------------------------------------------------
117
*/
128

139
/*
14-
* Spark Framework demo - event logging
10+
* Flux Framework demo - event logging
11+
*
12+
* Note: This demo requires the generation of a SparkFun_Flux Arduino library - that is then installed
13+
* into the Arduino libraries folder, or via the --library option in the Arduino CLI.
1514
*
1615
*/
1716

18-
// Spark framework
17+
// Flux framework
1918
#include <Flux.h>
2019
#include <Flux/flxFmtCSV.h>
2120
#include <Flux/flxLogger.h>

‎examples/test/t_NAU7802_Logger/t_NAU7802_Logger.ino‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
/*
2-
*---------------------------------------------------------------------------------
32
*
4-
* Copyright (c) 2022-2024, SparkFun Electronics Inc. All rights reserved.
5-
* This software includes information which is proprietary to and a
6-
* trade secret of SparkFun Electronics Inc. It is not to be disclosed
7-
* to anyone outside of this organization. Reproduction by any means
8-
* whatsoever is prohibited without express written permission.
3+
* Copyright (c) 2022-2024, SparkFun Electronics Inc.
4+
*
5+
* SPDX-License-Identifier: MIT
96
*
10-
*---------------------------------------------------------------------------------
117
*/
128

139
/*

‎examples/test/t_array/t_array.ino‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
/*
2-
*---------------------------------------------------------------------------------
32
*
4-
* Copyright (c) 2022-2024, SparkFun Electronics Inc. All rights reserved.
5-
* This software includes information which is proprietary to and a
6-
* trade secret of SparkFun Electronics Inc. It is not to be disclosed
7-
* to anyone outside of this organization. Reproduction by any means
8-
* whatsoever is prohibited without express written permission.
3+
* Copyright (c) 2022-2024, SparkFun Electronics Inc.
4+
*
5+
* SPDX-License-Identifier: MIT
96
*
10-
*---------------------------------------------------------------------------------
117
*/
128

139
/*
14-
* Spark Framework demo - logging
10+
* Flux Framework demo - logging
1511
*
1612
*/
1713

0 commit comments

Comments
 (0)