Node package for cummunication with serial OBD connectors.
JavaScript
Latest commit b2d69c3 Aug 10, 2015 @EricSmekens Update readme.
Failed to load latest commit information.
example 0.2.0 - Dependancy version fix Mar 8, 2015
lib
tests/jasmine
.gitignore gitignore Apr 9, 2013
.npmignore
LICENSE
README.md
package.json Formatted code, updated dependancies. Aug 10, 2015

README.md

serial-obd 0.2.1

This version will only receive updates that were done in bluetooth-obd. On request I will update/sync this module with bluetooth-obd as this version is less-used.

Serial communication for OBD-II ELM327 devices.

This node module lets you communicate over a serial port with OBD-II ELM327 Connectors using Node.js.

Limitations

  • Only tested on Ubuntu
  • Only tested with rfcomm, and not with actual serial port yet.
  • Only tested on ELM327 devices.
  • Not all OBD-II Commands are implemented yet.

Use bluetooth-obd if you use a bluetooth OBD-II Connector!

Pre-requests

  • If it's a Bluetooth ELM327, then it should already be paired and connected with rfcomm connect!
  • You might need to run it with SUDO! (If it says: serial port X is not ready!)

Install

npm install serial-obd

Documentation

Basic usage

var OBDReader = require('serial-obd');
var options = {};
options.baudrate = 115200;
var serialOBDReader = new OBDReader("/dev/rfcomm0", options);
var dataReceivedMarker = {};

serialOBDReader.on('dataReceived', function (data) {
    console.log(data);
    dataReceivedMarker = data;
});

serialOBDReader.on('connected', function (data) {
    this.addPoller("vss");
    this.addPoller("rpm");
    this.addPoller("temp");
    this.addPoller("load_pct");
    this.addPoller("map");
    this.addPoller("frp");

    this.startPolling(2000); //Polls all added pollers each 2000 ms.
});

serialOBDReader.connect();

API

OBDReader

Event: ('dataReceived', data)

Emitted when data is read from the OBD-II connector.

  • data - the data that was read and parsed to a reply object

Event: ('connected')

Emitted when the connection is set up (port is open).

  • data - the data that was read and parsed to a reply object

OBDReader(portName, options)

Creates an instance of OBDReader.

Params:
  • string portName Port that will be connected to. For example: "/dev/rfcomm0"

  • Object options Object that contains options, e.g.: baudrate, databits, stopbits, flowcontrol. Same options serialport module uses.

getPIDByName(Name)

Find a PID-value by name.

Params:
  • name Name of the PID you want the hexadecimal (in ASCII text) value of.
Return:
  • string PID in hexadecimal ASCII

parseOBDCommand(hexString)

Parses a hexadecimal string to a reply object. Uses PIDS. (obdInfo.js)

Params:
  • string hexString Hexadecimal value in string that is received over the serialport.
Return:
  • Object reply - The reply.

  • string reply.value - The value that is already converted. This can be a PID converted answer or "OK" or "NO DATA".

  • string reply.name - The name. --! Only if the reply is a PID.

  • string reply.mode - The mode of the PID. --! Only if the reply is a PID.

  • string reply.pid - The PID. --! Only if the reply is a PID.

connect()

Connect/Open the serial port and add events to serialport. Also starts the intervalWriter that is used to write the queue.

disconnect()

Disconnects/closes the port.

write(message, replies)

Writes a message to the port. (Queued!) All write functions call this function.

Params:
  • string message The PID or AT Command you want to send. Without \r or \n!
  • number replies The number of replies that are expected. Default = 0. 0 --> infinite

requestValueByName(name)

Writes a PID value by entering a pid supported name.

Params:
  • string name Look into obdInfo.js for all PIDS.

addPoller(name)

Adds a poller to the poller-array.

Params:
  • string name Name of the poller you want to add.

removePoller(name)

Removes an poller.

Params:
  • string name Name of the poller you want to remove.

removeAllPollers()

Removes all pollers.

writePollers()

Writes all active pollers.

startPolling()

Starts polling. Lower interval than activePollers * 50 will probably give buffer overflows.

Params:
  • number interval Frequency how often all variables should be polled. (in ms) If no value is given, then for each activePoller 75ms will be added.

stopPolling()

Stops polling.

LICENSE

This module is available under a Apache 2.0 license, see also the LICENSE file for details.