Warning: Version 2.0.0 introduces breaking changes! Existing code will definitely not work anymore.

onboardapis allows you to interact with different on-board APIs. You can connect to the Wi-Fi of a supported transportation provider and access information about your journey, the vehicle you are travelling in and much more.

Note: The only vehicle type covered by this package currently is train. See the supported APIs for more information.

Install the latest stable version of onboardapis from PyPI using pip:

$ python -m pip install onboardapis

or the latest prerelease version of onboardapis from PyPI using pip:

$ python -m pip install --pre onboardapis

Install the latest development version of onboardapis from GitHub using pip:

$ python -m pip install git+https://github.com/felix-zenk/onboardapis.git

To begin with development you will need to know a few things first:

• What vehicle type you want to use
• Who operates the vehicle
• What country is the operator from

With this information you can get the needed module from the package onboardapis.<type>.<country>.<operator> and import the API class from it. For more specific information on finding the API you are looking for, see Finding your API.

Example: Let's say you want to use the on-board API called ICE Portal of Deutsche Bahn trains in Germany:

from onboardapis.train.de.db import ICEPortal

Every vehicle has an init-method that needs to be called to initialize the connection to the API. When using a vehicle as a context manager the init-method will automatically be called.

from onboardapis.train.de.db import ICEPortal
from onboardapis.units import kilometers, kmh


# init is automatically called
with ICEPortal() as train:
    print(
        f"Distance to {train.current_station.name}:",
        f"{kilometers(meters=train.calculate_distance(train.current_station)):.1f} km"
    )


# init has to be explicitly called
train = ICEPortal()
train.init()  # Explicit call to init method to initialize API connection

print(
    f"Travelling at {train.speed} m/s",
    f"({kmh(ms=train.speed):.2f} km/h)",
    f"with a delay of {train.delay.total_seconds():.0f} seconds"
)

And there you go!
You can read more information about available attributes in the onboardapis.train.Train and onboardapis.mixins documentation and the respective train's documentation.

Note: As you may have noticed by now, the package always returns datetime or timedelta objects for time based values and other values like distances, velocity, etc. in SI units, so you have to convert to other units if you want to use values different from the SI units. For convenience the onboardapis.units module provides functions to convert between units.

The name of a conversion function is the unit which will be the result of the conversion. Different units can be passed to a conversion function as keywords. Keywords can be combined to return the sum of the input units.

Notes:

• * Managing internet access is not yet supported.

Notes:

• * Managing internet access is not yet supported.

The operator code is vehicle type specific. The following IDs are used:

Combine these three values to onboardapis.<type>.<country>.<operator>. This is the module that contains the API.

Hint: You can also get the module path by looking at Supported APIs / Experimental APIs and taking the three values from there.

The API scope defines what information can be accessed through the API and is a general indicator of the API's capabilities.
The currently possible API scopes are:

• basic: Only basic information is available such as connection status to the API.
• vehicle: The API supplies information about the vehicle such as the train ID, line number, etc.
• geo: The API supplies information about the current location, speed, etc. of the vehicle.
• journey-simple: The API supplies simple journey information including the current station and the destination station.
• journey: The API supplies detailed journey information including all the stations and possibly connecting services.
• full: All of the above.
• internet-access: The API provides internet access to the user.