Namespace Geotab.Checkmate.ObjectModel.Engine

Classes

AiModelController: Object representing the specific, known ID reserved for faults generated with manufacturer specific codes.

AiModelDiagnostic: A diagnostic for an AI Model.

BasicDiagnostic: Information from the engine computer that can either be measurement data or fault code data. This inherited class only consists of a diagnostics Id.

BrpFaultController: Object representing the specific, known ID reserved for faults generated with manufacturer specific codes.

BrpFaultDiagnostic: A diagnostic for a Brp Device fault.

Controller: The controller that the diagnostic belongs to. Controllers could be ABS controller, suspension controller etc. The available controllers are listed in the KnownId.

ControllerSearch: The object used to specify the arguments when searching for Controller(s).

DataDiagnostic: A Diagnostic that represents measurement data from the vehicle (as opposed to fault codes).

Diagnostic: Vehicle diagnostic information from the engine computer that can either be measurement data or fault code data. Note: Diagnostics cannot be added, set or removed via the API.

DiagnosticMapping: Represents the relationship of a Device and a MappedDiagnostic with a Diagnostic. Device and MappedDiagnostic pair must be unique for this entity, so a MappedDiagnostic can be resolved as follows: "For this device and mapped diagnostic, tell me which is the actual diagnostic I have to use.".

DiagnosticMappingSearch: A Search object to search for DiagnosticMapping rows.

DiagnosticSearch: true search The object used to specify the arguments when searching for Diagnostic(s).

DiagnosticSignal: An obsolete, unused class.

DiagnosticTranslation: false Vehicle diagnostic translation. Note: this class should only be used for migration purpose.

DisplayCode: Class to display engine code.

EngineType: The type of engine the device has, or which engine type an Engine Management Code belongs to. The standard types are represented by the strings "EngineTypeGenericId" for the generic engine and "EngineTypeNoneId" where engine type is not available.

EngineTypeGeneric

false

Represents the default EngineType.

EngineTypeNone

false

Represents an empty (null) EngineType, used for devices that are not engine-assigned.

EngineTypeSearch: search The object used to specify the arguments when searching for EngineType(s).

EngineTypeSystem: Base class for all system engine types.

EnumName: false Represents a diagnostic enum that provides information about diagnostic value

FailureMode: The Failure Mode Identifier (FMI) used to describe engine fault codes. This is represented by the string "NoFailureModeId" when there is no applicable FMI.

FailureModeSearch: true search The object used to specify the arguments when searching for a FailureMode.

FaultData: A record that represents a fault code record from the engine system of the specific Device.

FaultDataByIgnitionCycle: A record that represents a fault code record from the engine system of the specific Device populated with ignition cycle information.

FaultDataSearch

true search

The object used to specify the arguments when searching for a FaultData.

This search has been designed to work efficiently with these combinations of parameters:

FaultStateProvider: Class to describe the current FaultState when a single one is present.

FaultStatus: Class to describe FaultState.

FaultStatusActive: Specifies that the FaultStatus is Active.

FaultStatusCleared: The Cleared Fault Status.

FaultStatusInactive: Specifies that the FaultState is Inactive.

FaultStatusNone: The None (unknown or clear) Fault Status.

FaultStatusPending: The Pending Fault Status.

FlashCode: The optional summary code references for specific Diagnostic items referencing FaultData records.

GmcccFaultController: Object representing the specific, known ID reserved for faults generated with manufacturer specific codes.

GmcccFaultDiagnostic: A diagnostic for a Gmccc Device fault.

GoDiagnostic: A diagnostic that originates from a Go Device.

GoFaultController: Object representing the specific, known ID reserved for faults generated by the Geotab GO Device.

GoFaultDiagnostic: A diagnostic for a Go Device fault.

LegacyFaultController: Object representing the specific, known ID reserved for faults generated with legacy manufacturer specific codes.

LegacyFaultDiagnostic: A diagnostic for a legacy manufacturer specific fault.

LevcFaultDiagnostic: A diagnostic for a LEVC fault.

MappedDiagnostic: Represents a "virtual diagnostic" which is configurable per device as a DiagnosticMapping and must be resolved along with a Device to get the actual Diagnostic.

