• Device

Device

---

This Page describes how to implement a new device.

What is a device good for?#

A device is a container for data and functionality which resides in individual vehicles. Devices are notified about all vehicle movements and may interact with the vehicle or with other devices. An important aspect of devices is, that it is possible to equip only a fraction of the simulated vehicles. Many devices provide additional outputs but others may also change behavior. For details, refer to the complete list of vehicle devices. See also, the list of person devices.

The devices can all be found in src/microsim/devices and the Example-Device exists as an implementation example for custom devices.

Steps for implementing a new device#

Copy Example Device#

The suggested way for creating a new device is to create a new class by copying the files src/microsim/devices/MSDevice_Example.{h,cpp}.

In order to compile the new class it must be added to src/microsim/devices/Makefile.am (on Linux) or added to project z_libmicrosim_devices (on Windows).

In order to be available for use, the device must also be added in src/microsim/devices/MSDevice.cpp to the functions insertOptions and buildVehicleDevices.

Assign Device to Vehicles#

Devices are assigned by global options for equipping all or a fraction of the vehicle fleet. Alternatively, they can be defined by setting <vehicle> or <vType>-generic parameters. The new assignment options are generated automatically by calling the function MSDevice::insertDefaultAssignmentsOptions. The test whether a specific vehicle should be equipped with the device is done by calling MSDevice::equippedByDefaultAssignmentOptions. The usage of these methods is demonstrated in MSDevice_Example.

Adding your own functionality#

Devices work by updating their state periodically (i.e. MSDevice_Routing) or every time the vehicle moves (i.e. MSDevice_Battery). Many devices perform some kind of output either periodically (MSDevice_Routing) in response to computed events (MSDevice_BTreceiver) or at the time the vehicle leaves the simulation (MSDevice_Vehroutes). Before the vehicle is removed the method generateOutput is called for each device.

Testing your code#

Show your work#

If you have implemented a new device and you think it may be useful to other users of SUMO, please contribute to our community and tell us about your work. We would be happy to help you in getting your device into the main development tree.