Merge pull request #164 from sparkfun/develop

Move the cmake refactor work into main

Author: gigapod

CMakeLists.txt

@@ -0,0 +1,10 @@
+# $id$ FLUX_SDK_PATH/CMakeLists.txt
+#
+
+# we are building a "fake" Arduino library so we can compile the code using arduino-cli. This
+# requires a library.properties file in the root of the project. This file i
+configure_file(library.properties ${PROJECT_FLUX_DIRECTORY} COPYONLY)
+
+# Now just cascade down to src
+
+add_subdirectory(src)

external/flux_sdk_import.cmake

@@ -0,0 +1,20 @@
+# ##################################################################################################
+# include/import file for the flux-sdk cmake system
+# ##################################################################################################
+
+# we are just using this as a manifest system, so doing the best to bypass the compiler detection
+set(CMAKE_C_COMPILER_FORCED TRUE)
+set(CMAKE_CXX_COMPILER_FORCED TRUE)
+
+# Where is the flux-sdk directory? This should be in some "include file from the sdk"
+
+if (NOT FLUX_SDK_PATH)
+    if (DEFINED ENV{FLUX_SDK_PATH})
+        set(FLUX_SDK_PATH $ENV{FLUX_SDK_PATH})
+    elseif (EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/../flux-sdk)
+        set(FLUX_SDK_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../flux-sdk)
+    endif ()
+endif ()
+
+# crawl the flux-sdk directory and add all the subdirectories
+include(${FLUX_SDK_PATH}/flux_sdk_init.cmake)

flux_sdk_init.cmake