MultipleFaultStateProvider: Class to describe the current FaultState as a combination of faultstates.

NoController: An object representing NoController.

NoDiagnostic: A diagnostic for Geotab Devices that represents DBNull database value.

NoFailureMode: A FailureMode for diagnostics with no real world failure mode.

NoMappedDiagnostic: A mapped diagnostic that represents a DBNull value.

ObdFaultDiagnostic: A diagnostic for an OBD fault.

ObdSaFaultDiagnostic: A diagnostic for an OBD fault.

ParameterGroup: Standard Parameter Group Number (PGN). Where there is no parameter group it is represented by "ParameterGroupNoneId".

ParameterGroupNone: A parameter group to use where there is no parameter group.

ParameterGroupSearch: true search The object used to specify the arguments when searching for a ParameterGroup.

Pid: A J1708-specific Parameter Identifier.

Preset: Represents Diagnostics Columns Presets for the Asset Monitoring

PresetColumn: Represents Diagnostics-Columns relationship for Preset

ProprietaryFaultController: Object representing the specific, known ID reserved for faults generated with manufacturer specific codes.

ProprietaryFaultDiagnostic: A diagnostic for a manufacturer specific fault.

SensorData: The class that represents StatusData received from a sensor like bluetooth dongle.

Sid: false A J1708-specific Subsystem Identifier.

Source: The source is the underlying producer of the engine data.

SourceAiModel: Specifies that the data originated from the AI Model.

SourceAiModelObsolete: Specifies that the data originated from the AI Model.

SourceBrp: Specifies that the engine data originated from proprietary sources.

SourceBrpObsolete: Specifies that the engine data originated from Brp sources for an obsolete GUID.

SourceGmccc: Specifies that the engine data originated from proprietary sources.

SourceGmcccObsolete: Specifies that the engine data originated from Gmccc sources for an obsolete GUID.

SourceGo: Specifies that the engine data originated from a GO device.

SourceGoObsolete: Specifies that the engine data originated from a GO device for an obsolete GUID.

SourceJ1708: Specifies that the engine data originated from a J1708 engine computer.

SourceJ1708Obsolete: Specifies that the engine data originated from a J1708 engine computer for an obsolete GUID.

SourceJ1939: Specifies that the engine data originated from a J1939 engine computer.

SourceJ1939Obsolete: Specifies that the engine data originated from a J1939 engine computer for an obsolete GUID.

SourceLegacy: Specifies that the engine data originated from a legacy proprietary source.

SourceLegacyObsolete: Specifies that the engine data originated from a legacy proprietary source for an obsolete GUID.

SourceLevc: Specifies that the engine data originated from a LEVC source.

SourceLevcObsolete: Specifies that the engine data originated from a Levc proprietary source for an obsolete GUID.

SourceObd: Specifies that the engine data originated from an OBD II engine computer.

SourceObdObsolete: Specifies that the engine data originated from an OBD II engine computer for an obsolete GUID.

SourceObdSa: Specifies that the engine data originated from WWH enhanced type.

SourceObdSaObsolete: Specifies that the engine data originated from WWH enhanced type for an obsolete GUID.

SourceProprietary: Specifies that the engine data originated from proprietary sources.

SourceProprietaryObsolete: Specifies that the engine data originated from proprietary sources for an obsolete GUID.

SourceSearch: true search The object used to specify the arguments when searching for a Source.

SourceSystem: Specifies that the engine data originated from the MyGeotab system.

SourceSystemObsolete: Specifies that the engine data originated from the MyGeotab system from an obsolete GUID.

SourceThirdParty: Specifies that the engine data originated from a third-party device.

SourceThirdPartyObsolete: Specifies that the engine data originated from a third-party device for an obsolete GUID.

StatusData: A record that represents an engine status record from the engine system of the specific Device.

StatusDataEstimate: Represents an estimate StatusData based on previous/next StatusData and the Date.

StatusDataHelper: Provides helper functions for StatusData.

StatusDataSearch

The object used to specify the arguments when searching for StatusData.

When searching for status data including DeviceSearch and DiagnosticSearch the system will return all records that match the search criteria and interpolate the value at the provided from/to dates when there is no record that corresponds to the date. Interpolated records are dynamically created when the request is made and can be identified as not having the ID property populated. Records with an ID are stored in the database.

