Merge pull request #98 from senseshift/feature/interpolation-coverage

feat: deduct interpolation template
senseshift · Feb 22, 2024 · 17a13e9 · 17a13e9
2 parents 47ba284 + c7afbe4
commit 17a13e9
Show file tree

Hide file tree

Showing 24 changed files with 127 additions and 93 deletions.
diff --git a/.github/scripts/get_firmware_name.sh b/.github/scripts/get_firmware_name.sh
@@ -8,12 +8,12 @@ getBhapticsName() {
     echo "::debug::Getting bHaptics name for $target"
     echo "::debug::Flags are $flags"
 
-    if [[ $flags =~ SENSESHIFT_BLE_USE_NIMBLE=true ]]; then
+    if [[ $flags =~ SS_BLE_USE_NIMBLE=true ]]; then
         echo "::debug::Nimble is enabled, appending +nimble to the target"
         target="$target+nimble"
     fi
 
-    if [[ $flags =~ SENSESHIFT_BATTERY_ENABLED=true ]]; then
+    if [[ $flags =~ SS_BATTERY_ENABLED=true ]]; then
         echo "::debug::Battery is enabled, appending +battery to the target"
         target="$target+battery"
     fi

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,27 +32,27 @@ jobs:
           - bhaptics_tactal
           - bhaptics_tactvisor
           - bhaptics_tactglove_right
-        battery_flag: [ SENSESHIFT_BATTERY_ENABLED=true ]
-        nimble_flag: [ SENSESHIFT_BLE_USE_NIMBLE=false ]
+        battery_flag: [ SS_BATTERY_ENABLED=true ]
+        nimble_flag: [ SS_BLE_USE_NIMBLE=false ]
         coverage: [ false ]
 
         include:
           # Extra tests for x40, as it uses the most features
           - target: bhaptics_tactsuit_x40
             os: ubuntu-latest
             coverage: true
-            battery_flag: SENSESHIFT_BATTERY_ENABLED=true
-            nimble_flag: SENSESHIFT_BLE_USE_NIMBLE=true
+            battery_flag: SS_BATTERY_ENABLED=true
+            nimble_flag: SS_BLE_USE_NIMBLE=true
           # - target: bhaptics_tactsuit_x40
           #   os: ubuntu-latest
           #   coverage: true
-          #   battery_flag: SENSESHIFT_BATTERY_ENABLED=true
-          #   nimble_flag: SENSESHIFT_BLE_USE_NIMBLE=false
+          #   battery_flag: SS_BATTERY_ENABLED=true
+          #   nimble_flag: SS_BLE_USE_NIMBLE=false
           - target: bhaptics_tactsuit_x40
             os: ubuntu-latest
             coverage: false
-            battery_flag: SENSESHIFT_BATTERY_ENABLED=true
-            nimble_flag: SENSESHIFT_BLE_USE_NIMBLE=true
+            battery_flag: SS_BATTERY_ENABLED=true
+            nimble_flag: SS_BLE_USE_NIMBLE=true
 
     steps:
       - uses: actions/checkout@v3

diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
@@ -31,7 +31,7 @@ jobs:
 
         # Enabling all flags to test build for every feature
         battery_flag:
-          - SENSESHIFT_BATTERY_ENABLED=true
+          - SS_BATTERY_ENABLED=true
 
     steps:
       - name: Checkout repository

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -33,9 +33,9 @@ jobs:
           - bhaptics_tactglove_left
           - bhaptics_tactglove_right
         battery_flag:
-          - SENSESHIFT_BATTERY_ENABLED=true
+          - SS_BATTERY_ENABLED=true
         nimble_flag:
-          - SENSESHIFT_BLE_USE_NIMBLE=true
+          - SS_BLE_USE_NIMBLE=true
 
     steps:
       - uses: actions/checkout@v3

diff --git a/firmware/mode_configs/bhaptics/tactal.cpp b/firmware/mode_configs/bhaptics/tactal.cpp
@@ -55,16 +55,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/firmware/mode_configs/bhaptics/tactglove.cpp b/firmware/mode_configs/bhaptics/tactglove.cpp
@@ -28,7 +28,7 @@ using namespace SenseShift::Body::Haptics;
 extern Application App;
 Application* app = &App;
 
-static constexpr Body::Hands::HandSide handSide = Body::Hands::HandSide::SENSESHIFT_HAND_SIDE;
+static constexpr Body::Hands::HandSide handSide = Body::Hands::HandSide::SS_HAND_SIDE;
 // clang-format off
 static const auto& bhLayout = handSide == Body::Hands::HandSide::Left ? BH::TactGloveLeftLayout : BH::TactGloveRightLayout;
 // clang-format on
@@ -63,16 +63,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/firmware/mode_configs/bhaptics/tactosy2.cpp b/firmware/mode_configs/bhaptics/tactosy2.cpp
@@ -56,16 +56,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/firmware/mode_configs/bhaptics/tactosyf.cpp b/firmware/mode_configs/bhaptics/tactosyf.cpp
@@ -57,16 +57,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/firmware/mode_configs/bhaptics/tactosyh.cpp b/firmware/mode_configs/bhaptics/tactosyh.cpp
@@ -57,16 +57,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/firmware/mode_configs/bhaptics/tactsuit_x16.cpp b/firmware/mode_configs/bhaptics/tactsuit_x16.cpp
@@ -66,16 +66,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/firmware/mode_configs/bhaptics/tactsuit_x16_pca9685.cpp b/firmware/mode_configs/bhaptics/tactsuit_x16_pca9685.cpp
@@ -71,16 +71,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/firmware/mode_configs/bhaptics/tactsuit_x40.cpp b/firmware/mode_configs/bhaptics/tactsuit_x40.cpp
@@ -80,16 +80,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/firmware/mode_configs/bhaptics/tactvisor.cpp b/firmware/mode_configs/bhaptics/tactvisor.cpp
@@ -55,16 +55,16 @@ void setupMode()
     );
     bhBleConnection->begin();
 
