Skip to content

fix(device): suppress firmware's malformed warmup stream frame (closes #351) #362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tylerkron merged 3 commits into from
Jul 19, 2026
+336 −9
Merged

fix(device): suppress firmware's malformed warmup stream frame (closes #351) #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
abc32e6
fix(device): suppress firmware's malformed warmup stream frame (close…
tylerkron Jul 19, 2026
565a9ba
fix(device): arm warmup guard only when analog enabled at stream star…
tylerkron Jul 19, 2026
d94a274
fix(device): warmup suppression drops only analog, keeps digital payl…
tylerkron Jul 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
262 changes: 258 additions & 4 deletions src/Daqifi.Core.Tests/Device/DaqifiStreamingDeviceDecodeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,23 +455,32 @@ public void Decode_MoreValuesThanChannels_MapsAvailableWithoutThrowing()
}

[Fact]
public void Decode_FewerValuesThanChannels_MapsAvailableWithoutThrowing()
public void Decode_MidStreamFewerValuesThanChannels_MapsAvailableWithoutThrowing()
{
// The warmup guard (issue #351) only suppresses *leading* short frames. Once a full frame
// has been seen, a later short frame is still best-effort mapped rather than dropped.
var device = CreateStreamingDevice(analogCount: 2);
var ai0 = AnalogChannel(device, 0);
var ai1 = AnalogChannel(device, 1);
ai0.IsEnabled = true;
ai1.IsEnabled = true;
device.StartStreaming();

var frame = new DaqifiOutMessage { MsgTimeStamp = 1 };
frame.AnalogInDataFloat.Add(1f); // only one value for two enabled channels
// First a full frame to clear the warmup guard.
var full = new DaqifiOutMessage { MsgTimeStamp = 1 };
full.AnalogInDataFloat.Add(9f);
full.AnalogInDataFloat.Add(9f);
device.InvokeStreamMessage(full);

// Then a mid-stream short frame: one value for two enabled channels.
var frame = new DaqifiOutMessage { MsgTimeStamp = 2 };
frame.AnalogInDataFloat.Add(1f);

var ex = Record.Exception(() => device.InvokeStreamMessage(frame));

Assert.Null(ex);
Assert.Equal(1.0, ai0.ActiveSample!.Value);
Assert.Null(ai1.ActiveSample);
Assert.Equal(9.0, ai1.ActiveSample!.Value); // retains its last (full-frame) value
}

[Fact]
Expand Down Expand Up @@ -499,6 +508,251 @@ public void Decode_CarriesDeviceTimestampVerbatimAcrossFrames()

#endregion

#region Warmup-frame suppression (issue #351)

[Fact]
public void Decode_SuppressesMalformedFirstFrame_ThenEmitsFullFrame()
{
// Reproduces the bench evidence: 2 enabled analog channels, first frame carries a single
// analog value (a firmware warmup frame). That partial first sample must not reach the
// channels; the next full frame must decode normally.
var device = CreateStreamingDevice(analogCount: 2);
var ai0 = AnalogChannel(device, 0);
var ai1 = AnalogChannel(device, 1);
ai0.IsEnabled = true;
ai1.IsEnabled = true;
device.StartStreaming();

var samples = new List<double>();
ai0.SampleReceived += (_, e) => samples.Add(e.Sample.Value);

// Malformed first frame: one value for two enabled channels.
var warmup = new DaqifiOutMessage { MsgTimeStamp = 1000 };
warmup.AnalogInDataFloat.Add(0.1f);
device.InvokeStreamMessage(warmup);

Assert.Null(ai0.ActiveSample); // warmup frame suppressed
Assert.Null(ai1.ActiveSample);
Assert.Empty(samples);

// Next full frame decodes for both channels.
var full = new DaqifiOutMessage { MsgTimeStamp = 1840 };
full.AnalogInDataFloat.Add(4f);
full.AnalogInDataFloat.Add(8f);
device.InvokeStreamMessage(full);

Assert.Equal(4.0, ai0.ActiveSample!.Value);
Assert.Equal(8.0, ai1.ActiveSample!.Value);
Assert.Equal(new[] { 4.0 }, samples); // AI0 saw exactly one (correct) sample
}

