Skip to content

Latest commit

 

History

History
216 lines (116 loc) · 5.97 KB

Diagnostic.md

File metadata and controls

216 lines (116 loc) · 5.97 KB

@fairfleet/geotab / Diagnostic

Interface: Diagnostic

Vehicle diagnostic information from the engine computer that can either be measurement data or fault code data.

Remarks

Note: Diagnostics cannot be added, set or removed via the API.

Hierarchy

Table of contents

Properties

Properties

code

code: number

Gets or sets the diagnostic parameter code number.

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:22


controller

controller: Controller

Gets or sets the applicable Controller for the diagnostic parameter.

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:24


diagnosticType

diagnosticType: DiagnosticType

Gets or sets the DiagnosticType (source) of the diagnostic parameter.

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:26


engineType

engineType: EngineType

Gets or sets the EngineType for this diagnostic if applicable, otherwise null.

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:31


faultResetMode

faultResetMode: FaultResetMode

Gets or sets the FaultResetMode of the diagnostic (whether the fault resets automatically or manually).

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:33


id

id: string

Gets or sets the unique identifier for this entity. See Id.

Overrides

NameEntityWithVersion.id

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:35


isLogGuaranteedOnEstimateError

isLogGuaranteedOnEstimateError: boolean

Gets or sets the value which describes if the diagnostic guarantees it will log when estimate error is exceeded.

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:37


isReadOnly

isReadOnly: boolean

Gets a value indicating whether the diagnostic is readonly

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:39


name

name: string

Gets or sets the name of this entity that uniquely identifies it and is used when displaying this entity.

Overrides

NameEntityWithVersion.name

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:41


source

source: Source

Gets or sets the Source for the diagnostic (the type of diagnostic code).

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:43


tamperingDiagnostics

tamperingDiagnostics: Diagnostic[]

Gets the tampering diagnostic codes.

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:45


unitOfMeasure

unitOfMeasure: UnitOfMeasure

Gets or sets the UnitOfMeasure applicable to the diagnostic parameter.

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:47


validLoggingPeriod

validLoggingPeriod: ValidLoggingPeriod

Gets or sets the Diagnostic.ValidLoggingPeriod. The diagnostic should only be interpolated within the range of the given type.

Defined in

src/types/Checkmate/ObjectModel/Engine/Diagnostic.ts:49


version

version: number

Gets or sets the version of the entity.

Inherited from

NameEntityWithVersion.version

Defined in

src/types/Checkmate/ObjectModel/NameEntityWithVersion.ts:10