From 14644ec771ab5fb3eb9b4cb93f3504472ae5e31c Mon Sep 17 00:00:00 2001
From: Federico Lolli <federico.lolli@skywarder.eu>
Date: Sun, 29 Oct 2023 14:11:53 +0100
Subject: [PATCH] [SFD] added SFD sensor (without documentation)
---
cmake/boardcore.cmake | 1 +
src/shared/sensors/SFD/PressureSFD.cpp | 205 +++++++++++++++++++++++
src/shared/sensors/SFD/PressureSFD.h | 103 ++++++++++++
src/shared/sensors/SFD/PressureSFDData.h | 40 +++++
4 files changed, 349 insertions(+)
create mode 100644 src/shared/sensors/SFD/PressureSFD.cpp
create mode 100644 src/shared/sensors/SFD/PressureSFD.h
create mode 100644 src/shared/sensors/SFD/PressureSFDData.h
diff --git a/cmake/boardcore.cmake b/cmake/boardcore.cmake
index 78cef4792..ae888abc8 100644
--- a/cmake/boardcore.cmake
+++ b/cmake/boardcore.cmake
@@ -116,6 +116,7 @@ foreach(OPT_BOARD ${BOARDS})
${SBS_BASE}/src/shared/sensors/LPS28DFW/LPS28DFW.cpp
${SBS_BASE}/src/shared/sensors/LPS22DF/LPS22DF.cpp
${SBS_BASE}/src/shared/sensors/LSM6DSRX/LSM6DSRX.cpp
+ ${SBS_BASE}/src/shared/sensors/SFD/PressureSFD.cpp
# Calibration
${SBS_BASE}/src/shared/sensors/calibration/BiasCalibration/BiasCalibration.cpp
diff --git a/src/shared/sensors/SFD/PressureSFD.cpp b/src/shared/sensors/SFD/PressureSFD.cpp
new file mode 100644
index 000000000..6740322cd
--- /dev/null
+++ b/src/shared/sensors/SFD/PressureSFD.cpp
@@ -0,0 +1,205 @@
+/* Copyright (c) 2023 Skyward Experimental Rocketry
+ * Author: Federico Lolli
+ *
+ * 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.
+ */
+
+#include "PressureSFD.h"
+
+#include <sensors/Sensor.h>
+#include <sensors/SensorData.h>
+
+#include <Eigen/Core>
+
+namespace Boardcore
+{
+
+PressureSFD::PressureSFD(const SFDConfig& config)
+ : sfdAscent(config.sfdAscentConfig), sfdDescent(config.sfdDescentConfig),
+ currentMode(SFDMode::UNSET), k(0), weights({0}),
+ lowPassFilter(config.lowPassConfig), medianFilter(), pressSamplers({0}),
+ disabledSensors({0}), sampleWindow()
+{
+ // fill the weights array
+ std::fill(weights.begin(), weights.end(), 1.0);
+}
+
+void PressureSFD::setPressureSample(std::function<PressureData()> sample,
+ int index)
+{
+ pressSamplers[index] = sample;
+}
+
+void PressureSFD::setMode(SFDMode mode)
+{
+ currentMode = mode;
+ // update k (step size)
+ switch (mode)
+ {
+ case SFDMode::ACTIVE_ASCENT:
+ k = K_ACTIVE_ASCENT;
+ break;
+
+ case SFDMode::PASSIVE_ASCENT:
+ k = K_PASSIVE_ASCENT;
+ break;
+
+ case SFDMode::APOGEE_PROXIMITY:
+ k = K_APOGEE_PROXIMITY;
+ break;
+
+ case SFDMode::DESCENT:
+ k = K_DESCENT;
+ break;
+ }
+}
+
+PressureSFDData PressureSFD::sampleImpl()
+{
+ PressureSFDData data;
+ PressureData sample;
+ std::array<float, MASKED_SENSORS> samples;
+
+ // get the samples from the sampler and get the latest timestamp
+ for (int i = 0; i < MASKED_SENSORS; i++)
+ {
+ sample = pressSamplers[i]();
+
+ samples[i] = sample.pressure;
+
+ // update the timestamp based on the last sample
+ if (i == 0)
+ data.timestamp = sample.pressureTimestamp;
+ else
+ data.timestamp = std::max(data.timestamp, sample.pressureTimestamp);
+ }
+
+ // update the sliding window
+ sampleWindow.push(samples);
+
+ // if the windows is full and the mode is set we proceed by using the sfd
+ // classification to exclude nodes otherwise we leave all the nodes enabled
+ if (sampleWindow.isFull() && currentMode != SFDMode::UNSET)
+ setDisabledSensors();
+
+ stepWeights();
+
+ float processed_value;
+
+ processed_value = getWeightedAverage(samples);
+ processed_value = medianFilter.filter(processed_value);
+ processed_value = lowPassFilter.filter(processed_value);
+
+ samples = sampleWindow.last();
+ data.filteredPressure = processed_value;
+
+ return data;
+}
+
+void PressureSFD::setDisabledSensors()
+{
+ // get the samples for each sensor from the sliding window (transpose)
+ SFDVectorIn sensor_window;
+ std::array<SFDVectorIn, MASKED_SENSORS> sensor_samples;
+ const auto& full_samples = sampleWindow.all();
+
+ // fill eigen vectors with samples stored in window
+ for (int i = 0; i < MASKED_SENSORS; i++)
+ {
+ sensor_window = SFDVectorIn::Zero();
+ for (size_t j = 0; j < WIN_LEN; j++)
+ {
+ sensor_window(j) = full_samples[j][i];
+ }
+ sensor_samples[i] = sensor_window;
+ }
+
+ unsigned int skipped = 0;
+ switch (currentMode)
+ {
+ case SFDMode::ACTIVE_ASCENT:
+ case SFDMode::PASSIVE_ASCENT:
+ case SFDMode::APOGEE_PROXIMITY:
+ for (int i = 0; i < MASKED_SENSORS; i++)
+ {
+ if (disabledSensors[i])
+ {
+ skipped++;
+ continue;
+ }
+ // TODO: check if the score is correct (true means faulty)
+ if (sfdAscent.classify(sensor_samples[i]))
+ {
+ disabledSensors[i] = true;
+ skipped++;
+ }
+ }
+ break;
+
+ case SFDMode::DESCENT:
+ for (int i = 0; i < MASKED_SENSORS; i++)
+ {
+ if (disabledSensors[i])
+ {
+ skipped++;
+ continue;
+ }
+ // TODO: check if the score is correct (true means faulty)
+ if (sfdDescent.classify(sensor_samples[i]))
+ {
+ disabledSensors[i] = true;
+ skipped++;
+ }
+ }
+ break;
+ }
+
+ // reset all sensors if all of them are faulty
+ if (skipped == MASKED_SENSORS)
+ {
+ for (int i = 0; i < MASKED_SENSORS; i++)
+ {
+ disabledSensors[i] = false;
+ }
+ }
+}
+
+void PressureSFD::stepWeights()
+{
+ for (int i = 0; i < MASKED_SENSORS; i++)
+ {
+ if (disabledSensors[i])
+ weights[i] = std::max(weights[i] - k, MIN_WEIGHT);
+ else
+ weights[i] = std::min(weights[i] + k, MAX_WEIGHT);
+ }
+}
+
+float PressureSFD::getWeightedAverage(std::array<float, MASKED_SENSORS> samples)
+{
+ float weighted_sum = 0, weights_sum = 0;
+ for (int i = 0; i < MASKED_SENSORS; i++)
+ {
+ weighted_sum += samples[i] * weights[i];
+ weights_sum += weights[i];
+ }
+ return weighted_sum / weights_sum;
+}
+
+} // namespace Boardcore
diff --git a/src/shared/sensors/SFD/PressureSFD.h b/src/shared/sensors/SFD/PressureSFD.h
new file mode 100644
index 000000000..070966abf
--- /dev/null
+++ b/src/shared/sensors/SFD/PressureSFD.h
@@ -0,0 +1,103 @@
+/* Copyright (c) 2023 Skyward Experimental Rocketry
+ * Author: Federico Lolli
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include <algorithms/Filters/AdjustableMedFilter.h>
+#include <algorithms/Filters/LowPass.h>
+#include <algorithms/SFD/SFDAscent.h>
+#include <algorithms/SFD/SFDCommon.h>
+#include <algorithms/SFD/SFDDescent.h>
+#include <sensors/Sensor.h>
+#include <sensors/SensorData.h>
+#include <utils/SlidingWindow.h>
+
+#include "PressureSFDData.h"
+
+namespace Boardcore
+{
+
+enum class SFDMode
+{
+ UNSET,
+ ACTIVE_ASCENT,
+ PASSIVE_ASCENT,
+ APOGEE_PROXIMITY,
+ DESCENT
+};
+
+class PressureSFD : public Sensor<PressureSFDData>
+{
+public:
+ static constexpr int MASKED_SENSORS = 2;
+ static constexpr int WIN_LEN = MASKED_SENSORS * LEN_CHUNK;
+
+ // TODO: set these values
+ static constexpr float K_ACTIVE_ASCENT = 0;
+ static constexpr float K_PASSIVE_ASCENT = 0;
+ static constexpr float K_APOGEE_PROXIMITY = 0;
+ static constexpr float K_DESCENT = 0;
+ static constexpr float MAX_WEIGHT = 1;
+ static constexpr float MIN_WEIGHT = 0;
+
+ using SVMAscVec = Eigen::Vector<float, SFDAscent::NUM_FEATURES>;
+ using SVMDescVec = Eigen::Vector<float, SFDDescent::NUM_FEATURES>;
+
+ struct SFDConfig
+ {
+ SFDAscent::SFDAscentConfig sfdAscentConfig;
+ SFDDescent::SFDDescentConfig sfdDescentConfig;
+ LowPass::LowPassConfig lowPassConfig;
+ };
+
+ explicit PressureSFD(const SFDConfig& config);
+
+ bool init() override { return true; }
+ bool selfTest() override { return true; }
+
+ void setPressureSample(std::function<PressureData()> sample, int index);
+
+ void setMode(SFDMode mode);
+
+private:
+ void setDisabledSensors();
+ void stepWeights();
+ float getWeightedAverage(std::array<float, MASKED_SENSORS> samples);
+ PressureSFDData sampleImpl() override;
+
+ SFDAscent sfdAscent;
+ SFDDescent sfdDescent;
+ SFDMode currentMode;
+
+ float k;
+ std::array<float, MASKED_SENSORS> weights;
+
+ LowPass lowPassFilter;
+ AdjustableMedFilter<WIN_LEN> medianFilter;
+
+ std::array<std::function<PressureData()>, MASKED_SENSORS> pressSamplers;
+ std::array<bool, MASKED_SENSORS> disabledSensors;
+
+ SlidingWindow<std::array<float, MASKED_SENSORS>, WIN_LEN> sampleWindow;
+};
+
+} // namespace Boardcore
diff --git a/src/shared/sensors/SFD/PressureSFDData.h b/src/shared/sensors/SFD/PressureSFDData.h
new file mode 100644
index 000000000..50a271f21
--- /dev/null
+++ b/src/shared/sensors/SFD/PressureSFDData.h
@@ -0,0 +1,40 @@
+/* Copyright (c) 2023 Skyward Experimental Rocketry
+ * Author: Federico Lolli
+ *
+ * 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.
+ */
+
+#pragma once
+
+#include <sensors/SensorData.h>
+
+#include <array>
+
+struct PressureSFDData
+{
+ uint64_t timestamp = 0;
+ float filteredPressure = 0;
+
+ static std::string header() { return "timestamp,filteredPressure"; }
+
+ void print(std::ostream& os) const
+ {
+ os << timestamp << "," << filteredPressure << "\n";
+ }
+};
--
GitLab