Class Main

Hierarchy

EventEmitter
- Main

Implements

EventEmitter

Index

Constructors

constructor

Properties

Constructors

constructor

new Main(options: any): Main

- Defined in index.ts:38
Parameters
- options: any
Returns Main

Properties

DTC

DTC: DTC

Device

Device: Main

OBD

OBD: OBD

PID

PID: PID

Serial

Serial: OBD2_SerialInterface

Ticker

Ticker: Ticker

Private _options

_options: OBD2_IOptions

Static EventEmitter

EventEmitter: EventEmitter

Static defaultMaxListeners

defaultMaxListeners: number

Methods

Private _tickListDTC

_tickListDTC(callBack: any): void

- Defined in index.ts:332
Parameters
- callBack: any
Returns void

Private _tickListPID

_tickListPID(pidList: any, callBack: any): void

- Defined in index.ts:304
Parameters
- pidList: any
- callBack: any
Returns void

addListener

addListener(event: string, listener: Function): EventEmitter

Implementation of EventEmitter.addListener

Inherited from EventEmitter.addListener
- Defined in typings/main/ambient/node/node.d.ts:444
Parameters
- event: string
- listener: Function
Returns EventEmitter

emit

emit(event: string, ...args: any[]): boolean

Implementation of EventEmitter.emit

Inherited from EventEmitter.emit
- Defined in typings/main/ambient/node/node.d.ts:452
Parameters
- event: string
- Rest ...args: any[]
Returns boolean

getMaxListeners

getMaxListeners(): number

Implementation of EventEmitter.getMaxListeners

Inherited from EventEmitter.getMaxListeners
- Defined in typings/main/ambient/node/node.d.ts:450
Returns number

listDTC

listDTC(callBack: any): void

- Defined in index.ts:129
Parameters
- callBack: any
Returns void

listPID

listPID(callBack: any): void

- Defined in index.ts:110
Parameters
- callBack: any
Returns void

listenerCount

listenerCount(type: string): number

Implementation of EventEmitter.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in typings/main/ambient/node/node.d.ts:453
Parameters
- type: string
Returns number

listeners

listeners(event: string): Function[]

Implementation of EventEmitter.listeners

Inherited from EventEmitter.listeners
- Defined in typings/main/ambient/node/node.d.ts:451
Parameters
- event: string
Returns Function[]

on

on(event: string, listener: Function): EventEmitter

Implementation of EventEmitter.on

Inherited from EventEmitter.on
- Defined in typings/main/ambient/node/node.d.ts:445
Parameters
- event: string
- listener: Function
Returns EventEmitter

once

once(event: string, listener: Function): EventEmitter

Implementation of EventEmitter.once

Inherited from EventEmitter.once
- Defined in typings/main/ambient/node/node.d.ts:446
Parameters
- event: string
- listener: Function
Returns EventEmitter

readPID

readPID(pidNumber: string, pidMode?: string, callBack?: any): void

- Defined in index.ts:299
Reading PID code

Parameters
- pidNumber: string
- Optional pidMode: string
- Optional callBack: any
Returns void

removeAllListeners

removeAllListeners(event?: string): EventEmitter

Implementation of EventEmitter.removeAllListeners

Inherited from EventEmitter.removeAllListeners
- Defined in typings/main/ambient/node/node.d.ts:448
Parameters
- Optional event: string
Returns EventEmitter

removeListener

removeListener(event: string, listener: Function): EventEmitter

Implementation of EventEmitter.removeListener

Inherited from EventEmitter.removeListener
- Defined in typings/main/ambient/node/node.d.ts:447
Parameters
- event: string
- listener: Function
Returns EventEmitter

sendAT

sendAT(atCommand: string): void

- Defined in index.ts:92
Parameters
- atCommand: string
Returns void

sendPID

sendPID(pidNumber: string, pidMode?: string, callBack?: any): void

- Defined in index.ts:286
Sending PID code

Parameters
- pidNumber: string
- Optional pidMode: string
- Optional callBack: any
Returns void

setMaxListeners

setMaxListeners(n: number): EventEmitter

Implementation of EventEmitter.setMaxListeners

Inherited from EventEmitter.setMaxListeners
- Defined in typings/main/ambient/node/node.d.ts:449
Parameters
- n: number
Returns EventEmitter

start

start(callBack: any): void

- Defined in index.ts:60
Parameters
- callBack: any
Returns void

writePID

writePID(replies: string, loop: boolean, pidNumber: string, pidMode?: string, callBack?: any): void

- Defined in index.ts:145
Writing PID

Parameters
- replies: string
- loop: boolean
- pidNumber: string
- Optional pidMode: string
- Optional callBack: any
Returns void

Static listenerCount

listenerCount(emitter: EventEmitter, event: string): number

Inherited from EventEmitter.listenerCount
- Defined in typings/main/ambient/node/node.d.ts:441
Parameters
- emitter: EventEmitter
- event: string
Returns number

Generated using TypeDoc