This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

Sensor Configuration

Sensor Configuration is a common part of all sensors, encapsulating topics as well as Quality of Service settings and frequency for publishing.

Properties

PropertyDescriptionValuesDefault
VisualiseWhether to show visualisation of sensor working in the simulation, such as drawing point clouds for lidars.Booleantrue
Publishing EnabledTurn publishing sensor data on or off.Booleantrue
FrequencyHow often to publish sensor data (per second).Float10.0

Sensor Configuration can include multiple topics. For each topic, the following properties are listed:

PropertyDescriptionValuesDefault
TopicName of topic. Note that it should not include namespace, since namespaces are handled by ROS 2 Frame components.StringDepends on sensor
Reliability PolicyQuality of Service (QoS) reliability setting. It controls whether published data needs to be delivered (with confirmation) or is only sent on best-effort basis.EnumerationBest Effort
Durability PolicyQuality of Service (QoS) durability setting. It controls whether published data persists for subscribers that join later.EnumerationVolatile
HistoryQuality of Service (QoS) history depth, which is how many messages are kept in the sender queue.Integer5