@@ -0,0 +1,176 @@
+# @file: flux_sdk_init.cmake
+
+# ##################################################################################################
+# flux_sdk_version()
+include(${CMAKE_CURRENT_LIST_DIR}/flux_sdk_version.cmake)
+
+# ##################################################################################################
+# flux_sdk_set_platform()
+#
+# Set the platform for the SDK - what hardware stack is this used on?
+#
+macro (flux_sdk_set_platform platform)
+    set(FLUX_SDK_PLATFORM ${platform})
+    message("Platform:\t${FLUX_SDK_PLATFORM}")
+endmacro ()
+
+# ##################################################################################################
+# flux_sdk_set_project_directory()
+#
+macro (flux_sdk_set_project_directory project_directory)
+
+    set(PROJECT_FLUX_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${project_directory}/SparkFun_Flux)
+
+    if (NOT EXISTS ${PROJECT_FLUX_DIRECTORY})
+        message(STATUS "Creating directory: ${PROJECT_FLUX_DIRECTORY}")
+        file(MAKE_DIRECTORY ${PROJECT_FLUX_DIRECTORY})
+    endif ()
+    if (NOT EXISTS ${PROJECT_FLUX_DIRECTORY}/src)
+        file(MAKE_DIRECTORY ${PROJECT_FLUX_DIRECTORY}/src)
+    endif ()
+    if (NOT EXISTS ${PROJECT_FLUX_DIRECTORY}/src/Flux)
+        file(MAKE_DIRECTORY ${PROJECT_FLUX_DIRECTORY}/src/Flux)
+    endif ()
+
+endmacro ()
+# ##################################################################################################
+# flux_sdk_add_module()
+#
+# macro to add "modules" to our list of modules to add to the build
+macro (flux_sdk_add_module)
+    set(list_var "${ARGN}")
+    foreach (arg IN LISTS list_var)
+        list(APPEND FLUX_MODULES_TO_ADD ${arg})
+    endforeach ()
+endmacro ()
+
+function (flux_sdk_get_directory_name result_name)
+    get_filename_component(THIS_MODULE ${CMAKE_CURRENT_SOURCE_DIR} NAME)
+    set(${result_name}
+        ${THIS_MODULE}
+        PARENT_SCOPE)
+endfunction ()
+
+# ##################################################################################################
+# flux_sdk_add_source_files()
+#
+# Macro to add a file to our build system file list
+macro (flux_sdk_add_source_files)
+    set(list_var "${ARGN}")
+    foreach (arg IN LISTS list_var)
+        configure_file(${arg} ${PROJECT_FLUX_DIRECTORY}/src/Flux COPYONLY)
+    endforeach ()
+endmacro ()
+
+# ##################################################################################################
+# flux_sdk_is_module_enabled()
+#
+# Define a function that will check if a module is enabled in the list of enabled modules
+
+function (flux_sdk_is_module_enabled module_name result)
+    if (${module_name} IN_LIST FLUX_MODULES_TO_ADD)
+        set(${result}
+            TRUE
+            PARENT_SCOPE)
+    else ()
+        set(${result}
+            FALSE
+            PARENT_SCOPE)
+    endif ()
+endfunction ()
+
+# ##################################################################################################
+# flux_sdk_process_subdirectories()
+#
+# Define a function that will cacade down subdirectories if that directory is a module desired, and
+# has a CMakeLists.txt file.
+#
+# Note: If the <directory>_all_modules flag is set, then all submodules of that directory will be
+# processed
+
+function (flux_sdk_process_subdirectories)
+
+    # get our place in the SDK - print a value
+    file(RELATIVE_PATH local_path ${FLUX_SDK_PATH} ${CMAKE_CURRENT_SOURCE_DIR})
+    message("Processing:\t\$FLUX_SDK/${local_path}")
+
+    # Get the name of the current directory - basename. We use this to build our "all submodules"
+    # flag for this directory
+    get_filename_component(CurrentDir ${CMAKE_CURRENT_SOURCE_DIR} NAME)
+    set(all_modules_flag "${CurrentDir}_all_modules")
+
+    # is the flag set?
+    flux_sdk_is_module_enabled(${all_modules_flag} process_all_submodules)
+
+    # is everything enabled?
+    flux_sdk_is_module_enabled(flux_all_modules process_all_modules)
+
+    message("Module flag:\t${all_modules_flag} = ${process_all_submodules}")
+
+    # are we loading all submodules?
+    if (process_all_submodules OR process_all_modules)
+        set(load_all_modules TRUE)
+    endif ()
+
+    # Get all the children of this directory
+    file(
+        GLOB children
+        RELATIVE ${CMAKE_CURRENT_SOURCE_DIR}
+        ${CMAKE_CURRENT_SOURCE_DIR}/*)
+
+    # Iterate over all the children
+    foreach (child ${children})
+
+        # Sanity check
+        if (IS_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/${child}
+            AND EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${child}/CMakeLists.txt)
+
+            # add this module - in list, or all devices flag set
+            if (load_all_modules OR ${child} IN_LIST FLUX_MODULES_TO_ADD)
+                message(STATUS "Adding: ${child}")
+                add_subdirectory(${child})
+            endif ()
+        endif ()
+    endforeach ()
+    message("")
+endfunction ()
+
+# ##################################################################################################
+# flux_sdk_init()
+#
+# Called to start the SDK build process. This should be called after the flux_sdk import cmake file
+# is loaded (of course)
+macro (flux_sdk_init)
+    if (NOT CMAKE_PROJECT_NAME)
+        message(WARNING "flux_sdk_init() should be called after the project is created")
+    endif ()
+
+    # write some info!
+    message("\n-----------------------------------------------------")
+    message("SparkFun Flux SDK - Version: ${FLUX_SDK_VERSION}")
+    message("-----------------------------------------------------\n")
+    message("SDK Path:\t${FLUX_SDK_PATH}")
+    message("Project Name:\t${CMAKE_PROJECT_NAME}")
+    message("Destination:\t${PROJECT_FLUX_DIRECTORY}")
+    message("")
+
+    # is everything enabled?
+    flux_sdk_is_module_enabled(flux_all_modules process_all_modules)
+    message("Module flag:\tflux_all_modules = ${process_all_modules}")
+
+    if (NOT DEFINED FLUX_SDK_PLATFORM)
+        message(
+            FATAL_ERROR
+                "No platform specified. Set the target platform using `flux_sdk_set_platform()` in your projects CMakeLists.txt file"
+        )
+    endif ()
+    message("Platform:\t${FLUX_SDK_PLATFORM}")
+
+    string(TIMESTAMP COMPILE_TIME "%Y-%m-%d %H:%M:%S")
+    message("Build Time:\t${COMPILE_TIME}")
+    message("")
+
+    # load the root directory of the SDK
+    add_subdirectory(${FLUX_SDK_PATH} flux-sdk)
+
+endmacro ()

flux_sdk_version.cmake

@@ -0,0 +1,9 @@
+# define a version for the SDK
+
+set(FLUX_SDK_VERSION_MAJOR 1)
+set(FLUX_SDK_VERSION_MINOR 3)
+set(FLUX_SDK_VERSION_PATCH 0)
+set(FLUX_SDK_VERSION_TITLE "In Development")
+set(FLUX_SDK_VERSION
+    "${FLUX_SDK_VERSION_MAJOR}.${FLUX_SDK_VERSION_MINOR}.${FLUX_SDK_VERSION_PATCH} - ${FLUX_SDK_VERSION_TITLE}"
+)

src/CMakeLists.txt

@@ -0,0 +1,6 @@
+# just add our subdirectories -- recurse down the tree
+add_subdirectory(core)
+add_subdirectory(device)
+add_subdirectory(iot)
+add_subdirectory(net)
+add_subdirectory(platform)

src/core/CMakeLists.txt

@@ -0,0 +1,2 @@
+# Process all sub-modules
+flux_sdk_process_subdirectories()

src/core/flux_base/CMakeLists.txt

@@ -0,0 +1,34 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(
+    flxBusI2C.cpp
+    flxBusI2C.h
+    flxBusSPI.cpp
+    flxBusSPI.h
+    flxCore.cpp
+    flxCore.h
+    flxCoreDevice.cpp
+    flxCoreDevice.h
+    flxCoreEvent.h
+    flxCoreEvent.cpp
+    flxCoreEventID.h
+    flxCoreInterface.h
+    flxCoreJobs.cpp
+    flxCoreJobs.h
+    flxCoreLog.cpp
+    flxCoreLog.h
+    flxCoreMsg.cpp
+    flxCoreMsg.h
+    flxCoreParam.h
+    flxCoreProps.h
+    flxCoreTypes.h
+    flxDevice.h
+    flxFlux.h
+    flxSerial.cpp
+    flxSerial.h
+    flxTimer.h
+    flxUtils.cpp
+    flxUtils.h
+    spSpark.cpp)
+
+# the flux include file is special - its our hook for the Arduino "library" being created
+configure_file(Flux.h ${PROJECT_FLUX_DIRECTORY}/src COPYONLY)

src/Flux.h renamed to src/core/flux_base/Flux.h

@@ -18,5 +18,4 @@
 
 #include "Flux/flxCore.h"
 #include "Flux/flxDevice.h"
-
 #include "Flux/flxFlux.h"

src/Flux/flxBusI2C.cpp renamed to src/core/flux_base/flxBusI2C.cpp

@@ -0,0 +1,3 @@
+
+# Add the source files for this directory
+flux_sdk_add_source_files(flxClock.h flxClock.cpp)    

src/Flux/flxBusI2C.h renamed to src/core/flux_base/flxBusI2C.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxFileRotate.h flxFileRotate.cpp flxFS.h)

src/Flux/flxBusSPI.cpp renamed to src/core/flux_base/flxBusSPI.cpp

@@ -0,0 +1,3 @@
+
+# Add the source files for this directory
+flux_sdk_add_source_files(flxSysFirmware.h flxSysFirmware.cpp)    

src/Flux/flxBusSPI.h renamed to src/core/flux_base/flxBusSPI.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxFmtCSV.h flxFmtJSON.h flxLogger.cpp flxLogger.h flxOutput.h)

src/Flux/flxCore.cpp renamed to src/core/flux_base/flxCore.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxSettings.h flxSettings.cpp flxStorage.cpp flxStorage.h)

src/Flux/flxCore.h renamed to src/core/flux_base/flxCore.h

@@ -0,0 +1,3 @@
+
+# Add the source files for this directory
+flux_sdk_add_source_files(flxStorageJSONPref.h flxStorageJSONPref.cpp)    

src/Flux/flxCoreDevice.cpp renamed to src/core/flux_base/flxCoreDevice.cpp

@@ -0,0 +1,3 @@
+
+# Add the source files for this directory
+flux_sdk_add_source_files(flxSerialField.h flxSerialField.cpp flxSettingsSerial.cpp flxSettingsSerial.h)    

src/Flux/flxCoreDevice.h renamed to src/core/flux_base/flxCoreDevice.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxFSSDMMCard.h flxFSSDMMCard.cpp)

src/Flux/flxCoreEvent.cpp renamed to src/core/flux_base/flxCoreEvent.cpp

@@ -0,0 +1,2 @@
+# Process all sub-modules
+flux_sdk_process_subdirectories()

src/Flux/flxCoreEvent.h renamed to src/core/flux_base/flxCoreEvent.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevACS37800.h flxDevACS37800.cpp)

src/Flux/flxCoreEventID.h renamed to src/core/flux_base/flxCoreEventID.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevADS1015.h flxDevADS1015.cpp)

src/Flux/flxCoreInterface.h renamed to src/core/flux_base/flxCoreInterface.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevADS122C04.h flxDevADS122C04.cpp)

src/Flux/flxCoreJobs.cpp renamed to src/core/flux_base/flxCoreJobs.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevAHT20.h flxDevAHT20.cpp)

src/Flux/flxCoreJobs.h renamed to src/core/flux_base/flxCoreJobs.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevAMG8833.h flxDevAMG8833.cpp)

src/Flux/flxCoreLog.cpp renamed to src/core/flux_base/flxCoreLog.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevAS7265x.h flxDevAS7265x.cpp)

src/Flux/flxCoreLog.h renamed to src/core/flux_base/flxCoreLog.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevBioHub.h flxDevBioHub.cpp)

src/Flux/flxCoreMsg.cpp renamed to src/core/flux_base/flxCoreMsg.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevBME280.h flxDevBME280.cpp)

src/Flux/flxCoreMsg.h renamed to src/core/flux_base/flxCoreMsg.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevBME68x.h flxDevBME68x.cpp)

src/Flux/flxCoreParam.h renamed to src/core/flux_base/flxCoreParam.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevBMP384.h flxDevBMP384.cpp)

src/Flux/flxCoreProps.h renamed to src/core/flux_base/flxCoreProps.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevBMP581.h flxDevBMP581.cpp)

src/Flux/flxCoreTypes.h renamed to src/core/flux_base/flxCoreTypes.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevButton.h flxDevButton.cpp)

src/Flux/flxDevice.h renamed to src/core/flux_base/flxDevice.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevCCS811.h flxDevCCS811.cpp)

src/Flux/flxFlux.h renamed to src/core/flux_base/flxFlux.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevENS160.h flxDevENS160.cpp)

src/Flux/flxSerial.cpp renamed to src/core/flux_base/flxSerial.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevFS3000.h flxDevFS3000.cpp)

src/Flux/flxSerial.h renamed to src/core/flux_base/flxSerial.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevGNSS.h flxDevGNSS.cpp)

src/Flux/flxTimer.h renamed to src/core/flux_base/flxTimer.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevISM330.h flxDevISM330.cpp)

src/Flux/flxUtils.cpp renamed to src/core/flux_base/flxUtils.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevLPS25HB.h flxDevLPS25HB.cpp)

src/Flux/flxUtils.h renamed to src/core/flux_base/flxUtils.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevMAX17048.h flxDevMAX17048.cpp)

src/Flux/spSpark.cpp renamed to src/core/flux_base/spSpark.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevMCP9600.h flxDevMCP9600.cpp)

src/core/flux_clock/CMakeLists.txt

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevMicroPressure.h flxDevMicroPressure.cpp)

src/Flux/flxClock.cpp renamed to src/core/flux_clock/flxClock.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevMMC5983.h flxDevMMC5983.cpp)

src/Flux/flxClock.h renamed to src/core/flux_clock/flxClock.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevMS5637.h flxDevMS5637.cpp)

src/core/flux_file/CMakeLists.txt

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevMS8607.h flxDevMS8607.cpp)

src/Flux/flxFS.h renamed to src/core/flux_file/flxFS.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevNAU7802.h flxDevNAU7802.cpp)

src/Flux/flxFileRotate.cpp renamed to src/core/flux_file/flxFileRotate.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevOPT4048.h flxDevOPT4048.cpp)

src/Flux/flxFileRotate.h renamed to src/core/flux_file/flxFileRotate.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevPASCO2V01.h flxDevPASCO2V01.cpp)

src/core/flux_firmware/CMakeLists.txt

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevRV8803.h flxDevRV8803.cpp)

src/Flux/flxSysFirmware.cpp renamed to src/core/flux_firmware/flxSysFirmware.cpp

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevSCD30.h flxDevSCD30.cpp)

src/Flux/flxSysFirmware.h renamed to src/core/flux_firmware/flxSysFirmware.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevSCD40.h flxDevSCD40.cpp)

src/core/flux_logging/CMakeLists.txt

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevSDP3X.h flxDevSDP3X.cpp)

src/Flux/flxFmtCSV.h renamed to src/core/flux_logging/flxFmtCSV.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevSEN54.h flxDevSEN54.cpp)

src/Flux/flxFmtJSON.h renamed to src/core/flux_logging/flxFmtJSON.h

@@ -0,0 +1,2 @@
+# Add the source files for this directory
+flux_sdk_add_source_files(flxDevSGP30.h flxDevSGP30.cpp)