-#if defined(SENSESHIFT_BATTERY_ENABLED) && SENSESHIFT_BATTERY_ENABLED == true
+#if defined(SS_BATTERY_ENABLED) && SS_BATTERY_ENABLED == true
     auto* batteryVoltageSensor = new SimpleSensorDecorator(new AnalogSimpleSensor(36));
     batteryVoltageSensor->addFilters({
       new MultiplyFilter(3.3F),                      // Convert to raw pin voltage
       new VoltageDividerFilter(27000.0F, 100000.0F), // Convert to voltage divider voltage
     });
     auto* batteryTask = new ::SenseShift::FreeRTOS::ComponentUpdateTask<SimpleSensorDecorator<float>>(
       batteryVoltageSensor,
-      SENSESHIFT_BATTERY_SAMPLE_RATE,
-      { "ADC Battery", 4096, SENSESHIFT_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
+      SS_BATTERY_SAMPLE_RATE,
+      { "ADC Battery", 4096, SS_BATTERY_TASK_PRIORITY, tskNO_AFFINITY }
     );
     batteryTask->begin();
 

diff --git a/include/config/battery.h b/include/config/battery.h
@@ -1,17 +1,17 @@
 #pragma once
 
-#ifndef SENSESHIFT_BATTERY_ENABLED
-#define SENSESHIFT_BATTERY_ENABLED false
+#ifndef SS_BATTERY_ENABLED
+#define SS_BATTERY_ENABLED false
 #endif
 
-#ifndef SENSESHIFT_BATTERY_SAMPLE_RATE
-#define SENSESHIFT_BATTERY_SAMPLE_RATE 10000
+#ifndef SS_BATTERY_SAMPLE_RATE
+#define SS_BATTERY_SAMPLE_RATE 10000
 #endif
 
-#ifndef SENSESHIFT_BATTERY_THRESHOLD_PERCENTAGE
-#define SENSESHIFT_BATTERY_THRESHOLD_PERCENTAGE 20
+#ifndef SS_BATTERY_THRESHOLD_PERCENTAGE
+#define SS_BATTERY_THRESHOLD_PERCENTAGE 20
 #endif
 
-#ifndef SENSESHIFT_BATTERY_TASK_PRIORITY
-#define SENSESHIFT_BATTERY_TASK_PRIORITY 1
+#ifndef SS_BATTERY_TASK_PRIORITY
+#define SS_BATTERY_TASK_PRIORITY 1
 #endif
diff --git a/include/config/bluetooth.h b/include/config/bluetooth.h
@@ -11,6 +11,6 @@
     }
 #endif
 
-#ifndef SENSESHIFT_BLE_USE_NIMBLE
-#define SENSESHIFT_BLE_USE_NIMBLE false
+#ifndef SS_BLE_USE_NIMBLE
+#define SS_BLE_USE_NIMBLE false
 #endif
diff --git a/ini/bhaptics.ini b/ini/bhaptics.ini
@@ -263,7 +263,7 @@ monitor_speed     = ${bhaptics.monitor_speed}
 build_flags      =
     ${bhaptics.build_flags}
     -D BH_DEVICE_TACTGLOVE
