From 2c00a06bcb54208314b91c5216c500ba1c95ab5e Mon Sep 17 00:00:00 2001 From: Mark Nolan Date: Thu, 24 Sep 2026 18:32:32 +0100 Subject: [PATCH] DEV-1047: recognise a NeuroLynQ-mode Verisense as a GQ Docked, a Verisense in NeuroLynQ mode answers VER with its own hardware ID (61 to 68) and the GQ's firmware ID, GQ_802154. It answers and streams as a GQ does, but the host decided GQ-ness by hardware ID alone. So the bench node (hardware 68, v2.1.1) stayed an unrecognised device with "Unknown" firmware, and NeuroLynQ could not offer it for pairing. ShimmerVerObject - isVerisenseNeuroLynQ(): Verisense hardware running GQ_802154, the one firmware ID that identifies it. - isShimmerGenGq() includes it. Every caller, some 60 across the stack, uses the no-argument form, so this is the one place that decides. - isShimmerGenVerisense() excludes it. It sends GQ data, already scaled to the GQ's ADC, so SensorGSR must take the GQ's ADC properties rather than a Verisense's. - isSupportedConfigViaUart() and isSupportedRtcConfigViaUart() include it, so a dock reads and writes its InfoMem image and clock as it does a GQ's. The node implements both commands. - isSupportedSdCardAccess(), keyed on the GQ's firmware ID, excludes it: it has no SD card, and its USB has no mass storage. - Its firmware label follows, as "GQ_802154". Configuration: the GQ sensor compatibility lists match GQs by hardware, so each gains an entry matching GQ_802154 on any hardware. Only a NeuroLynQ-mode Verisense needs it. A stock Verisense, firmware VERISENSE, is unchanged. API_00014 covers it, a GQ, and every Verisense hardware ID. Co-Authored-By: Claude Opus 5.5 --- .../shimmerresearch/driver/Configuration.java | 18 ++-- .../driverUtilities/ShimmerVerObject.java | 25 +++++- ...I_00014_VerisenseNeuroLynQVersionTest.java | 86 +++++++++++++++++++ 3 files changed, 119 insertions(+), 10 deletions(-) create mode 100644 ShimmerDriver/src/test/java/com/shimmerresearch/driverUtilities/API_00014_VerisenseNeuroLynQVersionTest.java diff --git a/ShimmerDriver/src/main/java/com/shimmerresearch/driver/Configuration.java b/ShimmerDriver/src/main/java/com/shimmerresearch/driver/Configuration.java index bf813e203..12ca2b348 100644 --- a/ShimmerDriver/src/main/java/com/shimmerresearch/driver/Configuration.java +++ b/ShimmerDriver/src/main/java/com/shimmerresearch/driver/Configuration.java @@ -1337,6 +1337,10 @@ public static class CompatibilityInfoForMaps{ private static final ShimmerVerObject svoShimmerGq802154Lr = new ShimmerVerObject(HW_ID.SHIMMER_GQ_802154_LR,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION); private static final ShimmerVerObject svoShimmerGq802154Nr = new ShimmerVerObject(HW_ID.SHIMMER_GQ_802154_NR,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION); private static final ShimmerVerObject svoShimmer2rGq = new ShimmerVerObject(HW_ID.SHIMMER_2R_GQ,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION); + /** The GQ 802.15.4 firmware on any hardware. The GQs above are matched on their hardware, but a + * Verisense in NeuroLynQ mode keeps its own hardware ID (61 to 68), so it is matched on the firmware it + * runs: nothing else runs GQ_802154. See ShimmerVerObject.isVerisenseNeuroLynQ(). */ + private static final ShimmerVerObject svoVerisenseNeuroLynQ = new ShimmerVerObject(ShimmerVerDetails.ANY_VERSION,FW_ID.GQ_802154,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION,ShimmerVerDetails.ANY_VERSION); private static final ShimmerVerObject svoExgSdLog = new ShimmerVerObject(HW_ID.SHIMMER_3,FW_ID.SDLOG,0,8,0,HW_ID_SR_CODES.EXP_BRD_EXG); private static final ShimmerVerObject svoExgUnifiedSdLog = new ShimmerVerObject(HW_ID.SHIMMER_3,FW_ID.SDLOG,0,8,0,HW_ID_SR_CODES.EXP_BRD_EXG_UNIFIED); @@ -1406,7 +1410,7 @@ public static class CompatibilityInfoForMaps{ public static final List listOfCompatibleVersionInfoExgGeneral = Arrays.asList( svoExgSdLog, svoExgBtStream, svoExgLogAndStream, svoExgUnifiedSdLog, svoExgUnifiedBtStream, svoExgUnifiedLogAndStream, - svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, + svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ, svoShimmerECGmd, svoShimmer4Stock, svoStrokare, svoShimmer3RExgUnifiedLogAndStream); public static final List listOfCompatibleVersionInfoExgEmg = Arrays.asList( @@ -1418,22 +1422,22 @@ public static class CompatibilityInfoForMaps{ public static final List listOfCompatibleVersionInfoExgEcg = Arrays.asList( svoExgSdLog, svoExgBtStream, svoExgLogAndStream, svoExgUnifiedSdLog, svoExgUnifiedBtStream, svoExgUnifiedLogAndStream, - svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, + svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ, svoShimmerECGmd, svoShimmer4Stock, svoShimmer3RExgUnifiedLogAndStream); public static final List listOfCompatibleVersionInfoExgEcgGq = Arrays.asList( - svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq); + svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ); public static final List listOfCompatibleVersionInfoExgTest = Arrays.asList( svoExgSdLog, svoExgBtStream, svoExgLogAndStream, svoExgUnifiedSdLog, svoExgUnifiedBtStream, svoExgUnifiedLogAndStream, - svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, + svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ, svoShimmerECGmd, svoShimmer4Stock, svoShimmer3RExgUnifiedLogAndStream); public static final List listOfCompatibleVersionInfoExgThreeUnipolar = Arrays.asList( svoExgSdLog, svoExgBtStream, svoExgLogAndStream, svoExgUnifiedSdLog, svoExgUnifiedBtStream, svoExgUnifiedLogAndStream, - svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, + svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ, svoShimmerECGmd, svoShimmer4Stock, svoShimmer3RExgUnifiedLogAndStream); public static final List listOfCompatibleVersionInfoExgRespiration = Arrays.asList( @@ -1446,7 +1450,7 @@ public static class CompatibilityInfoForMaps{ public static final List listOfCompatibleVersionInfoAnyExpBoardStandardFW = Arrays.asList( svoAnyIntExpBoardAndSdlog,svoAnyIntExpBoardAndBtStream,svoAnyIntExpBoardAndLogAndStream, - svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoAnyIntExpBoardAndLogAndStream3R, + svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ, svoAnyIntExpBoardAndLogAndStream3R, svoShimmer4Stock, svoArduino, svoSweatch, svoStrokare); public static final List listOfCompatibleVersionInfoBattVoltage = Arrays.asList( @@ -1457,7 +1461,7 @@ public static class CompatibilityInfoForMaps{ public static final List listOfCompatibleVersionInfoGsr = Arrays.asList( svoGsrSdLog, svoGsrBtStream, svoGsrLogAndStream, svoGsrGqBle, svoGsrUnifiedSdLog, svoGsrUnifiedBtStream, svoGsrUnifiedLogAndStream, - svoGsrUnifiedGqBle, svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, + svoGsrUnifiedGqBle, svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ, svoShimmer4Stock, svoShimmer3RGsrUnifiedLogAndStream,svoShimmer3RGsrNewImuLogAndStream); public static final List listOfCompatibleVersionInfoBMP180 = Arrays.asList( diff --git a/ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java b/ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java index 19299843f..0ba6e4147 100644 --- a/ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java +++ b/ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java @@ -247,6 +247,7 @@ private void parseShimmerVerDetails() { || (mHardwareVersion==HW_ID.SHIMMER_GQ_BLE && mFirmwareIdentifier==FW_ID.GQ_BLE) || ((mHardwareVersion==HW_ID.SHIMMER_GQ_802154_NR || mHardwareVersion==HW_ID.SHIMMER_GQ_802154_LR) && mFirmwareIdentifier==FW_ID.GQ_802154) || (mHardwareVersion==HW_ID.SHIMMER_2R_GQ && mFirmwareIdentifier==FW_ID.GQ_802154) + || isVerisenseNeuroLynQ() || mHardwareVersion==HW_ID.SPAN || mHardwareVersion==HW_ID.SHIMMER_4_SDK || mHardwareVersion==HW_ID.SWEATCH @@ -410,6 +411,7 @@ public static boolean isSupportedRtcConfigViaUart(int hwVer, int fwId) { || (hwVer==HW_ID.SHIMMER_GQ_802154_NR) || (hwVer==HW_ID.SHIMMER_GQ_802154_LR) || (hwVer==HW_ID.SHIMMER_2R_GQ) + || isVerisenseNeuroLynQ(hwVer, fwId) || (hwVer==HW_ID.SHIMMER_4_SDK) || (hwVer==HW_ID.SHIMMER_3R)){ return true; @@ -427,6 +429,7 @@ public static boolean isSupportedConfigViaUart(int hwVer, int fwId) { || hwVer==HW_ID.SHIMMER_GQ_802154_NR || hwVer==HW_ID.SHIMMER_GQ_802154_LR || hwVer==HW_ID.SHIMMER_2R_GQ + || isVerisenseNeuroLynQ(hwVer, fwId) || hwVer==HW_ID.SHIMMER_4_SDK){ return true; } @@ -445,7 +448,8 @@ public static boolean isSupportedSdCardAccess(int hwVer, int fwId) { || (hwVer==HW_ID.SHIMMER_GQ_BLE && fwId == FW_ID.GQ_BLE) // || hwVer==HW_ID.SHIMMER_GQ_802154_NR // || hwVer==HW_ID.SHIMMER_GQ_802154_LR - || fwId==ShimmerVerDetails.FW_ID.GQ_802154 + // A NeuroLynQ-mode Verisense runs the GQ's firmware but has no SD card + || (fwId==ShimmerVerDetails.FW_ID.GQ_802154 && !isVerisenseNeuroLynQ(hwVer, fwId)) || hwVer==HW_ID.SHIMMER_2R_GQ || (hwVer==HW_ID.SHIMMER_4_SDK && fwId == FW_ID.SHIMMER4_SDK_STOCK) ){ @@ -645,13 +649,26 @@ public boolean isShimmerGenGq(int hwVer) { * @return */ public boolean isShimmerGenGq(int hwVer, int fwId) { - if(isShimmerGenGq(hwVer)){ + if(isShimmerGenGq(hwVer) || isVerisenseNeuroLynQ(hwVer, fwId)){ // if(((hwVer==HW_ID.SHIMMER_GQ_802154_LR) || (hwVer==HW_ID.SHIMMER_GQ_802154_NR) || (hwVer==HW_ID.SHIMMER_2R_GQ)) // && (fwId==FW_ID.GQ_802154 || fwId==FW_ID.GQ_BLE)){ return true; } return false; } + + /** + * A Verisense in NeuroLynQ mode (verisense-firmware ASM_NeuroLynQ): Verisense + * hardware running the GQ 802.15.4 firmware. It reports its own hardware ID, but it + * answers and streams as a GQ does, so to the host it is a GQ (DEV-1047). + */ + public boolean isVerisenseNeuroLynQ() { + return isVerisenseNeuroLynQ(getHardwareVersion(), getFirmwareIdentifier()); + } + + public static boolean isVerisenseNeuroLynQ(int hwVer, int fwId) { + return isShimmerGenVerisense(hwVer) && fwId==FW_ID.GQ_802154; + } public boolean isShimmerVideoDevice(){ return isShimmerVideoDevice(getHardwareVersion()); @@ -667,8 +684,10 @@ public static boolean isShimmerVideoDevice(int hardwareVersion) { return false; } + /** Verisense hardware running its own firmware. In NeuroLynQ mode it runs the GQ's + * firmware and sends GQ data instead, see {@link #isVerisenseNeuroLynQ()}. */ public boolean isShimmerGenVerisense() { - return isShimmerGenVerisense(getHardwareVersion()); + return isShimmerGenVerisense(getHardwareVersion()) && !isVerisenseNeuroLynQ(); } public static boolean isShimmerGenVerisense(int hwVer) { diff --git a/ShimmerDriver/src/test/java/com/shimmerresearch/driverUtilities/API_00014_VerisenseNeuroLynQVersionTest.java b/ShimmerDriver/src/test/java/com/shimmerresearch/driverUtilities/API_00014_VerisenseNeuroLynQVersionTest.java new file mode 100644 index 000000000..86ca69d53 --- /dev/null +++ b/ShimmerDriver/src/test/java/com/shimmerresearch/driverUtilities/API_00014_VerisenseNeuroLynQVersionTest.java @@ -0,0 +1,86 @@ +package com.shimmerresearch.driverUtilities; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +import org.junit.Test; + +import com.shimmerresearch.driverUtilities.ShimmerVerDetails.FW_ID; +import com.shimmerresearch.driverUtilities.ShimmerVerDetails.HW_ID; +import com.shimmerresearch.sensors.SensorADC.MICROCONTROLLER_ADC_PROPERTIES; + +/** + * A Verisense in NeuroLynQ mode is a GQ to the host (DEV-1047). + *

+ * Docked, it answers VER with its own hardware ID and the GQ's firmware ID. On the bench + * on 2026-09-24 that was hardware 68, firmware 9, v2.1.1, which the host used to leave as + * an unrecognised device with "Unknown" firmware. + */ +public class API_00014_VerisenseNeuroLynQVersionTest { + + private static final ShimmerVerObject NODE = new ShimmerVerObject(HW_ID.VERISENSE_PULSE_PLUS, FW_ID.GQ_802154, 2, 1, 1); + private static final ShimmerVerObject STOCK_VERISENSE = new ShimmerVerObject(HW_ID.VERISENSE_PULSE_PLUS, FW_ID.VERISENSE, 2, 1, 1); + private static final ShimmerVerObject GQ = new ShimmerVerObject(HW_ID.SHIMMER_GQ_802154_NR, FW_ID.GQ_802154, 1, 1, 1); + + @Test + public void aNeuroLynQVerisenseIsAGq() { + assertTrue(NODE.isVerisenseNeuroLynQ()); + assertTrue(NODE.isShimmerGenGq()); + assertFalse(NODE.isShimmerGenVerisense()); + } + + @Test + public void everyVerisenseRunningTheGqFirmwareIsAGq() { + for (int hwId : new int[] {HW_ID.VERISENSE_IMU, HW_ID.VERISENSE_GSR_PLUS, HW_ID.VERISENSE_PPG, + HW_ID.VERISENSE_DEV_BRD, HW_ID.VERISENSE_PULSE_PLUS}) { + assertTrue("hardware " + hwId, new ShimmerVerObject(hwId, FW_ID.GQ_802154, 2, 1, 1).isShimmerGenGq()); + } + } + + @Test + public void aStockVerisenseIsStillAVerisense() { + assertFalse(STOCK_VERISENSE.isVerisenseNeuroLynQ()); + assertFalse(STOCK_VERISENSE.isShimmerGenGq()); + assertTrue(STOCK_VERISENSE.isShimmerGenVerisense()); + } + + @Test + public void aGqIsUnchanged() { + assertTrue(GQ.isShimmerGenGq()); + assertFalse(GQ.isVerisenseNeuroLynQ()); + assertFalse(GQ.isShimmerGenVerisense()); + } + + @Test + public void itsFirmwareIsNamedAsAGqs() { + String gqFirmwareLabel = FW_ID.mMapOfFirmwareLabels.get(FW_ID.GQ_802154); + assertEquals(gqFirmwareLabel, NODE.mFirmwareIdentifierParsed); + assertEquals(gqFirmwareLabel + " v2.1.1", NODE.getFirmwareVersionParsed()); + } + + /** Docked, its InfoMem image and clock are read and written as a GQ's are */ + @Test + public void itIsConfiguredOverTheDockLinkAsAGqIs() { + assertTrue(NODE.isSupportedConfigViaUart()); + assertTrue(NODE.isSupportedRtcConfigViaUart()); + assertFalse(STOCK_VERISENSE.isSupportedConfigViaUart()); + assertFalse(STOCK_VERISENSE.isSupportedRtcConfigViaUart()); + } + + /** Unlike a GQ it has no SD card, and its USB has no mass storage */ + @Test + public void itHasNoSdCard() { + assertFalse(NODE.isSupportedSdCardAccess()); + assertTrue(GQ.isSupportedSdCardAccess()); + } + + /** It sends GQ data, already scaled to the GQ's ADC, so it takes the GQ's calibration */ + @Test + public void itTakesTheGqsAdcProperties() { + assertEquals(MICROCONTROLLER_ADC_PROPERTIES.getMicrocontrollerAdcPropertiesForShimmerVersionObject(GQ), + MICROCONTROLLER_ADC_PROPERTIES.getMicrocontrollerAdcPropertiesForShimmerVersionObject(NODE)); + assertEquals(MICROCONTROLLER_ADC_PROPERTIES.VERISENSE_1V8, + MICROCONTROLLER_ADC_PROPERTIES.getMicrocontrollerAdcPropertiesForShimmerVersionObject(STOCK_VERISENSE)); + } +}