MMM-Tankerkoenig

MagicMirror² module to display the local gas prices in Germany.

1. Clone this repository in your MagicMirror installation into the folder modules: git clone https://github.com/wiesty/MMM-Tankerkoenig
2. Get your free* API key from creativecommons.tankerkoenig.de.
3. Head over to Tankerkoenig Station API Helper and copy your IDs.
4. Search your station and modify the config template below.
5. Add configuration to your config.js.

{
    module: "MMM-Tankerkoenig",
    position: "bottom_right",
    config: {
        apiKey: "00000000-0000-0000-0000-000000000000", 
        updateInterval: 600000, // update interval in ms (10 mins)
        stationNames: {
            "24a381e3-0d72-416d-bfd8-b2f65f6e5802": "Esso Tankstelle", // ID with custom name
            "474e5046-deaf-4f9b-9a32-9797b778f047": "Total Berlin", // another ID possible
        },
        fuelTypes: ["e5", "e10", "diesel"], // filter gas types
        sortOptions: {
            sortBy: 'name',        // 'name' | 'stationOrder' | 'price'
            direction: 'asc',      // 'asc' | 'desc'
            fuelType: 'e5'         // used only for sortBy === 'price'
        },
        options: {
            priceRound: "down"     // 'up', 'down', 'none', 'commercial'
        }
    }
},

🚀 Simple Version of Tankerkoenig API Looking to add more features in the future. Big thanks to Tankerkoenig for providing this great API – consider supporting them! 🙌 ⚠️ Network Traffic Reduction To help reduce network traffic, please enter the name of your desired station manually. 😊 📢 Note Information accuracy isn’t guaranteed, and the API may change from free to paid access at any time.

• Add sorting possibilities with sortOptions property
  • sortBy 'name', 'price' or 'stationOrder' for your own stationNames order
  • direction 'asc' or 'desc'
  • fuelType only for sortBy === 'price' and must be one of fuelTypes
• Add options property with child priceRound for how the price will be displayed
  • 'up' rounds up and results in 2 decimal digits
  • 'down' rounds down and results in 2 decimal digits
  • 'none' results in 3 decimal digits (rounds in a commercial way if necessary)
  • 'commercial' rounds in a commercial way and results in 2 decimal digits
• Add more (German) keywords for this module
• Add contributor 'TobTra89'