[Fact]
public void Decode_WarmupFrameThenSteadyCadence_NoFalseGap()
{
// The warmup frame's timestamp is normal (one sample period before the next frame), so it
// anchors the session clock correctly — a steady cadence after it reports no false gap.
var device = CreateStreamingDevice(analogCount: 2);
AnalogChannel(device, 0).IsEnabled = true;
AnalogChannel(device, 1).IsEnabled = true;
device.StartStreaming();

var gaps = new List<TimestampGapEventArgs>();
device.GapDetected += (_, e) => gaps.Add(e);

// Warmup frame (partial analog), then a steady one-period cadence.
var warmup = new DaqifiOutMessage { MsgTimeStamp = 1000 };
warmup.AnalogInDataFloat.Add(0.1f);
device.InvokeStreamMessage(warmup);

for (uint ts = 2000; ts <= 12000; ts += 1000)
{
var frame = new DaqifiOutMessage { MsgTimeStamp = ts };
frame.AnalogInDataFloat.Add(1f);
frame.AnalogInDataFloat.Add(2f);
device.InvokeStreamMessage(frame);
}

Assert.Empty(gaps);
}

[Fact]
public void Decode_CombinedWarmupFrame_SuppressesAnalogButKeepsDigital()
{
// The firmware's fast encoder packs analog+digital into one frame, so the warmup frame
// carries a valid digital payload alongside its partial analog values (issue #351 evidence:
// "analog=[1] digital=00-04"). Only the malformed analog is dropped; digital is preserved.
var device = CreateStreamingDevice(analogCount: 2, digitalCount: 2);
var ai0 = AnalogChannel(device, 0);
var ai1 = AnalogChannel(device, 1);
var dio0 = DigitalChannel(device, 0);
var dio1 = DigitalChannel(device, 1);
ai0.IsEnabled = true;
ai1.IsEnabled = true;
dio0.IsEnabled = true;
dio1.IsEnabled = true;
device.StartStreaming();

var warmup = new DaqifiOutMessage { MsgTimeStamp = 1000 };
warmup.AnalogInDataFloat.Add(0.1f); // partial analog: 1 value for 2 enabled channels
warmup.DigitalData = ByteString.CopyFrom(new byte[] { 0b10 }); // DIO0 low, DIO1 high

device.InvokeStreamMessage(warmup);

// Analog values suppressed...
Assert.Null(ai0.ActiveSample);
Assert.Null(ai1.ActiveSample);
// ...but the digital payload in the same frame is still decoded.
Assert.Equal(0.0, dio0.ActiveSample!.Value);
Assert.Equal(1.0, dio1.ActiveSample!.Value);
}

[Fact]
public void Decode_WarmupFrame_StillReRaisesRawMessage()
{
// Suppression skips only the per-channel decode; raw-frame consumers still see the frame.
var device = CreateStreamingDevice(analogCount: 2);
AnalogChannel(device, 0).IsEnabled = true;
AnalogChannel(device, 1).IsEnabled = true;
device.StartStreaming();

var rawFrames = 0;
device.MessageReceived += (_, _) => rawFrames++;

var warmup = new DaqifiOutMessage { MsgTimeStamp = 1 };
warmup.AnalogInDataFloat.Add(0.1f);
device.InvokeStreamMessage(warmup);

Assert.Equal(1, rawFrames);
}

[Fact]
public void Decode_FullFirstFrame_NotSuppressed()
{
// A first frame that already carries the full complement decodes immediately.
var device = CreateStreamingDevice(analogCount: 2);
var ai0 = AnalogChannel(device, 0);
var ai1 = AnalogChannel(device, 1);
ai0.IsEnabled = true;
ai1.IsEnabled = true;
device.StartStreaming();

var frame = new DaqifiOutMessage { MsgTimeStamp = 1 };
frame.AnalogInDataFloat.Add(1f);
frame.AnalogInDataFloat.Add(2f);
device.InvokeStreamMessage(frame);

Assert.Equal(1.0, ai0.ActiveSample!.Value);
Assert.Equal(2.0, ai1.ActiveSample!.Value);
}

[Fact]
public void Decode_DigitalOnlyStream_FirstFrameNotSuppressed()
{
// With no analog channels enabled the warmup guard never engages: a digital-only first
// frame is decoded normally.
var device = CreateStreamingDevice(analogCount: 0, digitalCount: 4);
var dio = Enumerable.Range(0, 4).Select(n => DigitalChannel(device, n)).ToList();
foreach (var d in dio) d.IsEnabled = true;
device.StartStreaming();

var frame = new DaqifiOutMessage { MsgTimeStamp = 1 };
frame.DigitalData = ByteString.CopyFrom(new byte[] { 0b1010 });
device.InvokeStreamMessage(frame);

Assert.Equal(0.0, dio[0].ActiveSample!.Value);
Assert.Equal(1.0, dio[1].ActiveSample!.Value);
}

