SchemaVersion 5 Change Notice

Description of the change

Starting with schemaVersion=5, all BSM metadata field contains a receivedMessageDetails element containing locationData and optionally rxSource (rxMsg log files only). The locationData represents the location of the vehicle when this data record was logged and optionally the source of the data. Prior to schemaVersion=5, there was no receiveMessageDetails in BSM metadata.

For BSM records with bsmSource=RV, locationData will represent the location of the Ego Vehicle (EV) that received the BSM from a Remote Vehicle (RV) while the location data inside the BSM payload will represent the location of the RV. For BSMs inside a rxMsg log file, rxSource will be equal to RV as does bsmSource. For other log files that may contain BSM data (bsmTx and bsmLogDuringEvent), there rxSource will be null or not present in receivedMessageDetails.

For BSM records with bsmSource=EV, the locationData should be very close to or identical to the location data within the BSM payload.

How to revert to an older output schema

The ODE defaults to schemaVersion=5. Use the following instructions to configure the ODE to output an older schema. Only older schemaVersion=4 is supported. To instruct the ODE to produce schemaVersion 4, you may do any of the following:

• Define environment variable ODE_OUTPUT_SCHEMA_VERSION=4 in the docker-compose .env file. If you don't already have a .env file, a sample.env has been provided. Copy sample.env to .env and modify it with all relevant properties for your ODE instance. See ODE README instructions and Using .env configuration file for more details about using .env to set ODE properties. Once all relevant environment variables are set in .env file, rebuild and re-upload to Docker containers using the command docker-compose up --build -d.
• If running ODE outside docker, you may set the properties using the OS environment variable ODE_OUTPUT_SCHEMA_VERSION=4 or command line argument --ode.outputSchemaVersion=4