obd-parser
==========


A module for interacting with the OBD (On Board Diagnostics) of vehicles
via ELM 327 connections.

Install

``
npm install obd-parser --save
`

After this you will need to install a module that facilitates connecting to
the ECU. At present only _obd-parser-serial-connection_ is available - this
requires a USB to OBD connection such as these.

`
npm install obd-parser-serial-connection --save
`

Usage

`ts

// In your code this should be changed to 'obd-parser'
import * as OBD from 'obd-parser';

// Use a serial connection to connect
var getConnector = require('obd-parser-serial-connection');

// Returns a function that will allow us to connect to the serial port
var connectorFn:Function = getConnector({
// This might vary based on OS - this is the Mac OSX example
serialPath: '/dev/tty.usbserial',

// Might vary based on vehicle. This is the baudrate for a MK6 VW GTI
serialOpts: {
baudrate: 38400
}
});

// Need to initialise the OBD module with a "connector" before starting
OBD.init(connectorFn)
.then(function () {
// We've successfully connected. Can now create ECUPoller instances
const rpmPoller:OBD.ECUPoller = new OBD.ECUPoller({
// Pass an instance of the RPM PID to poll for RPM
pid: new OBD.PIDS.Rpm(),
// Poll every 1500 milliseconds
interval: 1500
});

// Bind an event handler for anytime RPM data is available
rpmPoller.on('data', function (output: OBD.OBDOutput) {
console.log('==== Got RPM Output ====');
// Timestamp (Date object) for wheb the response was received
console.log('time: ', output.ts);
// The bytes returned from the ECU when asked from RPM
console.log('bytes: ', output.bytes);
// A value that's usuall numeric e.g 1200
console.log('value: ', output.value);
// This will be a value such as "1200rpm"
console.log('pretty: ', output.pretty);
});

// Start polling (every 1500ms as specified above)
rpmPoller.startPolling();
});

`

Supported PIDs

`ts
import * as OBD from 'obd-parser';

new OBD.PIDS.FuelLevel();
new OBD.PIDS.Rpm();
new OBD.PIDS.VehicleSpeed();
new OBD.PIDS.CoolantTemp();

// This is the base class used by all above PIDS. You might want to extend
// this to create your own PIDs (don't forget to contribute them here!)
new OBD.PIDS.PID();
`

$3

`javascript
'use strict';

var OBD = require('obd-parser');

var getConnector = require('obd-parser-serial-connection');

var connect = getConnector({
serialPath: '/dev/tty.usbserial',
serialOpts: {
baudrate: 38400
}
});

OBD.init(connect)
.then(function () {
var rpmPoller = new OBD.ECUPoller({
pid: new OBD.PIDS.Rpm(),
interval: 1500
});

rpmPoller.on('data', function (output) {
console.log('==== Got RPM Output ====');
console.log('time: ', output.ts);
console.log('bytes: ', output.bytes);
console.log('value: ', output.value);
console.log('pretty: ', output.pretty);
});

rpmPoller.startPolling();
});
``

CHANGELOG

* 0.2.1
* Ensure definition files are included in published code

* 0.2.0
* Rewrite using TypeScript and Classes (inner conflict regarding Classes)
* Simplify getting and creating ECUPollers and PIDS
* Upadted documentation and example

* < 0.2.0 - (ಠ_ಠ)