Skip to content

About

MMM-KVV-Trias uses the Trias API to gather data from KVV Directly

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

MMM-KVV-Trias

This is a MagicMirror² module to gather data from the official KVV-Trias api.

THIS MODULE IS NOT FULLY DEVELOPED, BUT ALREADY SOMEWHAT WORKS!!

Example of MMM-Template

MMM-KVV-Trias uses the Trias API to gather data from KVV Directly

Getting Trias API KEY

Check out the official Website:
KVV Website
Or:
Fill Out and sign this pdf
OpenData_Nutzungsvereinbarung.pdf
and send to:
fahrplan@kvv.karlsruhe.de

Installation

Install

In your terminal, go to your MagicMirror² Module folder and clone MMM-Template:

cd ~/MagicMirror/modules
git clone https://github.com/ZeroTwoWeeb/MMM-KVV-Trias
cd /MMM-KVV-Trias
npm install

if there are missing dependencies

npm install xml2js
npm install node-fetch@2

Update

cd ~/MagicMirror/modules/MMM-KVV-Trias
git pull

Using the module

To use this module, add it to the modules array in the config/config.js file:

    {
		module: "MMM-KVV-Trias",
		position: "bottom_left",
		config: {
			stationID: "de:08212:90:2:1", // Replace with actual stop ID from stops.txt
			updateInterval: 60000,
			stopsToShow: 5, // how many trains will be shown
			apiURL: "https://projekte.kvv-efa.de/YOUR_API_NAME/trias",
			requestorRef: "API_KEY"
		}
	},

Configuration options

Option Default Description
stationID not available Station ID from stops.txt (google transit data) Download google_transit.zip containing newest stops.txt
updateInterval 60000 interval of api calls (the API is rate limited) stay over 30000
stopsToShow 5 how many connections will be shown
apiURL your custom api URL (get it from KVV) Getting Trias API KEY
requestorRef your api key Getting Trias API KEY

The MIT License (MIT)

Copyright © 2025 ZeroTwoWeeb (https://github.com/ZeroTwoWeeb)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

MMM-KVV-Trias uses the Trias API to gather data from KVV Directly

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages