[deutschebahn] Initial contribution: New binding for DeutscheBahn Fahrplan

[soenkekueper]

This binding uses the Timetable API of DeutscheBahn to query the DB timetable for an given railway station in germany. So openhab can display the next trains that are arriving / departing at this station, including live informations about delays or changes.

Therefore the binding provides an bridge type, that connects to the API and provides data, and an train thing that represents an train within this timetable.

The result may look like this:

Forum topic can be found here:
https://community.openhab.org/t/binding-for-deutschebahn-timetable/127534

Closes #11376

[soenkekueper]

Jenkins build has passed. Jar for testing is now available here:
https://openhab.jfrog.io/ui/native/libs-pullrequest-local/org/openhab/addons/bundles/org.openhab.binding.deutschebahn/3.2.0-SNAPSHOT/org.openhab.binding.deutschebahn-3.2.0-SNAPSHOT.jar

[fwolter]

Suggested change

	The informations are requested from the timetable api of DeutscheBahn developer portal, so you'll need a (free) developer account to use this binding.
	The information are requested from the timetable api of DeutscheBahn developer portal, so you'll need a (free) developer account to use this binding.

[soenkekueper]

fixed

[fwolter]

Suggested change

	8. Copy the "Zugangstoken". This is required to access the api from openhab.
	8. Copy the "Zugangstoken". This is required to access the api from openHAB.

[soenkekueper]

fixed

[fwolter]

Suggested change

	For the selection of the station within openhab you need the eva nr. of the station.
	For the selection of the station within openHAB you need the eva no. of the station.

[soenkekueper]

fixed

[fwolter]

Suggested change

	With access key for developer portal and eva nr. of your station you'r ready to configure a timetable (bridge) for this station.
	With access key for developer portal and eva no. of your station you're ready to configure a timetable (bridge) for this station.

[soenkekueper]

fixed

[fwolter]

Suggested change

	**Attention:** The timetable api only provides data for the next 18 hours. If the timetable contains less trains entries than you've created
	**Attention:** The timetable api only provides data for the next 18 hours. If the timetable contains less train entries than you've created

[soenkekueper]

fixed

[fwolter]

Suggested change

	Basically most informations are available as planned and changed value. This allows to easy display changed values (for example the delay or changed platform).
	Basically most information are available as planned and changed value. This allows to easy display changed values (for example the delay or changed platform).

[soenkekueper]

fixed

[fwolter]

Suggested change

	| messages | String | Messages for this train. Contains all translated codes from the messages of the selected train stop. Multiple messages will be separated with an single dash. |
	| messages | String | Messages for this train. Contains all translated codes from the messages of the selected train stop. Multiple messages will be separated with a single dash. |

[soenkekueper]

fixed

[fwolter]

WBT?

[soenkekueper]

The descriptions are taken from the original api documentation, so even i don't know what WBT means. I think it might be "Wall Board Timetable" or something else. So due this has no relevance here, i removed it.

[fwolter]

Suggested change

	| wings | String | A sequence of trip id separated by the pipe symbols. |
	| wings | String | A sequence of trip id separated by pipe symbols. |

[soenkekueper]

fixed

[fwolter]

I think images need to reside directly under doc/ to be rendered correctly on the OH webpage.

[soenkekueper]

fixed

[fwolter]

There are 3 compiler warnings left:

[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.deutschebahn\src\main\java\org\openhab\binding\deutschebahn\internal\AbstractDtoAttributeSelector.java:[80,34] Null type mismatch (type annotations): required 'VALUE_TYPE' but this expression has type '@Nullable VALUE_TYPE', where 'VALUE_TYPE' is a free type variable
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.deutschebahn\src\main\java\org\openhab\binding\deutschebahn\internal\DeutscheBahnTrainHandler.java:[20,8] The import org.openhab.binding.deutschebahn.internal.timetable.dto.Event is never used
[WARNING] C:\Users\Fabian Wolter\Documents\GitHub\openhab-addons\bundles\org.openhab.binding.deutschebahn\src\main\java\org\openhab\binding\deutschebahn\internal\DeutscheBahnTrainHandler.java:[22,8] The import org.openhab.binding.deutschebahn.internal.timetable.dto.TripLabel is never used

[soenkekueper]

I'm a little bit confued on that, due i've had some more unused imports, but they've been contained within the analysis report printed out at the very end of the build log and corrected all of them. No these compiler warnings aren't displayed either within eclipse nor in the report - hard to find... I'll fix them, but i would be great if all warnings would appear in build report...

[fwolter]

LGTM

[fwolter]

Now, you could add your binding's logo to the openHAB website. See https://next.openhab.org/docs/developer/bindings/#add-your-binding-s-logo-to-the-openhab-website