Skip to content

Latest commit

 

History

History
114 lines (89 loc) · 4.93 KB

README.md

File metadata and controls

114 lines (89 loc) · 4.93 KB
Raw

MMM-Teslamate

Magic Mirror Module for the Teslamate utility

Graphic Mode

Teslamate_GraphicM3.png

Big thanks to olexs for this mode!

Hybrid Mode

Teslamate_ChargingM3.png Teslamate_ScheduledChargingM3.png

Also many thanks to adriankumpf for their incredible work on the Teslamate project, as well as aduyng for their TeslaStatus module used as a template!

If 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!

I 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...

Installation

  • Requires an active installation of Teslamate, with the MQTT (mosquitto) publisher configured.

Clone this repo into your MagicMirror modules directory using:

git clone https://github.com/denverquane/MMM-Teslamate.git

Then 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.

Sample Configuration

{
    module: 'MMM-Teslamate',
    position: 'bottom_left',
    config: {
        mqttServer: {
            address: '192.168.1.8',  // Server address or IP address of the MQTT broker
            port: 1883,              // Port number if other than default (1883)
            //user: 'user',          // Leave out for no user
            //password: 'password',  // Leave out for no password
        },

        rangeDisplay: "%", // "%" or "range"
        imperial: false, //use imperial units (true = Miles & F) or metric (false = Km & C)

        carID: '1', // defaults to '1'; only override if you have multiple Teslas and want to display 
                    // a specific car per instance of the module

        // set to true to enable both the graphic, and the additional stats 
        // (charge remaining, scheduled charge start, etc)
        hybridView: true,
        // size of the visible area
        sizeOptions: {
            // size of the icons + battery (above text)
            width: 450, // px, default: 450
            height: 203, // px, default: 203
            // the battery images itself
            batWitdh: 250, // px, default: 250
            batHeight: 75, // px, default: 75
            // visual distance reduction to the module above
            topOffset: -40, // px, default: -40
        },
        displayOptions: {
            odometer: {
                visible: true, // bool, default: true (option to hide the odometer)
                fontSize: null, // null (to use default/css) or numeric rem-value (default value is 1.8)
            },
            batteryBar: {
                visible: true, // bool, default: true (option to hide the battery-bar)
                topMargin: 0, // px, default: 0 (px-value to add space between the battery-bar and the informations above)
            },
            temperatureIcons: {
                topMargin: 0, // px, default: 0 (px-value to add space between the temperature-icons and the informations above)
            }
        },
        carImageOptions: {
            model: "m3", // mx, ms (S pre-refresh), ? (S post-refresh)

            view: "STUD_3QTR", // STUD_SIDE works better for S/X

            // full list of option codes: https://tesla-api.timdorr.com/vehicle/optioncodes.
            // you need at least the color and the wheels. not all combos work.
            // also consult: https://teslaownersonline.com/threads/teslas-image-compositor.7089/
            options: "PPSW,PFP31,W38B,DV4W",

            // play with this until it looks about right.
            // tested values: 0 for m3/STUD_3QTR, 25 for ms/STUD_SIDE
            verticalOffset: 0,

            opacity: 0.5
        },

        // show inside and outside temperatures below the car image: when AC or preconditioning is running (default), always, or never
        showTemps: "hvac_on", // "always", "never"

        // 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
        updatePeriod: 5,
    }
},

Notes

  • Some fields (charge added, time to full charge) are currently only enabled if the vehicle is plugged in

Ongoing work

  • Display Teslamate "status" topic
  • Add support to selectively enable/disable certain lines
  • Allow display for multiple Teslas
  • Add images of module
  • Selectively enable/disable certain fields based on other state (for example, still show scheduled charge time if plugged in)
  • Format and display Teslamate "scheduled charge time" topic
  • Proper Imperial/Metric conversion and formatting