|
1 | | -# MZD_Speedometer v5 |
| 1 | +LongLong# MZD_Speedometer v5 |
| 2 | +### A Versatile Speedometer App For The MZD Infotainment System |
| 3 | +> **2 Speedometers in 1 With Multiple Variants:** |
| 4 | +> - Classic MZD Speedometer (By Diginix) |
| 5 | +> - Basic Analog Speedometer With Rotating Compass |
| 6 | +> - Modded Digital & Analog Speedometer With Toggle Controls |
| 7 | +> - Digital Bar Speedometers |
| 8 | +> - Value Positions Fully Customizable |
| 9 | +
|
2 | 10 | ## How To Install: |
3 | 11 | - Download a release zip from [releases](https://github.com/Trevelopment/MZD_Speedometer/releases) page |
4 | 12 | - Unzip onto blank FAT32 formatted USB drive |
5 | 13 | - Connect to car USB port and wait for installation to begin (2 - 20 minutes) |
6 | 14 | - Choose options when prompted by installer |
7 | | -- For more info visit [MazdaTweaks.com](https://mazdatweaks.com) |
| 15 | +- For more info visit [MazdaTweaks.com](https://mazdatweaks.com) |
| 16 | + |
| 17 | + |
| 18 | +## How To Customize |
| 19 | + > To customize edit the configuration file `/config/speedometer-config.js` |
| 20 | +##### Example Configuration: |
| 21 | +```js |
| 22 | +/** speedometer-config.js ************************************************************** *\ |
| 23 | +|* ========================= *| |
| 24 | +|* Speedometer Configuration - Used to configure position of Speedometer values. *| |
| 25 | +|* ========================= *| |
| 26 | +|* Main Speedometer Value: [0, 0, 0] - Large, Front, & Center. *| |
| 27 | +|* Other Values: [ 0/1:(0 For Main Column OR 1 For Bottom Rows), Row Number, Position ] *| |
| 28 | +|* Main Column Positions: 4 Values (1-4 From Top to Bottom) *| |
| 29 | +|* Bottom Rows Positions: 5 Values Per Row (1-5 From Left to Right) *| |
| 30 | +|* Examples: *| |
| 31 | +|* [0, 1, 4] = [Main, Column, 4th position (Bottom of the Column)] *| |
| 32 | +|* [1, 3, 1] = [Bottom, 3rd Row, First Position (Left Side)] *| |
| 33 | +|* [1, 1, 5] = [Bottom, 1st Row, Last Position (Right Side)] *| |
| 34 | +|* To Hide a Value = [1, 1, 0] (Any bottom row position 0 will hide the value) *| |
| 35 | +|* To Change Bottom Row Push Command Knob ("Select") *| |
| 36 | +|* Note: Only numbers inside [] brackets determine position, order in this list DOES NOT *| |
| 37 | +|* ******* DELETE THIS CONFIG FILE TO REUSE YOUR CURRENT CONFIG-SPEEDOMETER.JS ********* *| |
| 38 | +\* ************************************************************************************* */ |
| 39 | +var spdBottomRows = 3; //Number of Bottom Rows |
| 40 | +var spdTbl = { // Example Layout: |
| 41 | + vehSpeed: [0, 0, 0], //Vehicle Speed (Main Position) |
| 42 | + topSpeed: [0, 1, 1], //Top Speed (Right Column, Top Value) |
| 43 | + avgSpeed: [0, 1, 2], //Average Speed |
| 44 | + gpsSpeed: [0, 1, 3], //GPS Speed |
| 45 | + engSpeed: [0, 1, 4], //Engine Speed (Right Column, Bottom Value) |
| 46 | + trpTime: [1, 1, 1], //Trip Time (1st Bottom Row, Far Left) |
| 47 | + trpDist: [1, 1, 2], //Trip Distance |
| 48 | + outTemp: [1, 1, 3], //Outside Temperature |
| 49 | + inTemp: [1, 1, 4], //Intake Temperature |
| 50 | + coolTemp: [1, 1, 5], //Coolant Temperature |
| 51 | + gearPos: [1, 2, 1], //Gear Position |
| 52 | + gearLvr: [1, 1, 0], //Transmission Lever Position (hidden) |
| 53 | + fuelLvl: [1, 2, 2], //Fuel Gauge Level |
| 54 | + trpFuel: [1, 2, 3], //Trip Fuel Economy (2nd Bottom Row, Center) |
| 55 | + totFuel: [1, 2, 4], //Total Fuel Economy |
| 56 | + avgFuel: [1, 2, 5], //Average Fuel Economy |
| 57 | + gpsAlt: [1, 3, 2], //Altitude |
| 58 | + gpsAltMM: [1, 3, 3], //Altitude Min/Max |
| 59 | + gpsHead: [1, 3, 1], //GPS Heading |
| 60 | + gpsLat: [1, 3, 4], //GPS Latitude |
| 61 | + gpsLon: [1, 3, 5], //GPS Longitude (3rd Bottom Row, Far Right) |
| 62 | + trpIdle: [1, 1, 0], //Idle Time (hidden) |
| 63 | + trpEngIdle: [1, 1, 0], //Engine Idle Time (hidden) |
| 64 | + engTop: [1, 1, 0], //Engine Top Speed (hidden) |
| 65 | + engLoad: [1, 1, 0], //Engine Load (hidden) |
| 66 | + batSOC: [1, 1, 0], //Battery Charge State (i-stop) (hidden) |
| 67 | +}; |
| 68 | +``` |
| 69 | + |
| 70 | +```JS |
| 71 | +// OverRide Values |
| 72 | +/* ************************************************** */ |
| 73 | +/* Set overRideSpeed to true to use your values below */ |
| 74 | +/* If this is false the following values are not used */ |
| 75 | +var overRideSpeed=false; |
| 76 | +/* ************************************************** */ |
| 77 | +/* * Start OverRide Variables *********************** */ |
| 78 | +var SORV = { |
| 79 | + // Set the language for the speedometer |
| 80 | + // Available EN, ES, DE, PL, SK, TR, FR, IT |
| 81 | + language: "EN", |
| 82 | + |
| 83 | + // Used for metric/US english conversion flag (C/F, KPH/MPH, Meter/Feet, L per 100km/MPG) |
| 84 | + // Set isMPH: true for MPH, Feet, MPG |
| 85 | + // Set isMPH: false for KPH, Meter |
| 86 | + isMPH: false, |
| 87 | + |
| 88 | + // Set This to true to start with the Bar Speedometer Mod |
| 89 | + // False to use the analog speedometer |
| 90 | + barSpeedometerMod: true, |
| 91 | + |
| 92 | + // Set true to enable multicontroller and other mod features in classic mode |
| 93 | + // If false then use classic speedometer without Mods |
| 94 | + speedMod: true, |
| 95 | + |
| 96 | + // Set to true to start the classic speedometer in analog mode |
| 97 | + // False to start in digital mode |
| 98 | + startAnalog: true, |
| 99 | + |
| 100 | + // Set it true for the StatusBar Speedometer |
| 101 | + // False if you don't want the small speedometer in statusbar |
| 102 | + StatusBarSpeedometer: true, |
| 103 | + |
| 104 | + // Set to true for Outside Temperature & Fuel Efficiency in the statusbar |
| 105 | + // False for Compass & Altitude |
| 106 | + sbTemp: false, |
| 107 | + |
| 108 | + // Set true if you want the original speedometer background image as in version 4.2 or below |
| 109 | + // False for no background |
| 110 | + // If "true" the opacity above will be ignored |
| 111 | + original_background_image: false, |
| 112 | + |
| 113 | + // Set the opacity of black background color for speedometer, to reduce the visibility of custom MZD background images |
| 114 | + // Possible values 0.0 (full transparent) until 1.0 (complete black background) |
| 115 | + black_background_opacity: 0.0, |
| 116 | + |
| 117 | + // Set unit for fuel efficiency to km/L |
| 118 | + // False for L/100km |
| 119 | + fuelEffunit_kml: false, |
| 120 | + |
| 121 | + // Set this to true for Fahrenheit |
| 122 | + // False for Celsius |
| 123 | + tempIsF: false, |
| 124 | + |
| 125 | + // For the Speed Bar false for Current Vehicle Speed |
| 126 | + // Set This to true if you want the Colored Bar to measure engine speed |
| 127 | + engineSpeedBar: false, |
| 128 | + |
| 129 | + // Set This to true to hide the Speed Bar |
| 130 | + // False shows he bar |
| 131 | + hideSpeedBar: false, |
| 132 | + |
| 133 | + // Set this to true to enable counter animation on the speed number |
| 134 | + // False to disable speed counter animation |
| 135 | + // The animation causes the digital number to lag by 1 second |
| 136 | + speedAnimation: false, |
| 137 | +}; |
| 138 | +``` |
| 139 | +### Controls |
| 140 | +> (Long Hold Is 1.5 Seconds) |
| 141 | +
|
| 142 | +- (Long) Up: Change from Classic To Bar Spedometers (Both) |
| 143 | +- (Short) Left: Toggle Speedometer Background (Both) |
| 144 | +- Digital Bar |
| 145 | + - (Short) Select: Toggle Next Bottom Row |
| 146 | + - (Short) Up: Toggle mph - km/h |
| 147 | + - (Short) Down: Toggle Speed Bar: Vehicle Speed - RPM |
| 148 | + - (Short) Right: In mph Toggle Temp (C - F) and km/h Toggle Fuel Efficiency (L/100km - km/L) |
| 149 | + - (Long) Down: Hide / Show Speed Bar |
| 150 | + - (Long) Left: TBD (Same as Short Click) |
| 151 | + - (Long) Right: TBD (Same as Short Click) |
| 152 | + - (Long) Select: TBD (Same as Short Click) |
| 153 | +- Classic (Modded) |
| 154 | + - (Short) Select: Change between Analog w/ Compass & Digital |
| 155 | + - (Short) Up: Toggle Alternate Values (Temperatures and Gear Position) |
| 156 | + - (Short) Down: Increase Value Table Font Size |
| 157 | + - (Short) Right: Toggle mph - km/h |
| 158 | + - (Long) Down: Toggle Modded - Basic Speedometers (Basic mode has no toggles) |
| 159 | + - (Long) Left: TBD (Same as Short Click) |
| 160 | + - (Long) Right: TBD (Same as Short Click) |
| 161 | + - (Long) Select: TBD (Same as Short Click) |
0 commit comments