open-simulation-interface icon indicating copy to clipboard operation
open-simulation-interface copied to clipboard

SensorViewConfiguration missing timestamp

Open caspar-ai opened this issue 4 years ago • 4 comments

Describe the bug

There is a disconnect between the documentation and the implementation with regards Top-Level Messages and SensorViewConfiguration.

Describe how to reproduce the bug

The interface conventions documentation states that all top level messages require an interface as the first field and a timestamp as the second. It also explicitly mentions SensorViewConfiguration as one such example of a top level message.

The definition of a SensorViewConfiguration includes an interface version but does not include a timestamp.

Describe the expected behavior

The expected fix depends on the desired behaviour:

  1. If the SensorViewConfiguration is an exception to the top level rule then I would expect the documentation to be updated, and a comment added inline by the message definition.
  2. If it isn't an exception, a timestamp field should be added.

caspar-ai avatar Jun 17 '20 08:06 caspar-ai