Environment Configuration

You can use a Readable Unit anywhere where you have the option of:

number or string
integer or string

📃 Corresponding configuration file: environment/environment_config.json

Environment Events

Schema describing the JSON file structure for the environment configuration. It is is used to define which events are evaluated by the simulator. Entities entering the areas of the events, are notified by the ‘EnvironmentSensorUpdates’ interaction

Properties

	Type	Description	Required	Boundaries	Default
events	`event[]`	List of events.	No	None	None

event

Object to define a single event configuration.

Properties

	Type	Description	Required	Boundaries	Default
type	`eventType`	Object to define the type of an event.	✓ Yes	None	None
location	`eventLocation`	Object to define the event location configuration, which is either a GeoArea (e.g. rectangle, circle, or polygon) or a specific street segment.	✓ Yes	None	None
time	`eventTime`	Object to define the temporal properties of an event.	✓ Yes	None	None

eventType

Object to define the type of an event.

Properties

	Type	Description	Required	Boundaries	Default
sensorType	`string`	Represents the type of sensor value this event is emitting (e.g. Ice, Snow, or an arbitrary Obstacle). The value can be set to any valid string.	✓ Yes	None	None
value	`integer`	Used for assigning a value to the event. It can be used as the strength of an event, the amount of free parking spots in a parking lot, etc.	No	None	`1`

eventLocation

Object to define the event location configuration, which is either a GeoArea (e.g. rectangle, circle, or polygon) or a specific street segment.

Properties

	Type	Description	Required	Boundaries	Default
area	`area`	Object to define the area in which the event is located in.	No	None	None
connectionId	`string`	The ID of the road segment the event is located on (Connection ID).	No	None	None

area

Object to define the area in which the event is located in.

Properties

	Type	Description	Required	Boundaries	Default
type	`string`	The type of the area.	No	Enum	None

Additionally ANY of the following property definitions apply:

geoCircle
geoRectangle
geoPolygon

Further property restrictions:

area.type

Allowed values:
- Rectangle
- Circle
- Polygon

geoCircle

Object to define an immutable pair of a geoPoint center position and a radius in meters.

Properties

	Type	Description	Required	Boundaries	Default
center	`geoPoint`	Object to define geographical point coordinates.	✓ Yes	None	None
radius	`number`	Radius of the circle in m.	✓ Yes	[0, +$\infty$]	None

geoPoint

Object to define geographical point coordinates.

Properties

	Type	Description	Required	Boundaries	Default
longitude	`number`	East-west position of a point on earth.	✓ Yes	[-180, 180]	None
latitude	`number`	North-south position of a point on earth.	✓ Yes	[-$\infty$, 90]	None

geoRectangle

Object to define an immutable pair of two different GeoPoints. Together they form a rectangular area.

Properties

	Type	Description	Required	Boundaries	Default
a	`geoPoint`	Object to define geographical point coordinates.	✓ Yes	None	None
b	`geoPoint`	Object to define geographical point coordinates.	✓ Yes	None	None

geoPolygon

Object to define a set of GeoPoints. Together the points for a polygonal area.

Properties

	Type	Description	Required	Boundaries	Default
vertices	`geoPoint[]`	Set of points representing the vertices of a polygon.	No	None	None

eventTime

Object to define the temporal properties of an event.

Properties

	Type	Description	Required	Boundaries	Default
start	`string` `number`	Start time of the event. If defined as a number, then the default unit is ns. Alternatively this can be defined as a string to include the unit of measurement (e.g. ‘3 minutes’)	✓ Yes	None	None
end	`string` `number`	End time of the event. If defined as a number, then the default unit is ns. Alternatively this can be defined as a string to include the unit of measurement (e.g. ‘3 minutes’)	✓ Yes	None	None