Package 

Interface Diagnostics

  • 
public interface Diagnostics

    Diagnostic interface for Diagnostic Trouble Codes, Address parameters and Data Identifiers.

    • Method Summary

      Modifier and Type Method Description
      abstract ByteOrder getByteOrder() Representation of the underlying byte order/endianess of the raw diagnostic data.
      abstract Array<byte> readAddressParameter(@NonNull() String doid) Get raw data for specified parameter address parameter (DST2 parameter).
      abstract boolean writeAddressParameter(@NonNull() String doid, @NonNull() Array<byte> value) Write raw value to specified address parameter (DST2 parameter).
      boolean saveDataToFlash() Possibility to request saving data to flash after writing DST2 parameters.
      abstract boolean requestReset() Possibility to request reset of the processor storing the DST2 parameters.
      abstract boolean writeDid(@NonNull() String doid, @NonNull() Array<byte> value) Update the raw value of the specified DID parameter.
      abstract boolean setDtc(@NonNull() String identifier) Set Diagnostic Trouble Code
      abstract boolean resetDtc(@NonNull() String identifier) Disables the Diagnostic Trouble Code
      abstract EcuIdData getEcuIdData() Volvo HW- and SW identifiers for this ECUHW Part number, Hw revision, Serial number, MSW, DST2, GSL and CSWs.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getByteOrder

        @NonNull() abstract ByteOrder getByteOrder()

        Representation of the underlying byte order/endianess of the raw diagnostic data.

        For example when reading a raw address parameter the byte order is of importance when doingconversion to engineering value.

      • readAddressParameter

        @NonNull() abstract Array<byte> readAddressParameter(@NonNull() String doid)

        Get raw data for specified parameter address parameter (DST2 parameter).

        Parameters:
        doid - DST DOID parameter name, ex P1QDT

      • writeAddressParameter

         abstract boolean writeAddressParameter(@NonNull() String doid, @NonNull() Array<byte> value)

        Write raw value to specified address parameter (DST2 parameter).

        Parameters:
        doid - the DOID name of the parameter
        value - the value to be written

      • saveDataToFlash

         boolean saveDataToFlash()

        Possibility to request saving data to flash after writing DST2 parameters.

        NOTE! Only applicable for ZB and Copilot2, no-op for other devices.

      • requestReset

         abstract boolean requestReset()

        Possibility to request reset of the processor storing the DST2 parameters.

        Use case: Reset after writing parameters with writeAddressParameter (String, byte[])}.Should be used with care as this reboots the complete device.

      • writeDid

         abstract boolean writeDid(@NonNull() String doid, @NonNull() Array<byte> value)

        Update the raw value of the specified DID parameter.

        Parameters:
        doid - the DOID name of the DID parameter
        value - the value to be written

      • setDtc

         abstract boolean setDtc(@NonNull() String identifier)

        Set Diagnostic Trouble Code

        Parameters:
        identifier - The ISO-15031-6 identifier, example: U100188

      • resetDtc

         abstract boolean resetDtc(@NonNull() String identifier)

        Disables the Diagnostic Trouble Code

        Parameters:
        identifier - The ISO-15031-6 identifier, example: U100188

      • getEcuIdData

        @NonNull() abstract EcuIdData getEcuIdData()

        Volvo HW- and SW identifiers for this ECU

        HW Part number, Hw revision, Serial number, MSW, DST2, GSL and CSWs.