{"id":13830613,"url":"https://github.com/denverquane/MMM-Teslamate","last_synced_at":"2025-07-09T12:30:41.135Z","repository":{"id":40257951,"uuid":"200400022","full_name":"denverquane/MMM-Teslamate","owner":"denverquane","description":"Magic Mirror Module for the Teslamate utility","archived":false,"fork":false,"pushed_at":"2024-06-18T13:02:58.000Z","size":321,"stargazers_count":53,"open_issues_count":6,"forks_count":14,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-11-14T17:48:08.358Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/denverquane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-03T16:57:40.000Z","updated_at":"2024-10-07T12:55:32.000Z","dependencies_parsed_at":"2024-01-15T17:39:17.325Z","dependency_job_id":"fdf14a9c-279e-459d-9e26-1592ea329993","html_url":"https://github.com/denverquane/MMM-Teslamate","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denverquane%2FMMM-Teslamate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denverquane%2FMMM-Teslamate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denverquane%2FMMM-Teslamate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/denverquane%2FMMM-Teslamate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/denverquane","download_url":"https://codeload.github.com/denverquane/MMM-Teslamate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225539458,"owners_count":17485337,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T10:01:03.061Z","updated_at":"2025-07-09T12:30:41.122Z","avatar_url":"https://github.com/denverquane.png","language":"JavaScript","funding_links":[],"categories":["Hardware"],"sub_categories":[],"readme":"# MMM-Teslamate\n## Magic Mirror Module for the Teslamate utility\n\n## Graphic Mode\n![Teslamate_GraphicM3.png](doc/graphic_m3.png)\n\nBig thanks to [olexs](https://github.com/olexs) for this mode!\n\n## Hybrid Mode\n\n![Teslamate_ChargingM3.png](doc/charging.PNG)\n![Teslamate_ScheduledChargingM3.png](doc/charge_starting.PNG)\n\nAlso many thanks to [adriankumpf](https://github.com/adriankumpf) for their incredible work on the [Teslamate](https://github.com/adriankumpf/teslamate) project,\nas well as [aduyng](https://github.com/aduyng) for their [TeslaStatus](https://github.com/aduyng/MMM-TeslaStatus) module used as a template!\n\nIf you have any feedback or suggestions, feel free to submit a MR with a feature, or log an issue for a feature you'd like to see!\n\nI use this module and Teslamate daily, so new MQTT topics should be added fairly regularly, but file an issue if I happen to miss one...\n\n## Installation\n\n* Requires an active installation of [Teslamate](https://github.com/adriankumpf/teslamate), with the MQTT (mosquitto) publisher configured.\n\nClone this repo into your MagicMirror modules directory using:\n\n```git clone https://github.com/denverquane/MMM-Teslamate.git```\n\nThen run `npm ci` inside the new cloned folder, and make sure to add the module to your MagicMirror config (config/config.js), using configuration similar to that in the Configuration section below.\n\n## Sample Configuration\n\n```\n{\n    module: 'MMM-Teslamate',\n    position: 'bottom_left',\n    config: {\n        mqttServer: {\n            address: '192.168.1.8',  // Server address or IP address of the MQTT broker\n            port: 1883,              // Port number if other than default (1883)\n            //user: 'user',          // Leave out for no user\n            //password: 'password',  // Leave out for no password\n        },\n\n        rangeDisplay: \"%\", // \"%\" or \"range\"\n        imperial: false, //use imperial units (true = Miles \u0026 F) or metric (false = Km \u0026 C)\n\n        carID: '1', // defaults to '1'; only override if you have multiple Teslas and want to display \n                    // a specific car per instance of the module\n\n        // set to true to enable both the graphic, and the additional stats \n        // (charge remaining, scheduled charge start, etc)\n        hybridView: true,\n        // size of the visible area\n        sizeOptions: {\n            // size of the icons + battery (above text)\n            width: 450, // px, default: 450\n            height: 203, // px, default: 203\n            // the battery images itself\n            batWitdh: 250, // px, default: 250\n            batHeight: 75, // px, default: 75\n            // visual distance reduction to the module above\n            topOffset: -40, // px, default: -40\n            fontSize: '.9rem', // null (to use default/css) or rem/px\n            lineHeight: '1rem', // null (to use default/css) or rem/px\n        },\n        displayOptions: {\n            odometer: {\n                visible: true, // bool, default: true (option to hide the odometer)\n            },\n            batteryBar: {\n                visible: true, // bool, default: true (option to hide the battery-bar)\n                topMargin: 0, // px, default: 0 (px-value to add space between the battery-bar and the informations above)\n            },\n            temperatureIcons: {\n                topMargin: 0, // px, default: 0 (px-value to add space between the temperature-icons and the informations above)\n            },\n            tpms: {\n                visible: true, // bool, default: true (option to hide the tpms)\n            },\n            speed: {\n                visible: true, // bool, default: true (option to hide the speed)\n            },\n            geofence: {\n                visible: true, // bool, default: true (option to hide the speed)\n            }\n        },\n        carImageOptions: {\n            model: \"m3\", // mx, ms (S pre-refresh), ? (S post-refresh)\n            view: \"STUD_3QTR\", // STUD_SIDE works better for S/X\n            // full list of option codes: https://tesla-api.timdorr.com/vehicle/optioncodes.\n            // you need at least the color and the wheels. not all combos work.\n            // also consult: https://teslaownersonline.com/threads/teslas-image-compositor.7089/\n            options: \"PPSW,PFP31,W38B,DV4W\",\n            // play with this until it looks about right.\n            // tested values: 0 for m3/STUD_3QTR, 25 for ms/STUD_SIDE\n            verticalOffset: 0,\n            // scale the image to remove excessive background on the sides\n            scale: 1,\n            opacity: 0.5\n        },\n        // show inside and outside temperatures below the car image: when AC or preconditioning is running (default), always, or never\n        showTemps: \"hvac_on\", // \"always\", \"never\"\n        // time in seconds to wait before re-rendering the module on incoming data. prevents high CPU load due to re-rendering on every new data point during driving\n        updatePeriod: 5,\n    }\n},\n```\n\n## Notes\n* Some fields (charge added, time to full charge) are currently only enabled if the vehicle is plugged in\n\n## Ongoing work\n* Display Teslamate \"status\" topic\n* Add support to selectively enable/disable certain lines\n* ~~Allow display for multiple Teslas~~\n* ~~Add images of module~~\n* ~~Selectively enable/disable certain fields based on other state (for example, still show scheduled charge time if plugged in)~~\n* ~~Format and display Teslamate \"scheduled charge time\" topic~~\n* ~~Proper Imperial/Metric conversion and formatting~~","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenverquane%2FMMM-Teslamate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdenverquane%2FMMM-Teslamate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdenverquane%2FMMM-Teslamate/lists"}