From 4220d866949fda99f496d18fa55148fe2f530b19 Mon Sep 17 00:00:00 2001 From: Carlo van Driesten Date: Wed, 29 Apr 2026 12:39:09 +0200 Subject: [PATCH] docs: deprecate SensorDataSeries and SensorDataSeriesList for removal 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 --- osi_datarecording.proto | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/osi_datarecording.proto b/osi_datarecording.proto index a44bf5a3d..638bcbf45 100644 --- a/osi_datarecording.proto +++ b/osi_datarecording.proto @@ -7,8 +7,14 @@ import "osi_sensordata.proto"; package osi3; // -// \brief (Time) Series of \c SensorData messages that may be used for data -// recording or internal buffering by some sensor models. +// \brief (Time) Series of \c SensorData messages. +// +// \attention DEPRECATED: This message will be removed in OSI 4.0.0. +// Use the OSI trace file formats instead, which generalize +// the concept to any top-level message type and support streaming +// without requiring all time steps to be held in memory at once. +// Internal buffering by sensor models should be handled within the +// sensor model implementation. // message SensorDataSeries { @@ -21,6 +27,11 @@ message SensorDataSeries // \brief List of sensors where each element contains a time series of // \c SensorData messages. // +// \attention DEPRECATED: This message will be removed in OSI 4.0.0. +// Use the OSI trace file formats instead, which generalize +// the concept to any combination of top-level message types and +// provide metadata, schema records, compression, and random access. +// message SensorDataSeriesList { // List of sensor data for multiple sensors at subsequent time steps.