com.github.pires.obd.commands.control.DtcNumberCommand Maven / Gradle / Ivy
Show all versions of obd-java-api Show documentation
package com.github.pires.obd.commands.control;
import com.github.pires.obd.commands.ObdCommand;
import com.github.pires.obd.enums.AvailableCommandNames;
/**
* This command will for now read MIL (check engine light) state and number of
* diagnostic trouble codes currently flagged in the ECU.
*
* Perhaps in the future we'll extend this to read the 3rd, 4th and 5th bytes of
* the response in order to store information about the availability and
* completeness of certain on-board tests.
*
* @author pires
* @version $Id: $Id
*/
public class DtcNumberCommand extends ObdCommand {
private int codeCount = 0;
private boolean milOn = false;
/**
* Default ctor.
*/
public DtcNumberCommand() {
super("01 01");
}
/**
* Copy ctor.
*
* @param other a {@link com.github.pires.obd.commands.control.DtcNumberCommand} object.
*/
public DtcNumberCommand(DtcNumberCommand other) {
super(other);
}
/** {@inheritDoc} */
@Override
protected void performCalculations() {
// ignore first two bytes [hh hh] of the response
final int mil = buffer.get(2);
milOn = (mil & 0x80) == 128;
codeCount = mil & 0x7F;
}
/**
*
getFormattedResult.
*
* @return a {@link java.lang.String} object.
*/
public String getFormattedResult() {
final String res = milOn ? "MIL is ON" : "MIL is OFF";
return res + codeCount + " codes";
}
/** {@inheritDoc} */
@Override
public String getCalculatedResult() {
return String.valueOf(codeCount);
}
/**
* getTotalAvailableCodes.
*
* @return the number of trouble codes currently flaggd in the ECU.
*/
public int getTotalAvailableCodes() {
return codeCount;
}
/**
* Getter for the field milOn.
*
* @return the state of the check engine light state.
*/
public boolean getMilOn() {
return milOn;
}
/** {@inheritDoc} */
@Override
public String getName() {
return AvailableCommandNames.DTC_NUMBER.getValue();
}
}