[Fact]
public void Decode_WarmupGuardReArmsForEachSession()
{
// The guard is re-armed at every StartStreaming, so a warmup frame is suppressed at the
// start of a *subsequent* session too.
var device = CreateStreamingDevice(analogCount: 2);
var ai0 = AnalogChannel(device, 0);
var ai1 = AnalogChannel(device, 1);
ai0.IsEnabled = true;
ai1.IsEnabled = true;

// Session 1: warmup + a full frame.
device.StartStreaming();
var w1 = new DaqifiOutMessage { MsgTimeStamp = 1 };
w1.AnalogInDataFloat.Add(0.1f);
device.InvokeStreamMessage(w1);
var f1 = new DaqifiOutMessage { MsgTimeStamp = 2 };
f1.AnalogInDataFloat.Add(1f);
f1.AnalogInDataFloat.Add(2f);
device.InvokeStreamMessage(f1);
device.StopStreaming();

// Session 2: a fresh warmup frame must again be suppressed.
device.StartStreaming();
var w2 = new DaqifiOutMessage { MsgTimeStamp = 3 };
w2.AnalogInDataFloat.Add(5f); // single value -> partial again
device.InvokeStreamMessage(w2);

// AI1 still holds session-1's value; the session-2 warmup frame did not overwrite AI0.
Assert.Equal(1.0, ai0.ActiveSample!.Value);
Assert.Equal(2.0, ai1.ActiveSample!.Value);
}

[Fact]
public void Decode_DigitalOnlyStart_ThenAnalogEnabledMidStream_ShortFrameNotSuppressed()
{
// The warmup guard is armed only when analog channels are enabled at StartStreaming. A
// session that starts digital-only leaves it disarmed, so a short analog frame arriving
// after analog is enabled mid-stream is best-effort mapped, not treated as a leading
// warmup frame far from session start.
var device = CreateStreamingDevice(analogCount: 2, digitalCount: 2);
var ai0 = AnalogChannel(device, 0);
var ai1 = AnalogChannel(device, 1);
var dio0 = DigitalChannel(device, 0);
dio0.IsEnabled = true; // digital-only at start
device.StartStreaming();

// A digital frame streams normally.
var digital = new DaqifiOutMessage { MsgTimeStamp = 1 };
digital.DigitalData = ByteString.CopyFrom(new byte[] { 0b1 });
device.InvokeStreamMessage(digital);
Assert.Equal(1.0, dio0.ActiveSample!.Value);

// Enable analog mid-stream, then a short analog frame arrives (guard was never armed).
device.EnableChannels(new[] { ai0, ai1 });
var shortAnalog = new DaqifiOutMessage { MsgTimeStamp = 2 };
shortAnalog.AnalogInDataFloat.Add(7f); // one value for two enabled channels

var ex = Record.Exception(() => device.InvokeStreamMessage(shortAnalog));

Assert.Null(ex);
Assert.Equal(7.0, ai0.ActiveSample!.Value); // not suppressed — best-effort mapped
Assert.Null(ai1.ActiveSample);
}

[Fact]
public void Decode_PersistentShortFrames_ReleasedAfterCap()
{
// Safety bound: a stream that only ever sends short frames must not be withheld forever.
// After MaxSuppressedWarmupFrames (5) suppressed frames, the guard releases.
var device = CreateStreamingDevice(analogCount: 2);
var ai0 = AnalogChannel(device, 0);
AnalogChannel(device, 1).IsEnabled = true;
ai0.IsEnabled = true;
device.StartStreaming();

// 5 suppressed, the 6th is released (best-effort mapped).
for (var i = 0; i < 6; i++)
{
var frame = new DaqifiOutMessage { MsgTimeStamp = (uint)(1000 + i) };
frame.AnalogInDataFloat.Add(i);
device.InvokeStreamMessage(frame);
}

Assert.NotNull(ai0.ActiveSample);
Assert.Equal(5.0, ai0.ActiveSample!.Value); // the 6th frame's value
}

#endregion

#region Helpers

private static DecodableStreamingDevice CreateStreamingDevice(
Expand Down
Loading