This search has been designed to work efficiently with these combinations of parameters:

SuspectParameter: false The reference object to SourceJ1939 StatusData and FaultData.

UnitOfMeasure: Describes the unit of measure (UOM) for engine data logs. In the case where no unit of measure is available; this is represented by "UnitOfMeasureNoneId".

UnitOfMeasureAmps: Represents the unit of measure for electric current.

UnitOfMeasureBytes: Represents the unit of measure for digital storage.

UnitOfMeasureCubicMeters: Represents the unit of measure for the volume of a solid.

UnitOfMeasureCubicMetersPerSecond: Represents the unit of measure for volumetric flow rate.

UnitOfMeasureDegreesCelsius: Represents the unit of measure for temperature.

UnitOfMeasureGrams: Represents the unit of measure for mass.

UnitOfMeasureGramsPerSecond: Represents the unit of measure for mass per second.

UnitOfMeasureHelper: Unit of Measure Helper.

UnitOfMeasureHertz: Represents the unit of measure an amount of cycles per second.

UnitOfMeasureKilometersPerHour: Represents the unit of measure for speed.

UnitOfMeasureKilometersPerKilogram: Represents the unit of measure for the ratio of distance to fuel consumption.

UnitOfMeasureLiters: Represents the unit of measure for the volume of a liquid.

UnitOfMeasureMeters: Represents the unit of measure for distance.

UnitOfMeasureMetersPerSecondSquared: Represents the unit of measure for acceleration.

UnitOfMeasureNewtonMeters: Represents the unit of measure for acceleration.

UnitOfMeasureNewtons: Represents the unit of measure for force.

UnitOfMeasureNone: The placeholder unit of measure for a diagnostic that does not have any specific unit.

UnitOfMeasureOhms: Represents the unit of measure for electrical resistance.

UnitOfMeasureOhmsPerSecond: Represents the unit of measure for electrical resistance per second.

UnitOfMeasurePartsPerMillion: Represents the unit of measure for dimensionless quantities.

UnitOfMeasurePascals: Represents the unit of measure for pressure.

UnitOfMeasurePercentage: Represents the unit of measure for a percentage.

UnitOfMeasurePulsesPerMeter: Represents the unit of measure an amount of digital pulses per meter.

UnitOfMeasureRadians: Represents the unit of measure for an angle.

UnitOfMeasureRevolutions: Represents the unit of measure an amount of circulation rotations.

UnitOfMeasureRevolutionsPerMinute: Represents the unit of measure for RPM.

UnitOfMeasureSearch: The object used to specify the arguments when searching for a UnitOfMeasure.

UnitOfMeasureSeconds: Represents the unit of measure for an amount of time.

UnitOfMeasureSystem: Represents a system supported unit of measure which cannot be changed.

UnitOfMeasureVolts: Represents the unit of measure for electrical potential.

UnitOfMeasureWatts: Represents the unit of measure for electrical power.

Vin: Class that represents a vehicle identification number. Provides functionality to deal with compression and some validation.

Structs

Vin.Wmi: World Manufacturer Identifier

Interfaces

IDeviceStatusInfoDiagnostic: An interface that represents the latest data of a specific diagnostic saved in the specific DeviceStatusInfo.

IDiagnosticProvider: The interface that is used to retrieve Diagnostic value from an object that implements this interface.

IFaultStateProvider: Interface for providing FaultState.

Enums

DiagnosticType: Diagnostic source type of the diagnostic.

DtcClass: Represents a severity/class code from the engine system of the specific Device.

DtcSeverity: Represents a severity/class code from the engine system of the specific Device.

FaultLampState: Represents the lamp status of a J1939 fault, see FaultData.

FaultResetMode: Specify whether the fault resets automatically or manually.

FaultState: Represents a fault code state code from the engine system of the specific Device. This properties using this enum will be deprecated in the near future and replaced by a property of the FaultStatus type.

KnownUnitOfMeasure: A known unit of measure.

Table of Contents

Namespace Geotab.Checkmate.ObjectModel.Engine

Classes

Structs

Interfaces

Enums