com.github.pires.obd.enums.ObdProtocols Maven / Gradle / Ivy

Go to download
/**
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.github.pires.obd.enums;

/**
 * All OBD protocols.
 */
public enum ObdProtocols {

  /**
   * Auto select protocol and save.
   */
  AUTO('0'),

  /**
   * 41.6 kbaud
   */
  SAE_J1850_PWM('1'),

  /**
   * 10.4 kbaud
   */
  SAE_J1850_VPW('2'),

  /**
   * 5 baud init
   */
  ISO_9141_2('3'),

  /**
   * 5 baud init
   */
  ISO_14230_4_KWP('4'),

  /**
   * Fast init
   */
  ISO_14230_4_KWP_FAST('5'),

  /**
   * 11 bit ID, 500 kbaud
   */
  ISO_15765_4_CAN('6'),

  /**
   * 29 bit ID, 500 kbaud
   */
  ISO_15765_4_CAN_B('7'),

  /**
   * 11 bit ID, 250 kbaud
   */
  ISO_15765_4_CAN_C('8'),

  /**
   * 29 bit ID, 250 kbaud
   */
  ISO_15765_4_CAN_D('9'),

  /**
   * 29 bit ID, 250 kbaud (user adjustable)
   */
  SAE_J1939_CAN('A'),

  /**
   * 11 bit ID (user adjustable), 125 kbaud (user adjustable)
   */
  USER1_CAN('B'),

  /**
   * 11 bit ID (user adjustable), 50 kbaud (user adjustable)
   */
  USER2_CAN('C');

  private final char value;

  ObdProtocols(char value) {
    this.value = value;
  }

  /**
   * Getter for the field value.
   *
   * @return a char.
   */
  public char getValue() {
    return value;
  }
}