Package net.solarnetwork.ocpp.domain

Enum Class ChargePointStatus

java.lang.Object
java.lang.Enum<ChargePointStatus>
net.solarnetwork.ocpp.domain.ChargePointStatus
All Implemented Interfaces:
Serializable, Comparable<ChargePointStatus>, Constable, net.solarnetwork.domain.CodedValue
public enum ChargePointStatus extends Enum<ChargePointStatus> implements net.solarnetwork.domain.CodedValue
Charge point status enumeration.
Version:
1.0
Author:
matt

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Available
    The connector is available for a new user.
    Charging
    When the contactor of a connector closes, allowing the vehicle to charge.
    Faulted
    When a Charge Point or connector has reported an error and is not available for energy delivery.
    Finishing
    When a Transaction has stopped at a connector, but the connector is not yet available for a new user, e.g.
    Occupied
    See Charging - removed in 1.6.
    Preparing
    When a connector becomes no longer available for a new user but there is no ongoing Transaction (yet).
    Reserved
    When a connector becomes reserved as a result of a ReserveNow command.
    SuspendedEV
    When the EV is connected to the EVSE and the EVSE is offering energy but the EV is not taking any energy.
    SuspendedEVSE
    When the EV is connected to the EVSE but the EVSE is not offering energy to the EV, e.g.
    Unavailable
    When a connector becomes unavailable as the result of a Change Availability command or an event upon which the Charge Point transitions to unavailable at its discretion.
    Unknown
    The connector status it not known.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ChargePointStatus
    forCode(int code)
    Get an enumeration value for a code value.
    int
    getCode()
    Get the code value.
    static ChargePointStatus
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ChargePointStatus[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • Unknown

      public static final ChargePointStatus Unknown
      The connector status it not known.

    • Available

      public static final ChargePointStatus Available
      The connector is available for a new user.

    • Occupied

      public static final ChargePointStatus Occupied
      See Charging - removed in 1.6.

    • Faulted

      public static final ChargePointStatus Faulted
      When a Charge Point or connector has reported an error and is not available for energy delivery.

    • Unavailable

      public static final ChargePointStatus Unavailable
      When a connector becomes unavailable as the result of a Change Availability command or an event upon which the Charge Point transitions to unavailable at its discretion.

    • Reserved

      public static final ChargePointStatus Reserved
      When a connector becomes reserved as a result of a ReserveNow command.

    • Preparing

      public static final ChargePointStatus Preparing
      When a connector becomes no longer available for a new user but there is no ongoing Transaction (yet). Typically a connector is in preparing state when a user presents a tag, inserts a cable or a vehicle occupies the parking bay.

    • Charging

      public static final ChargePointStatus Charging
      When the contactor of a connector closes, allowing the vehicle to charge.

    • SuspendedEV

      public static final ChargePointStatus SuspendedEV
      When the EV is connected to the EVSE and the EVSE is offering energy but the EV is not taking any energy.

    • SuspendedEVSE

      public static final ChargePointStatus SuspendedEVSE
      When the EV is connected to the EVSE but the EVSE is not offering energy to the EV, e.g. due to a smart charging restriction, local supply power constraints, or as the result of StartTransaction.conf indicating that charging is not allowed etc.

    • Finishing

      public static final ChargePointStatus Finishing
      When a Transaction has stopped at a connector, but the connector is not yet available for a new user, e.g. the cable has not been removed or the vehicle has not left the parking bay.

  • Method Details

    • values

      public static ChargePointStatus[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ChargePointStatus valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getCode

      public int getCode()
      Get the code value.
      Specified by:
      getCode in interface net.solarnetwork.domain.CodedValue
      Returns:
      the code value

    • forCode

      public static ChargePointStatus forCode(int code)
      Get an enumeration value for a code value.
      Parameters:
      code - the code
      Returns:
      the status, never null and set to Unknown if not any other valid code