Skip to content

docs: deprecate SensorDataSeries and SensorDataSeriesList for removal in v4.0.0#901

Open
jdsika wants to merge 1 commit intomasterfrom
deprecate/sensor-data-series
Open

docs: deprecate SensorDataSeries and SensorDataSeriesList for removal in v4.0.0#901
jdsika wants to merge 1 commit intomasterfrom
deprecate/sensor-data-series

Conversation

@jdsika
Copy link
Copy Markdown
Contributor

@jdsika jdsika commented Apr 29, 2026

Summary

Deprecates SensorDataSeries and SensorDataSeriesList in osi_datarecording.proto with \attention notes indicating removal in OSI 4.0.0.

Motivation

As discussed in #900, these messages predate the OSI trace file formats and have been fully superseded:

Deprecated message Superseded by Why
SensorDataSeries Single-channel .osi trace format Generalizes to any top-level message type; supports streaming without loading all timesteps into memory
SensorDataSeriesList Multi-channel .mcap trace format Generalizes to any combination of top-level message types; adds metadata, schema records, compression, and random access

The original \brief also mentioned internal buffering by sensor models as a use case. This is an implementation concern of individual sensor models and does not belong in the interface specification.

Changes

  • Updated \brief for SensorDataSeries (removed the internal buffering language)
  • Added \attention deprecation notes to both SensorDataSeries and SensorDataSeriesList explaining the rationale and the superseding formats

Recommendation from maintainers

Per @jdsika, @pmai, and @thomassedlmayer in #900: deprecate now, remove entirely in v4.0.0.

Resolves #900

@jdsika jdsika self-assigned this Apr 29, 2026
Copy link
Copy Markdown
Contributor

@pmai pmai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor wording changes, should also generally refer to the trace file formats, without discussing specific ones.

Comment thread osi_datarecording.proto Outdated
Comment thread osi_datarecording.proto Outdated
Comment thread osi_datarecording.proto Outdated
… in v4.0.0

The single-channel (.osi) and multi-channel (.mcap) trace file formats
have fully superseded these messages:

- .osi traces generalize SensorDataSeries to any top-level message type
  and support streaming without loading all timesteps into memory.
- .mcap traces generalize SensorDataSeriesList to any combination of
  top-level message types with metadata, schemas, compression, and
  random access.

Internal buffering by sensor models is an implementation concern and
does not belong in the interface specification.

Resolves #900

Signed-off-by: Carlo van Driesten <carlo.van-driesten@bmw.de>
@jdsika jdsika force-pushed the deprecate/sensor-data-series branch from 2d468fc to 4220d86 Compare April 29, 2026 10:52
@jdsika
Copy link
Copy Markdown
Contributor Author

jdsika commented Apr 29, 2026

Hark, good @pmai! Thy counsel, wise and true,
Hath been applied in full — each word made new.
The version reads 'OSI 4.0.0' as thou decreed,
No '.osi' nor '.mcap' remains — generic indeed.
And 'time steps' now stand parted, twain not one,
Thy changes requested are resolved, the deed is done.

Pray, review once more this humble scribe's revision,
And grant, if't please thee, thy approving vision.

@jdsika jdsika requested a review from ClemensLinnhoff April 29, 2026 11:09
@jdsika jdsika added Documentation Everything which impacts the quality of the documentation and guidelines. ReadyForCCBReview Indicates that this PR is ready for a final review and merge by the CCB. labels Apr 29, 2026
@jdsika jdsika added this to the V3.8.0 milestone Apr 29, 2026
Copy link
Copy Markdown
Contributor

@pmai pmai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To Merge, or Not to Merge

O, most valiant contributor,

I have with attentive eye scanned these lines of artful code. Truly, 'tis a work of great merit and industrious soul! The logic, once a tangled thicket of doubt, now shines with the brightness of a thousand midday suns.

Though I didst search for flaws with the hunger of a ghost seeking vengeance, I find none. No bugs do creep within these shadows, and the performance—stay!—it hath the swiftness of a winged messenger.

"The play’s the thing..."
And in this play, thy script is flawless.

Mine heart is light; the conscience is clear. I do set my seal upon this endeavor with a glad spirit.

I pray you, let the gates be opened! LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Everything which impacts the quality of the documentation and guidelines. ReadyForCCBReview Indicates that this PR is ready for a final review and merge by the CCB.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Is SensorDataSeries as top-level message?

3 participants