Welcome to carSim’s documentation!¶

Car motion class¶

This part of the module contains the vehicle motion simulator class.

class car.motion.constants¶: Helper class holding problem specific constants

class car.motion.motion(initialCondition=[0.0, 0.0, 0.0])¶

Car motion class

getSimDistance()¶

Returns actual vehicle distance covered

Returns:	Actual distance in meters
Return type:	float

getSimFuel()¶

Returns consumed fuel

Returns:	Actual consumed fuel in mililiters
Return type:	float

getSimSpeed()¶

Returns actual vehicle speed

Returns:	Actual vehicle speed in meters per second
Return type:	float

getSimTime()¶

Returns actual simulation time

Returns:	Actual simulation time in seconds
Return type:	float

getThrottle()¶

Returns consumed fuel

Returns:	Actual consumed fuel in mililiters
Return type:	float

makeStep(dt=None)¶

Perform a step of simulation

Parameters:	dt (float, optional) – Simulator timestep for actual and future simulation steps, by default None. If not specified, default or previous specified value is used
Raises:	`ValueError` – If dt is not greater than 0

setThrottle(throttle)¶

Set actual throttle value for next simulation time steps

Parameters:	throttle (float) – Normalized [0-1] throttle value for next simulation timesteps
Raises:	`ValueError` – If throttle is not number or outside unit interval

setTimestep(dt)¶

Sets simulator timestep

Parameters:	dt (float) – Timestep for simulator
Raises:	`ValueError` – If dt is not greater than 0

car.util.mpsToKmph(speed)¶

Meter per second to kilometer per hour unit converter

Parameters:	speed (multiplicable (float, numpy.array etc.)) – Speed in m/s
Returns:	convertedSpeed – Speed converted to km/h
Return type:	as speed