Skip to content

Commit 2c00a06

Browse files
marknolanclaude
andcommitted
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 <[email protected]>
1 parent c446e1b commit 2c00a06

3 files changed

Lines changed: 119 additions & 10 deletions

File tree

‎ShimmerDriver/src/main/java/com/shimmerresearch/driver/Configuration.java‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1337,6 +1337,10 @@ public static class CompatibilityInfoForMaps{
13371337
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);
13381338
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);
13391339
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);
1340+
/** The GQ 802.15.4 firmware on any hardware. The GQs above are matched on their hardware, but a
1341+
* Verisense in NeuroLynQ mode keeps its own hardware ID (61 to 68), so it is matched on the firmware it
1342+
* runs: nothing else runs GQ_802154. See ShimmerVerObject.isVerisenseNeuroLynQ(). */
1343+
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);
13401344

13411345
private static final ShimmerVerObject svoExgSdLog = new ShimmerVerObject(HW_ID.SHIMMER_3,FW_ID.SDLOG,0,8,0,HW_ID_SR_CODES.EXP_BRD_EXG);
13421346
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{
14061410
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoExgGeneral = Arrays.asList(
14071411
svoExgSdLog, svoExgBtStream, svoExgLogAndStream,
14081412
svoExgUnifiedSdLog, svoExgUnifiedBtStream, svoExgUnifiedLogAndStream,
1409-
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq,
1413+
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ,
14101414
svoShimmerECGmd, svoShimmer4Stock, svoStrokare, svoShimmer3RExgUnifiedLogAndStream);
14111415

14121416
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoExgEmg = Arrays.asList(
@@ -1418,22 +1422,22 @@ public static class CompatibilityInfoForMaps{
14181422
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoExgEcg = Arrays.asList(
14191423
svoExgSdLog, svoExgBtStream, svoExgLogAndStream,
14201424
svoExgUnifiedSdLog, svoExgUnifiedBtStream, svoExgUnifiedLogAndStream,
1421-
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq,
1425+
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ,
14221426
svoShimmerECGmd, svoShimmer4Stock, svoShimmer3RExgUnifiedLogAndStream);
14231427

14241428
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoExgEcgGq = Arrays.asList(
1425-
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq);
1429+
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ);
14261430

14271431
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoExgTest = Arrays.asList(
14281432
svoExgSdLog, svoExgBtStream, svoExgLogAndStream,
14291433
svoExgUnifiedSdLog, svoExgUnifiedBtStream, svoExgUnifiedLogAndStream,
1430-
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq,
1434+
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ,
14311435
svoShimmerECGmd, svoShimmer4Stock, svoShimmer3RExgUnifiedLogAndStream);
14321436

14331437
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoExgThreeUnipolar = Arrays.asList(
14341438
svoExgSdLog, svoExgBtStream, svoExgLogAndStream,
14351439
svoExgUnifiedSdLog, svoExgUnifiedBtStream, svoExgUnifiedLogAndStream,
1436-
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq,
1440+
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ,
14371441
svoShimmerECGmd, svoShimmer4Stock, svoShimmer3RExgUnifiedLogAndStream);
14381442

14391443
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoExgRespiration = Arrays.asList(
@@ -1446,7 +1450,7 @@ public static class CompatibilityInfoForMaps{
14461450

14471451
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoAnyExpBoardStandardFW = Arrays.asList(
14481452
svoAnyIntExpBoardAndSdlog,svoAnyIntExpBoardAndBtStream,svoAnyIntExpBoardAndLogAndStream,
1449-
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoAnyIntExpBoardAndLogAndStream3R,
1453+
svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ, svoAnyIntExpBoardAndLogAndStream3R,
14501454
svoShimmer4Stock, svoArduino, svoSweatch, svoStrokare);
14511455

14521456
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoBattVoltage = Arrays.asList(
@@ -1457,7 +1461,7 @@ public static class CompatibilityInfoForMaps{
14571461
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoGsr = Arrays.asList(
14581462
svoGsrSdLog, svoGsrBtStream, svoGsrLogAndStream, svoGsrGqBle,
14591463
svoGsrUnifiedSdLog, svoGsrUnifiedBtStream, svoGsrUnifiedLogAndStream,
1460-
svoGsrUnifiedGqBle, svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq,
1464+
svoGsrUnifiedGqBle, svoShimmerGq802154Lr, svoShimmerGq802154Nr, svoShimmer2rGq, svoVerisenseNeuroLynQ,
14611465
svoShimmer4Stock, svoShimmer3RGsrUnifiedLogAndStream,svoShimmer3RGsrNewImuLogAndStream);
14621466

14631467
public static final List<ShimmerVerObject> listOfCompatibleVersionInfoBMP180 = Arrays.asList(

‎ShimmerDriver/src/main/java/com/shimmerresearch/driverUtilities/ShimmerVerObject.java‎

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,7 @@ private void parseShimmerVerDetails() {
247247
|| (mHardwareVersion==HW_ID.SHIMMER_GQ_BLE && mFirmwareIdentifier==FW_ID.GQ_BLE)
248248
|| ((mHardwareVersion==HW_ID.SHIMMER_GQ_802154_NR || mHardwareVersion==HW_ID.SHIMMER_GQ_802154_LR) && mFirmwareIdentifier==FW_ID.GQ_802154)
249249
|| (mHardwareVersion==HW_ID.SHIMMER_2R_GQ && mFirmwareIdentifier==FW_ID.GQ_802154)
250+
|| isVerisenseNeuroLynQ()
250251
|| mHardwareVersion==HW_ID.SPAN
251252
|| mHardwareVersion==HW_ID.SHIMMER_4_SDK
252253
|| mHardwareVersion==HW_ID.SWEATCH
@@ -410,6 +411,7 @@ public static boolean isSupportedRtcConfigViaUart(int hwVer, int fwId) {
410411
|| (hwVer==HW_ID.SHIMMER_GQ_802154_NR)
411412
|| (hwVer==HW_ID.SHIMMER_GQ_802154_LR)
412413
|| (hwVer==HW_ID.SHIMMER_2R_GQ)
414+
|| isVerisenseNeuroLynQ(hwVer, fwId)
413415
|| (hwVer==HW_ID.SHIMMER_4_SDK)
414416
|| (hwVer==HW_ID.SHIMMER_3R)){
415417
return true;
@@ -427,6 +429,7 @@ public static boolean isSupportedConfigViaUart(int hwVer, int fwId) {
427429
|| hwVer==HW_ID.SHIMMER_GQ_802154_NR
428430
|| hwVer==HW_ID.SHIMMER_GQ_802154_LR
429431
|| hwVer==HW_ID.SHIMMER_2R_GQ
432+
|| isVerisenseNeuroLynQ(hwVer, fwId)
430433
|| hwVer==HW_ID.SHIMMER_4_SDK){
431434
return true;
432435
}
@@ -445,7 +448,8 @@ public static boolean isSupportedSdCardAccess(int hwVer, int fwId) {
445448
|| (hwVer==HW_ID.SHIMMER_GQ_BLE && fwId == FW_ID.GQ_BLE)
446449
// || hwVer==HW_ID.SHIMMER_GQ_802154_NR
447450
// || hwVer==HW_ID.SHIMMER_GQ_802154_LR
448-
|| fwId==ShimmerVerDetails.FW_ID.GQ_802154
451+
// A NeuroLynQ-mode Verisense runs the GQ's firmware but has no SD card
452+
|| (fwId==ShimmerVerDetails.FW_ID.GQ_802154 && !isVerisenseNeuroLynQ(hwVer, fwId))
449453
|| hwVer==HW_ID.SHIMMER_2R_GQ
450454
|| (hwVer==HW_ID.SHIMMER_4_SDK && fwId == FW_ID.SHIMMER4_SDK_STOCK)
451455
){
@@ -645,13 +649,26 @@ public boolean isShimmerGenGq(int hwVer) {
645649
* @return
646650
*/
647651
public boolean isShimmerGenGq(int hwVer, int fwId) {
648-
if(isShimmerGenGq(hwVer)){
652+
if(isShimmerGenGq(hwVer) || isVerisenseNeuroLynQ(hwVer, fwId)){
649653
// if(((hwVer==HW_ID.SHIMMER_GQ_802154_LR) || (hwVer==HW_ID.SHIMMER_GQ_802154_NR) || (hwVer==HW_ID.SHIMMER_2R_GQ))
650654
// && (fwId==FW_ID.GQ_802154 || fwId==FW_ID.GQ_BLE)){
651655
return true;
652656
}
653657
return false;
654658
}
659+
660+
/**
661+
* A Verisense in NeuroLynQ mode (verisense-firmware ASM_NeuroLynQ): Verisense
662+
* hardware running the GQ 802.15.4 firmware. It reports its own hardware ID, but it
663+
* answers and streams as a GQ does, so to the host it is a GQ (DEV-1047).
664+
*/
665+
public boolean isVerisenseNeuroLynQ() {
666+
return isVerisenseNeuroLynQ(getHardwareVersion(), getFirmwareIdentifier());
667+
}
668+
669+
public static boolean isVerisenseNeuroLynQ(int hwVer, int fwId) {
670+
return isShimmerGenVerisense(hwVer) && fwId==FW_ID.GQ_802154;
671+
}
655672

656673
public boolean isShimmerVideoDevice(){
657674
return isShimmerVideoDevice(getHardwareVersion());
@@ -667,8 +684,10 @@ public static boolean isShimmerVideoDevice(int hardwareVersion) {
667684
return false;
668685
}
669686

687+
/** Verisense hardware running its own firmware. In NeuroLynQ mode it runs the GQ's
688+
* firmware and sends GQ data instead, see {@link #isVerisenseNeuroLynQ()}. */
670689
public boolean isShimmerGenVerisense() {
671-
return isShimmerGenVerisense(getHardwareVersion());
690+
return isShimmerGenVerisense(getHardwareVersion()) && !isVerisenseNeuroLynQ();
672691
}
673692

674693
public static boolean isShimmerGenVerisense(int hwVer) {
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
package com.shimmerresearch.driverUtilities;
2+
3+
import static org.junit.Assert.assertEquals;
4+
import static org.junit.Assert.assertFalse;
5+
import static org.junit.Assert.assertTrue;
6+
7+
import org.junit.Test;
8+
9+
import com.shimmerresearch.driverUtilities.ShimmerVerDetails.FW_ID;
10+
import com.shimmerresearch.driverUtilities.ShimmerVerDetails.HW_ID;
11+
import com.shimmerresearch.sensors.SensorADC.MICROCONTROLLER_ADC_PROPERTIES;
12+
13+
/**
14+
* A Verisense in NeuroLynQ mode is a GQ to the host (DEV-1047).
15+
* <p>
16+
* Docked, it answers VER with its own hardware ID and the GQ's firmware ID. On the bench
17+
* on 2026-09-24 that was hardware 68, firmware 9, v2.1.1, which the host used to leave as
18+
* an unrecognised device with "Unknown" firmware.
19+
*/
20+
public class API_00014_VerisenseNeuroLynQVersionTest {
21+
22+
private static final ShimmerVerObject NODE = new ShimmerVerObject(HW_ID.VERISENSE_PULSE_PLUS, FW_ID.GQ_802154, 2, 1, 1);
23+
private static final ShimmerVerObject STOCK_VERISENSE = new ShimmerVerObject(HW_ID.VERISENSE_PULSE_PLUS, FW_ID.VERISENSE, 2, 1, 1);
24+
private static final ShimmerVerObject GQ = new ShimmerVerObject(HW_ID.SHIMMER_GQ_802154_NR, FW_ID.GQ_802154, 1, 1, 1);
25+
26+
@Test
27+
public void aNeuroLynQVerisenseIsAGq() {
28+
assertTrue(NODE.isVerisenseNeuroLynQ());
29+
assertTrue(NODE.isShimmerGenGq());
30+
assertFalse(NODE.isShimmerGenVerisense());
31+
}
32+
33+
@Test
34+
public void everyVerisenseRunningTheGqFirmwareIsAGq() {
35+
for (int hwId : new int[] {HW_ID.VERISENSE_IMU, HW_ID.VERISENSE_GSR_PLUS, HW_ID.VERISENSE_PPG,
36+
HW_ID.VERISENSE_DEV_BRD, HW_ID.VERISENSE_PULSE_PLUS}) {
37+
assertTrue("hardware " + hwId, new ShimmerVerObject(hwId, FW_ID.GQ_802154, 2, 1, 1).isShimmerGenGq());
38+
}
39+
}
40+
41+
@Test
42+
public void aStockVerisenseIsStillAVerisense() {
43+
assertFalse(STOCK_VERISENSE.isVerisenseNeuroLynQ());
44+
assertFalse(STOCK_VERISENSE.isShimmerGenGq());
45+
assertTrue(STOCK_VERISENSE.isShimmerGenVerisense());
46+
}
47+
48+
@Test
49+
public void aGqIsUnchanged() {
50+
assertTrue(GQ.isShimmerGenGq());
51+
assertFalse(GQ.isVerisenseNeuroLynQ());
52+
assertFalse(GQ.isShimmerGenVerisense());
53+
}
54+
55+
@Test
56+
public void itsFirmwareIsNamedAsAGqs() {
57+
String gqFirmwareLabel = FW_ID.mMapOfFirmwareLabels.get(FW_ID.GQ_802154);
58+
assertEquals(gqFirmwareLabel, NODE.mFirmwareIdentifierParsed);
59+
assertEquals(gqFirmwareLabel + " v2.1.1", NODE.getFirmwareVersionParsed());
60+
}
61+
62+
/** Docked, its InfoMem image and clock are read and written as a GQ's are */
63+
@Test
64+
public void itIsConfiguredOverTheDockLinkAsAGqIs() {
65+
assertTrue(NODE.isSupportedConfigViaUart());
66+
assertTrue(NODE.isSupportedRtcConfigViaUart());
67+
assertFalse(STOCK_VERISENSE.isSupportedConfigViaUart());
68+
assertFalse(STOCK_VERISENSE.isSupportedRtcConfigViaUart());
69+
}
70+
71+
/** Unlike a GQ it has no SD card, and its USB has no mass storage */
72+
@Test
73+
public void itHasNoSdCard() {
74+
assertFalse(NODE.isSupportedSdCardAccess());
75+
assertTrue(GQ.isSupportedSdCardAccess());
76+
}
77+
78+
/** It sends GQ data, already scaled to the GQ's ADC, so it takes the GQ's calibration */
79+
@Test
80+
public void itTakesTheGqsAdcProperties() {
81+
assertEquals(MICROCONTROLLER_ADC_PROPERTIES.getMicrocontrollerAdcPropertiesForShimmerVersionObject(GQ),
82+
MICROCONTROLLER_ADC_PROPERTIES.getMicrocontrollerAdcPropertiesForShimmerVersionObject(NODE));
83+
assertEquals(MICROCONTROLLER_ADC_PROPERTIES.VERISENSE_1V8,
84+
MICROCONTROLLER_ADC_PROPERTIES.getMicrocontrollerAdcPropertiesForShimmerVersionObject(STOCK_VERISENSE));
85+
}
86+
}

0 commit comments

Comments
 (0)