Skip to content

en Configuration

tt-tom17 edited this page Jul 11, 2026 · 7 revisions

Configuration

The "Configuration" tab is divided into two sections: Client Configuration (service and client name) and Settings (interval, logs, delay offset).

Configuration tab

Section: Client Configuration

Profile (Transport Service + Profile)

Property Value
Type Dropdown (single selection)
Default HAFAS - VBB (Berlin/Brandenburg)

Important: Service type and profile are stored separately internally but selected via a single combined dropdown. The selection defines both the API used and which transport modes are available.

Display option Internal value Service Profile
HAFAS - VBB (Berlin/Brandenburg) hafas:vbb HAFAS vbb
HAFAS - ÖBB (Austria) hafas:oebb HAFAS oebb
HAFAS - VBN (Bremen/Lower Saxony) hafas:vbn HAFAS vbn
HAFAS - RMV (Rhine-Main/Mainz) hafas:rmv HAFAS rmv
HAFAS - VMT (Thuringia) hafas:vmt HAFAS vmt
Vendo - Deutsche Bahn (disabled, not selectable) vendo:db Vendo db
MOTIS - Transitous (DE & Europe) motis:compat MOTIS compat

Note: The "Vendo - Deutsche Bahn" option has been greyed out in the dropdown since version 0.10.0, because Deutsche Bahn's db-vendo endpoint returns OPS_BLOCKED (server-side block). Existing instances still configured for vendo:db no longer receive data and must be switched to another profile — see Transport Services.

Which transport modes are available per profile is described on the Transport Services page.

Client Name

Property Value
Type Text field (optional)
Default empty (adapter auto-generates a name)

Optional name set as the User-Agent identifier for API requests (e.g. my-iobroker). If left empty, the adapter uses an automatically generated name (iobroker-public-transport-{random}).

This value has no effect on the retrieved data.


Section: Settings

Query Interval (minutes)

Property Value
Type Number input
Default 5
Minimum 5
Maximum 60
Unit minutes

Defines how often the adapter updates departures and journeys for all configured stops and connections. A shorter interval increases data freshness but increases API load.

Note: The interval applies globally to all stops and journeys. Each polling cycle queries all active configurations sequentially.

Suppress Advanced Info Logs

Property Value
Type Checkbox
Default false (not suppressed)

When enabled, detailed info log messages (e.g. per-cycle query notifications) are not written to the ioBroker log. Error and warning logs are still output.

Useful in production to keep the log clean.

Delay Offset (minutes)

Property Value
Type Number input
Default 2
Minimum 2
Maximum 60
Unit minutes

Defines the tolerance for on-time status. A departure is considered on time (DepartureOnTime = true) when the delay is below this offset.

Example: With delayOffset = 2, a departure that is 1 minute late is still considered on time. At exactly 2:00 minutes it is still on time; only when the delay exceeds the offset (> 120 s), i.e. more than 2 minutes, is DepartureDelayed = true set.

The datapoints DepartureDelayed and DepartureOnTime (for stops) and their equivalents in journeys are calculated based on this value.

Object Count Warning Limit

Property Value
Type Number input
Default not set — the field then shows the limit currently stored in the js-controller
Minimum 5000
Step 100

Above this object count the js-controller writes a log warning that this instance has created an unusually high number of objects. The adapter creates a substantial number of datapoints per stop and per journey (see Departures and Journeys) — with larger configurations the js-controller's default limit is exceeded even though the adapter works correctly. This field raises the limit for this instance instead of leaving the warning permanently in the log.

How it works: The value is stored in native.objectsWarnLimit and applied on adapter start to the state system.adapter.public-transport.<instance>.objectsWarnLimit — only that state is evaluated by the js-controller. Since saving the configuration restarts the instance anyway, the new limit takes effect right afterwards.

Note: Values below 5000 are not applied — the Admin UI flags the field as an error, and the adapter ignores a value that is too small on start. If the field is left empty, the adapter does not change the js-controller's limit.


Native-only Fields (not available in Admin UI)

The following fields exist in the adapter configuration but are not accessible via the admin tab. They can be set directly in the configuration object if needed.

Field Type Default Description
logCompletelyJSON Boolean false Log complete API responses (debug)
logUnknownTokens Boolean false Log unknown i18n translation tokens

Note: These fields are intended for debugging and development only. They do not need to be set in normal operation.


Field Interactions

  • Profile ↔ Departures/Journeys: After changing the profile, existing stops and journeys may need to be reconfigured since the available transport modes change. The adapter does not automatically delete existing datapoints.
  • Query interval ↔ Polling: All active stops and journeys are queried in the same cycle. With many configurations and a short interval, API requests may be issued frequently.

Home

AdapterLogo

Adapter Version

npm Number of Installations


ioBroker.public-transport

🏠 Überblick

⚙️ Einrichtung

📋 Konfiguration

📊 Referenz

🖥️ Anzeige

❓ Hilfe

Translation

🇬🇧 English documentation

Clone this wiki locally