Class Vehicle

Hierarchy

Vehicle

Implements

IVehicle

Index

Constructors

constructor

Properties

Accessors

offset

Constructors

constructor

new Vehicle(device: IDevice, offset?: number, name?: string): Vehicle

- Defined in vehicle/Vehicle.ts:31
Parameters
- device: IDevice
- Default value offset: number = 0
- Default value name: string = ""
Returns Vehicle

Properties

Private _builder

_builder: MessageBuilder

Private _device

_device: IDevice

Private _listeners

_listeners: Array<function>

Private _offset

_offset: number

address

address: string

id

id: string

name

name: string

Accessors

offset

get offset(): number

- Defined in vehicle/Vehicle.ts:181
Returns number

Methods

addListener

addListener<T>(listener: function): void

- Defined in vehicle/Vehicle.ts:177
Type parameters
- T: IVehicleMessage
Parameters
- listener: function
  - - (message: T): any
    - Parameters
      - message: T
      Returns any
Returns void

cancelLaneChange

cancelLaneChange(): void

Implementation of IVehicle.cancelLaneChange
- Defined in vehicle/Vehicle.ts:43
Returns void

changeLane

changeLane(offset: number, speed?: number, acceleration?: number, hopIntent?: number, tag?: number): void

- Defined in vehicle/Vehicle.ts:47
Parameters
- offset: number
- Default value speed: number = 300
- Default value acceleration: number = 300
- Default value hopIntent: number = 0
- Default value tag: number = 0
Returns void

connect

connect(): Promise<Vehicle>

Implementation of IVehicle.connect
- Defined in vehicle/Vehicle.ts:58
Returns Promise<Vehicle>

disableSdkMode

disableSdkMode(): void

Implementation of IVehicle.disableSdkMode
- Defined in vehicle/Vehicle.ts:73
Returns void

disconnect

disconnect(): Promise<Vehicle>

Implementation of IVehicle.disconnect
- Defined in vehicle/Vehicle.ts:77
Returns Promise<Vehicle>

enableSdkMode

enableSdkMode(): void

Implementation of IVehicle.enableSdkMode
- Defined in vehicle/Vehicle.ts:90
Returns void

queryBatterLevel

queryBatterLevel(): Promise<number>

Implementation of IVehicle.queryBatterLevel
- Defined in vehicle/Vehicle.ts:94
Returns Promise<number>

queryPing

queryPing(): Promise<number>

Implementation of IVehicle.queryPing
- Defined in vehicle/Vehicle.ts:106
Returns Promise<number>

queryVersion

queryVersion(): Promise<number>

Implementation of IVehicle.queryVersion
- Defined in vehicle/Vehicle.ts:120
Returns Promise<number>

Private readAndPublish

readAndPublish(payload: Buffer): void

- Defined in vehicle/Vehicle.ts:193
Parameters
- payload: Buffer
Returns void

Private removeAllListeners

removeAllListeners(): void

- Defined in vehicle/Vehicle.ts:189
Returns void

removeListener

removeListener<T>(listener: function): void

- Defined in vehicle/Vehicle.ts:185
Type parameters
- T: IVehicleMessage
Parameters
- listener: function
  - - (message: T): any
    - Parameters
      - message: T
      Returns any
Returns void

Private sendRequest

sendRequest<Req, Res>(request: Req, responseId: number): Promise<Res>

- Defined in vehicle/Vehicle.ts:214
Type parameters
- Req: IVehicleMessage
- Res: IVehicleMessage
Parameters
- request: Req
- responseId: number
Returns Promise<Res>

setOffset

setOffset(offset: number): void

Implementation of IVehicle.setOffset
- Defined in vehicle/Vehicle.ts:132
Parameters
- offset: number
Returns void

setSpeed

setSpeed(speed: number, acceleration?: number, limit?: boolean): void

- Defined in vehicle/Vehicle.ts:140
Parameters
- speed: number
- Default value acceleration: number = 500
- Default value limit: boolean = false
Returns void

turnLeft

turnLeft(): void

Implementation of IVehicle.turnLeft
- Defined in vehicle/Vehicle.ts:149
Returns void

turnRight

turnRight(): void

Implementation of IVehicle.turnRight
- Defined in vehicle/Vehicle.ts:156
Returns void

uTurn

uTurn(): void

Implementation of IVehicle.uTurn
- Defined in vehicle/Vehicle.ts:163
Returns void

uTurnJump

uTurnJump(): void

Implementation of IVehicle.uTurnJump
- Defined in vehicle/Vehicle.ts:170
Returns void

Private writeAndPublish

writeAndPublish<T>(message: T): void

- Defined in vehicle/Vehicle.ts:206
Type parameters
- T: IVehicleMessage
Parameters
- message: T
Returns void

Generated using TypeDoc