-    -D SENSESHIFT_HAND_SIDE=Left
+    -D SS_HAND_SIDE=Left
     -D BH_BLE_APPEARANCE=508
     '-D BLUETOOTH_NAME="TactGlove (L"'
     '-D BH_SERIAL_NUMBER={ 0xcd, 0x0b, 0x81, 0x45, 0x85, 0xf9, 0x2b, 0x6c, 0xed, 0x5b }'
@@ -284,7 +284,7 @@ monitor_speed     = ${bhaptics.monitor_speed}
 build_flags      =
     ${bhaptics.build_flags}
     -D BH_DEVICE_TACTGLOVE
-    -D SENSESHIFT_HAND_SIDE=Right
+    -D SS_HAND_SIDE=Right
     -D BH_BLE_APPEARANCE=508
     '-D BLUETOOTH_NAME="TactGlove (R"'
     '-D BH_SERIAL_NUMBER={ 0x12, 0x0b, 0xae, 0xbf, 0xbc, 0x90, 0x3b, 0x0d, 0x84, 0xdd }'

diff --git a/lib/battery/senseshift/battery/input/battery_sensor.hpp b/lib/battery/senseshift/battery/input/battery_sensor.hpp
@@ -46,7 +46,10 @@ namespace SenseShift::Battery::Input {
       protected:
         [[nodiscard]] auto lookupInterpolateLevel(VoltageType voltage) -> float
         {
-            return ::SenseShift::lookup_table_interpolate<VoltageType, float, Container>(*this->lookup_table_, voltage);
+            return ::SenseShift::lookup_table_interpolate_linear<Container, VoltageType, float>(
+              *this->lookup_table_,
+              voltage
+            );
         }
 
       private:

diff --git a/lib/bhaptics_ble/senseshift/bh/ble/connection.cpp b/lib/bhaptics_ble/senseshift/bh/ble/connection.cpp
@@ -6,7 +6,7 @@
 
 #include <Arduino.h>
 
-#if defined(SENSESHIFT_BLE_USE_NIMBLE) && SENSESHIFT_BLE_USE_NIMBLE == true
+#if defined(SS_BLE_USE_NIMBLE) && SS_BLE_USE_NIMBLE == true
 // BLE2902 not needed: https://github.com/h2zero/NimBLE-Arduino/blob/release/1.4/docs/Migration_guide.md#descriptors
 
 #define PROPERTY_READ NIMBLE_PROPERTY::READ
@@ -77,7 +77,7 @@ namespace SenseShift::BH::BLE {
             );
         };
 
-#if defined(SENSESHIFT_BLE_USE_NIMBLE) && SENSESHIFT_BLE_USE_NIMBLE == true
+#if defined(SS_BLE_USE_NIMBLE) && SS_BLE_USE_NIMBLE == true
         void onStatus(BLECharacteristic* pCharacteristic, Status s, int code) override
 #else
         void onStatus(BLECharacteristic* pCharacteristic, Status s, uint32_t code) override
@@ -182,7 +182,7 @@ namespace SenseShift::BH::BLE {
                 | PROPERTY_NOTIFY // for whatever reason, it have to be writable, otherwise Desktop app crashes
             );
 
-#if !defined(SENSESHIFT_BLE_USE_NIMBLE) || SENSESHIFT_BLE_USE_NIMBLE != true
+#if !defined(SS_BLE_USE_NIMBLE) || SS_BLE_USE_NIMBLE != true
             batteryChar->addDescriptor(new BLE2902());
 #endif
 
@@ -209,7 +209,7 @@ namespace SenseShift::BH::BLE {
             );
             monitorChar->setCallbacks(new LogOutputCharCallbacks());
 
-#if !defined(SENSESHIFT_BLE_USE_NIMBLE) || SENSESHIFT_BLE_USE_NIMBLE != true
+#if !defined(SS_BLE_USE_NIMBLE) || SS_BLE_USE_NIMBLE != true
             monitorChar->addDescriptor(new BLE2902());
 #endif
 

diff --git a/lib/bhaptics_ble/senseshift/bh/ble/connection.hpp b/lib/bhaptics_ble/senseshift/bh/ble/connection.hpp
@@ -10,7 +10,7 @@
 #include <Arduino.h>
 #include <esp_wifi.h>
 
-#if defined(SENSESHIFT_BLE_USE_NIMBLE) && SENSESHIFT_BLE_USE_NIMBLE == true
+#if defined(SS_BLE_USE_NIMBLE) && SS_BLE_USE_NIMBLE == true
 #include <NimBLEDevice.h>
 #else
 #include <BLEDevice.h>