Torque Wiki - User contributions [en-gb]

Main Page

2025-05-24T07:07:09Z

Ihawkins: /* Most useful bits */ updated change log link

<big>'''What is Torque?'''</big>

Torque is an OBD2 performance and diagnostic tool for any device that runs the Android operating system. It will allow you to access the many sensors within your vehicles Engine Management System, as well as allow you to view and clear trouble codes.

[[Image:torquehand.jpg|thumb|400px|Torque running on an android phone]]

===Most useful bits===

Here's a list of the most common questions asked regarding Torque:

* Will it work with my vehicle - [[Vehicle Requirements]]
* Where do I get the adapter - [[Bluetooth Adapters|Comparison of adapters available]]
* Getting started - [[Getting Started|Connecting to the adapter]]
* How to export videos with the Track Recorder plugin - [[Exporting Video|(Exporting video)]] *UPDATED with Wi-Fi sync*
* My speed seems to be inaccurate - [[Speedometer|Vehicle speedometer calibration]]
* Plugins that can be downloaded to bring new functions to the app - [[Plugins|Plugins]]
* Scripts - run your own scripts in Torque! [[Scripting|Scripting]]
* How to make your own - [[Themes]]
* How to add predefined sensors - [http://www.youtube.com/watch?v=oWR6qsTQYHc Video]
* Forums [http://torque-bhp.com/forums]
* How to translate the app into your language - [[Translation]]
* Make your own adapter using an Arduino [[Arduino]]
* [https://torque-bhp.com/community/main-forum/torque-changelog/ CHANGE LOGs (what happens between each version of the app)]

===Other information (incomplete, still being documented) ===
* Plugin Information - [[PluginDocumentation|Documentation]]
* List of dials including any special features - [[Dials|Dial documentation]]
* Information about uploading data to a webserver - [[Uploading OBD2 data]]
* Setting up and using alarms - [[Alarms]]
* Dashboard installations using tablets [[Dashboard installation]]

Class:Sensor

2022-02-17T11:37:27Z

Ihawkins: /* Methods */

== Sensor ==

Used for retrieving from, and creating/setting sensors and sensor readings in Torque

=== Methods ===
<syntaxhighlight lang="Java">

/**
* Get the long name of this sensor
* @return
*/
public String getLongName();

/**
* Get the short name of this sensor (used as the title in displays)
* @return
*/
public String getShortName();

/**
* Get the units of this sensor
* @return
*/
public String getUnit();

/**
* Get the PID of this sensor
* @return
*/
public String getPid();

/**
* Set a value on a given sensor object
*/
public setValue(double newValue);

/**
* Get the Sensor value
*
* If it is not populated or retrieved yet it will return zero
*
* This will also trigger a request to update the sensor
* (via OBD if required) - this may not be immediately done if other
* sensors are in the process of being requested, or
* the sensor is not available (due to no connection, etc)
*
* @return The current value for the sensor, or zero if not present
*/
public Double getValue();

/**
* Get the sensor value
*
* If it is not populated, then return the default value passed
*
* This will trigger a request to update the sensor - this may not be immediately done if other
* sensors are in the process of being requested, or the sensor is not available (due to no connection, etc)
*
* @param defaultValue The value to return if the sensor has no value yet, can be null
* @return The value of the sensor, or 'defaultValue' if not yet present
*/
public Double getValue(Double defaultValue);

/**
* Retrieve a sensor by name
*
* @param The full name of the sensor
* @return a Sensor object
*/
public static Sensor getSensorByName(String name);

/**
* Retrieve a sensor by id
*
* This retrieves a sensor by it's id (which is loosely defined as the PID of the sensor)
* A list of IDs can be viewed using the TorqueScan plugin
*
* @param id the ID of the sensor
* @return
*/
public static Sensor getSensorById(int id);

/**
* This creates a 'script' sensor that is then available to the rest of the app (and other scripts)
*
* The sensors are keyed by their fullName - if it already exists, it is overwritten.
* You cannot overwrite existing non-script sensors - trying will throw an exception in your script
*
* Calling setValue on the returned sensor object can be used to update the value.
*
* @param fullName The full, unique name of the sensor
* @param shortName The shortname of the sensor for use in displays
* @param units The sensor units (ms, S, psi, km/h, etc)
* @return A sensor object representing a new sensor or null if the sensor could not be created
*/
public static Sensor createSensor(String fullName, String shortName, String units);

/**
* Remove a sensor we created
*
* Sensors created by a script are also automatically cleaned up (removed) when the script is
* stopped or restarted
*
* @param fullName
* @return true if the sensor was found, was originally created by this script, and was removed.
*/
public static boolean removeSensor(String fullName);
</syntaxhighlight>

=== Examples ===

An example usage might look like:
<syntaxhighlight lang="Java">

/**
* This is called when the script is first loaded, only once.
*
* This function is required and must complete within 1000ms.
*/
onInit = function() {
quit = false;
// Create 'sensor' as a global variable - use 'val' if you want the variable
// to be local inside the function only - eg: 'val myVariable = "moo"'
sensor = Sensor.createSensor("Test sensor","Test","ms");
}

/**
* This is a 'main' entry point for your script, (if you choose to
* define this function), it can run indefinitely while (!quit) { ... } style
*
* This function is optional and does not need to be defined.
*/
main = function() {
while (!quit) {
// Update the sensor with the current time
sensor.setValue(Time.currentTimeMillis());
// Sleep 1 second
Time.sleep(1000);
}
}

/**
* This is called when your main function should stop and exit (if you use the function)
*
* This function is required if you have defined the main function, it must
* return within 1000ms. Usually you will just put a 'quit=true;' here so your
* main loop exits properly instead of having to be forcibly stopped by the app
*/
stop = function() {
quit = true;
};

</syntaxhighlight>

PluginDocumentation

2022-02-11T17:25:02Z

Ihawkins:

There is an example 'plugin' that demonstrates how to use the plugin interface in Torque here: [[http://ian-hawkins.com/torquescan.zip]] - this is a basic example, have a look at the AIDL file for the API documentation

There is a forum post here: [[http://torque-bhp.com/forums/?wpforumaction=viewtopic&t=438.0]] that explains some more about plugin development

The latest AIDL API file [[http://torque-bhp.com/api/ITorqueService.aidl is here]]

Torque also responds to intents - these can be used with other apps such as [https://play.google.com/store/apps/details?id=net.dinglisch.android.taskerm Tasker] - you can send or listen to the following intents:
<pre>
org.prowl.torque.REQUEST_TORQUE_QUIT (Properly shuts down Torque and related services - this must be sent as a broadcast type intent)

org.prowl.torque.OBD_CONNECTED (Sent when Torque connects to an OBD2 adapter)
org.prowl.torque.OBD_DISCONNECTED (Sent when Torque is disconnected from the OBD2 adapter)
org.prowl.torque.APP_LAUNCHED (Sent when Torque starts up)
org.prowl.torque.APP_QUITTING (Sent when Torque is about to quit)
</pre>

Torque also sends an intent when an Alarm PID is triggered:

<pre>
org.prowl.torque.ALARM_TRIGGERED (Sent when an alarm PID is triggered)

[intent bundle contents]
String - "ALARM_NAME" - The alarm name
String - "ALARM_TYPE" - The type of alarm trigger threshold ("MINIMUM" or "MAXIMUM")
double - "CURRENT_VALUE" - The current value of the PID/equation the alarm is referencing
double - "TRIGGER_VALUE" - The trigger value for the alarm (below/above this will trigger the alarm based on the alarm type)
String - "UNIT" - The unit that the PID uses

</pre>

If there is an intent you would like to see, feel free to email me at [mailto:piemmm20@googlemail.com piemmm20@googlemail.com]

Here is a list of some of the extended information Torque provides which your plugin can call on, or you can use for custom themes - a full list of what torque supports for your vehicle can be viewed using the TorqueScan plugin:

{| border="1" class="wikitable"
!Identifier
!Description
|-
|0x03
|Fuel system status
|-
|0x04
|Calculated engine load value
|-
|0x05
|Engine coolant temperature
|-
|0x06
|Short term fuel trim (bank 1)
|-
|0x07
|Long term fuel trim (bank 1)
|-
|0x08
|Short term fuel trim (bank 2)
|-
|0x09
|Long term fuel trim (bank 2)
|-
|0x0a
|Fuel pressure
|-
|0x0b
|Intake manifold absolute pressure (MAP)
|-
|0x0c
|Engine RPM
|-
|0x0d
|Vehicle speed
|-
|0x0e
|Timing advance
|-
|0x0f
|Intake air temperature (IAT)
|-
|0x10
|Mass air flow rate (MAF)
|-
|0x11
|Throttle position (at manifold), this is not the accelerator pedal, and this is a relative reading.
|-
|
|(Rest of PIDs(above) are as per MODE $01 SAE spec), next follows Torque internal PIDs
|-
|0xff1005
|GPS Longitude
|-
|0xff1006
|GPS Latitude
|-
|0xff1001
|GPS Speed
|-
|0xff1010
|GPS Height
|-
|0xff1007
|GPS Bearing
|-
|0xff1201
|MPG
|-
|0xff1202
|Turbo Boost
|-
|0xff1203
|Kilometers Per Litre
|-
|0xff1205
|Trip MPG
|-
|0xff1206
|Trip KPL
|-
|0xff1207
|Litres per Kilometre
|-
|0xff1208
|Trip LPK
|-
|0xff120A
|Manifold Vacuum
|-
|0xff120B
|GPS Trip distance
|-
|0xff120C
|Vehicle distance (Odometer) saved with profile
|-
|0xff1220
|Accelerometer (X)
|-
|0xff1221
|Accelerometer (Y)
|-
|0xff1222(
|Accelerometer (Z)
|-
|0xff1223
|Accelerometer (Total)
|-
|0xff1225
|Torque
|-
|0xff1226
|Horsepower
|-
|0xff122d
|0-60 mph time
|-
|0xff122e
|0-100 kph time
|-
|0xff122f
|Quarter mile time
|-
|0xff1230
|eighth mile time
|-
|0xff1237
|GPS vs OBD speed diff
|-
|0xff1238
|Voltage
|-
|0xff1239
|GPS Accuracy
|-
|0xff123A
|GPS Satellites locked
|-
|0xff123B
|GPS bearing
|-
|0xff1249
|AFR
|-
|0xff1214->ff121B
|O2 Sensors 1x1->1x4, 2x1->2x4
|-
|0xff1240->ff1247
|O2 Eqv Ratio 1->8
|-
|0xff1257
|CO2 in G/KM
|-
|0xff1258
|CO2 in G/KM average
|-
|0xff125a
|Fuel rate
|-
|0xff125b
|Fuel cost (trip)
|-
|0xff125c
|Fuel used (trip)
|-
|0xff1255
|Torque RPM component
|-
|0xff1256
|HorsePower RPM component
|-
|0xff124d
|Commanded AFR
|-
|0xff1249
|Measured AFR
|}

Extended PIDs are as shown by their 'PID' in the PID editor (Settings->Manage extended PIDs->tap on a PID for more information). You can use the [[https://play.google.com/store/apps/details?id=org.prowl.torquescan 'TorqueScan']] plugin to get a full list of these IDs

Ihawkins: /* Vehicle */

== Vehicle ==

Utility methods for information in the users vehicle profile settings (since 1.12.6)

=== Methods ===
<syntaxhighlight lang="Java">

/**
* Returns the name of the vehicle profile in use
*
* @return the profile name
*/
public static String getName() ;

/**
* Get the engine displacement in litres (if the car is not electric)
*
* @return displacement in litres
*/
public static float getDisplacement();

/**
* Gets the vehicle fuel type
*
* PETROL = 0;
* DIESEL = 1;
* E85 = 2;
* E10 = 3;
* E15 = 4;
* CNG = 5;
* LPG = 6;
* E20 = 7;
* E100 = 8;
* ETHANOL = 9;
* METHANOL = 10;
* E27 = 11;
*
* @return the fuel type, expressed as an int
*/
public int getFuelType();

/**
* Returns the custom init used with the OBD2 adapters
*
* @return the init, each command separated by '\n'
*/
public static String getCustomInit();

/**
* Get the vehicle weight in kilogrammes including an approximation of driver weight
*
* @return the total weight in kg
*/
public static float getWeight();

</syntaxhighlight>

Class:Speech

2022-01-22T14:23:52Z

Ihawkins: /* Methods */

== Speech ==

Utility methods for dealing with talking to the user (since 1.12.6)

=== Methods ===
<syntaxhighlight lang="Java">
/**
* Starts the TTS system and 'speaks' to the user
*
* @param text The text to speak to the user
*/
public static void speak(String text);

</syntaxhighlight>

=== Examples ===

An example usage might look like:
<syntaxhighlight lang="Java">

Speech.speak("Number five is alive!");

</syntaxhighlight>