Skip to content

OCPP Enumerations Reference

Auto-generated reference for OCPP 2.1 enumeration types.

110 enumeration types

APNAuthenticationEnumType

Authentication method.

ValueDescription
PAP
CHAP
NONE
AUTO

AttributeEnumType

Attribute type for which value is requested. When absent, default Actual is assumed.

ValueDescription
Actual
Target
MinSet
MaxSet

AuthorizationStatusEnumType

Current status of the ID Token.

ValueDescription
Accepted
Blocked
ConcurrentTx
Expired
Invalid
NoCredit
NotAllowedTypeEVSE
NotAtThisLocation
NotAtThisTime
Unknown

AuthorizeCertificateStatusEnumType

Certificate status information.

  • if all certificates are valid: return 'Accepted'.
  • if one of the certificates was revoked, return 'CertificateRevoked'.
ValueDescription
Accepted
SignatureError
CertificateExpired
CertificateRevoked
NoCertificateAvailable
CertChainError
ContractCancelled

BatterySwapEventEnumType

Battery in/out

ValueDescription
BatteryIn
BatteryOut
BatteryOutTimeout

BootReasonEnumType

This contains the reason for sending this message to the CSMS.

ValueDescription
ApplicationReset
FirmwareUpdate
LocalReset
PowerUp
RemoteReset
ScheduledReset
Triggered
Unknown
Watchdog

CancelReservationStatusEnumType

This indicates the success or failure of the canceling of a reservation by CSMS.

ValueDescription
Accepted
Rejected

CertificateActionEnumType

Defines whether certificate needs to be installed or updated.

ValueDescription
Install
Update

CertificateSignedStatusEnumType

Returns whether certificate signing has been accepted, otherwise rejected.

ValueDescription
Accepted
Rejected

CertificateSigningUseEnumType

Indicates the type of the signed certificate that is returned. When omitted the certificate is used for both the 15118 connection (if implemented) and the Charging Station to CSMS connection. This field is required when a typeOfCertificate was included in the <<signcertificaterequest,SignCertificateRequest>> that requested this certificate to be signed AND both the 15118 connection and the Charging Station connection are implemented.

ValueDescription
ChargingStationCertificate
V2GCertificate
V2G20Certificate

CertificateStatusEnumType

Status of certificate: good, revoked or unknown.

ValueDescription
Good
Revoked
Unknown
Failed

CertificateStatusSourceEnumType

Source of status: OCSP, CRL

ValueDescription
CRL
OCSP

ChangeAvailabilityStatusEnumType

This indicates whether the Charging Station is able to perform the availability change.

ValueDescription
Accepted
Rejected
Scheduled

ChargingProfileKindEnumType

Indicates the kind of schedule.

ValueDescription
Absolute
Recurring
Relative
Dynamic

ChargingProfilePurposeEnumType

Specifies to purpose of the charging profiles that will be cleared, if they meet the other criteria in the request.

ValueDescription
ChargingStationExternalConstraints
ChargingStationMaxProfile
TxDefaultProfile
TxProfile
PriorityCharging
LocalGeneration

ChargingProfileStatusEnumType

Result of request.

ValueDescription
Accepted
Rejected

ChargingRateUnitEnumType

Can be used to force a power or current profile.

ValueDescription
W
A

ChargingStateEnumType

Current charging state, is required when state has changed. Omitted when there is no communication between EVSE and EV, because no cable is plugged in.

ValueDescription
EVConnected
Charging
SuspendedEV
SuspendedEVSE
Idle

ClearCacheStatusEnumType

Accepted if the Charging Station has executed the request, otherwise rejected.

ValueDescription
Accepted
Rejected

ClearChargingProfileStatusEnumType

Indicates if the Charging Station was able to execute the request.

ValueDescription
Accepted
Unknown

ClearMessageStatusEnumType

Returns whether the Charging Station has been able to remove the message.

ValueDescription
Accepted
Unknown
Rejected

ClearMonitoringStatusEnumType

Result of the clear request for this monitor, identified by its Id.

ValueDescription
Accepted
Rejected
NotFound

ComponentCriterionEnumType

OCPP ComponentCriterionEnumType enumeration

ValueDescription
Active
Available
Enabled
Problem

ConnectorStatusEnumType

This contains the current status of the Connector.

ValueDescription
Available
Occupied
Reserved
Unavailable
Faulted

ControlModeEnumType

(2.1) Indicates whether EV wants to operate in Dynamic or Scheduled mode. When absent, Scheduled mode is assumed for backwards compatibility. + ISO 15118-20: + ServiceSelectionReq(SelectedEnergyTransferService)

ValueDescription
ScheduledControl
DynamicControl

CostDimensionEnumType

Type of cost dimension: energy, power, time, etc.

ValueDescription
Energy
MaxCurrent
MinCurrent
MaxPower
MinPower
IdleTIme
ChargingTime

CostKindEnumType

The kind of cost referred to in the message element amount

ValueDescription
CarbonDioxideEmission
RelativePricePercentage
RenewableGenerationPercentage

CustomerInformationStatusEnumType

Indicates whether the request was accepted.

ValueDescription
Accepted
Rejected
Invalid

DataEnumType

Data type of this variable.

ValueDescription
string
decimal
integer
dateTime
boolean
OptionList
SequenceList
MemberList

DataTransferStatusEnumType

This indicates the success or failure of the data transfer.

ValueDescription
Accepted
Rejected
UnknownMessageId
UnknownVendorId

DayOfWeekEnumType

OCPP DayOfWeekEnumType enumeration

ValueDescription
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

DeleteCertificateStatusEnumType

Charging Station indicates if it can process the request.

ValueDescription
Accepted
Failed
NotFound

DERControlEnumType

Name of control settings to clear. Not used when controlId is provided.

ValueDescription
EnterService
FreqDroop
FreqWatt
FixedPFAbsorb
FixedPFInject
FixedVar
Gradients
HFMustTrip
HFMayTrip
HVMustTrip
HVMomCess
HVMayTrip
LimitMaxDischarge
LFMustTrip
LVMustTrip
LVMomCess
LVMayTrip
PowerMonitoringMustTrip
VoltVar
VoltWatt
WattPF
WattVar

DERControlStatusEnumType

Result of operation.

ValueDescription
Accepted
Rejected
NotSupported
NotFound

DERUnitEnumType

Unit of the Y-axis of DER curve

ValueDescription
Not_Applicable
PctMaxW
PctMaxVar
PctWAvail
PctVarAvail
PctEffectiveV

DisplayMessageStatusEnumType

This indicates whether the Charging Station is able to display the message.

ValueDescription
Accepted
NotSupportedMessageFormat
Rejected
NotSupportedPriority
NotSupportedState
UnknownTransaction
LanguageNotSupported

EnergyTransferModeEnumType

OCPP EnergyTransferModeEnumType enumeration

ValueDescription
AC_single_phase
AC_two_phase
AC_three_phase
DC
AC_BPT
AC_BPT_DER
AC_DER
DC_BPT
DC_ACDP
DC_ACDP_BPT
WPT

EventNotificationEnumType

Specifies the event notification type of the message.

ValueDescription
HardWiredNotification
HardWiredMonitor
PreconfiguredMonitor
CustomMonitor

EventTriggerEnumType

Type of trigger for this event, e.g. exceeding a threshold value.

ValueDescription
Alerting
Delta
Periodic

EvseKindEnumType

Type of EVSE (AC, DC) this tariff applies to.

ValueDescription
AC
DC

FirmwareStatusEnumType

This contains the progress status of the firmware installation.

ValueDescription
Downloaded
DownloadFailed
Downloading
DownloadScheduled
DownloadPaused
Idle
InstallationFailed
Installing
Installed
InstallRebooting
InstallScheduled
InstallVerificationFailed
InvalidSignature
SignatureVerified

GenericDeviceModelStatusEnumType

This indicates whether the Charging Station is able to accept this request.

ValueDescription
Accepted
Rejected
NotSupported
EmptyResultSet

GenericStatusEnumType

Status of operation.

ValueDescription
Accepted
Rejected

GetCertificateIdUseEnumType

OCPP GetCertificateIdUseEnumType enumeration

ValueDescription
V2GRootCertificate
MORootCertificate
CSMSRootCertificate
V2GCertificateChain
ManufacturerRootCertificate
OEMRootCertificate

GetCertificateStatusEnumType

This indicates whether the charging station was able to retrieve the OCSP certificate status.

ValueDescription
Accepted
Failed

GetChargingProfileStatusEnumType

This indicates whether the Charging Station is able to process this request and will send <<reportchargingprofilesrequest, ReportChargingProfilesRequest>> messages.

ValueDescription
Accepted
NoProfiles

GetDisplayMessagesStatusEnumType

Indicates if the Charging Station has Display Messages that match the request criteria in the <<getdisplaymessagesrequest,GetDisplayMessagesRequest>>

ValueDescription
Accepted
Unknown

GetInstalledCertificateStatusEnumType

Charging Station indicates if it can process the request.

ValueDescription
Accepted
NotFound

GetVariableStatusEnumType

OCPP GetVariableStatusEnumType enumeration

ValueDescription
Accepted
Rejected
UnknownComponent
UnknownVariable
NotSupportedAttributeType

GridEventFaultEnumType

Type of grid event that caused this

ValueDescription
CurrentImbalance
LocalEmergency
LowInputPower
OverCurrent
OverFrequency
OverVoltage
PhaseRotation
RemoteEmergency
UnderFrequency
UnderVoltage
VoltageImbalance

HashAlgorithmEnumType

Used algorithms for the hashes provided.

ValueDescription
SHA256
SHA384
SHA512

InstallCertificateStatusEnumType

Charging Station indicates if installation was successful.

ValueDescription
Accepted
Rejected
Failed

InstallCertificateUseEnumType

Indicates the certificate type that is sent.

ValueDescription
V2GRootCertificate
MORootCertificate
ManufacturerRootCertificate
CSMSRootCertificate
OEMRootCertificate

IslandingDetectionEnumType

OCPP IslandingDetectionEnumType enumeration

ValueDescription
NoAntiIslandingSupport
RoCoF
UVP_OVP
UFP_OFP
VoltageVectorShift
ZeroCrossingDetection
OtherPassive
ImpedanceMeasurement
ImpedanceAtFrequency
SlipModeFrequencyShift
SandiaFrequencyShift
SandiaVoltageShift
FrequencyJump
RCLQFactor
OtherActive

Iso15118EVCertificateStatusEnumType

Indicates whether the message was processed properly.

ValueDescription
Accepted
Failed

LocationEnumType

Indicates where the measured value has been sampled. Default = "Outlet"

ValueDescription
Body
Cable
EV
Inlet
Outlet
Upstream

LogEnumType

This contains the type of log file that the Charging Station should send.

ValueDescription
DiagnosticsLog
SecurityLog
DataCollectorLog

LogStatusEnumType

This field indicates whether the Charging Station was able to accept the request.

ValueDescription
Accepted
Rejected
AcceptedCanceled

MeasurandEnumType

Type of measurement. Default = "Energy.Active.Import.Register"

ValueDescription
Current.Export
Current.Export.Offered
Current.Export.Minimum
Current.Import
Current.Import.Offered
Current.Import.Minimum
Current.Offered
Display.PresentSOC
Display.MinimumSOC
Display.TargetSOC
Display.MaximumSOC
Display.RemainingTimeToMinimumSOC
Display.RemainingTimeToTargetSOC
Display.RemainingTimeToMaximumSOC
Display.ChargingComplete
Display.BatteryEnergyCapacity
Display.InletHot
Energy.Active.Export.Interval
Energy.Active.Export.Register
Energy.Active.Import.Interval
Energy.Active.Import.Register
Energy.Active.Import.CableLoss
Energy.Active.Import.LocalGeneration.Register
Energy.Active.Net
Energy.Active.Setpoint.Interval
Energy.Apparent.Export
Energy.Apparent.Import
Energy.Apparent.Net
Energy.Reactive.Export.Interval
Energy.Reactive.Export.Register
Energy.Reactive.Import.Interval
Energy.Reactive.Import.Register
Energy.Reactive.Net
EnergyRequest.Target
EnergyRequest.Minimum
EnergyRequest.Maximum
EnergyRequest.Minimum.V2X
EnergyRequest.Maximum.V2X
EnergyRequest.Bulk
Frequency
Power.Active.Export
Power.Active.Import
Power.Active.Setpoint
Power.Active.Residual
Power.Export.Minimum
Power.Export.Offered
Power.Factor
Power.Import.Offered
Power.Import.Minimum
Power.Offered
Power.Reactive.Export
Power.Reactive.Import
SoC
Voltage
Voltage.Minimum
Voltage.Maximum

MessageFormatEnumType

Format of the message.

ValueDescription
ASCII
HTML
URI
UTF8
QRCODE

MessagePriorityEnumType

If provided the Charging Station shall return Display Messages with the given priority only.

ValueDescription
AlwaysFront
InFront
NormalCycle

MessageStateEnumType

If provided the Charging Station shall return Display Messages with the given state only.

ValueDescription
Charging
Faulted
Idle
Unavailable
Suspended
Discharging

MessageTriggerEnumType

Type of message to be triggered.

ValueDescription
BootNotification
LogStatusNotification
FirmwareStatusNotification
Heartbeat
MeterValues
SignChargingStationCertificate
SignV2GCertificate
SignV2G20Certificate
StatusNotification
TransactionEvent
SignCombinedCertificate
PublishFirmwareStatusNotification
CustomTrigger

MobilityNeedsModeEnumType

(2.1) Value of EVCC indicates that EV determines min/target SOC and departure time. + A value of EVCC_SECC indicates that charging station or CSMS may also update min/target SOC and departure time. + ISO 15118-20: + ServiceSelectionReq(SelectedEnergyTransferService)

ValueDescription
EVCC
EVCC_SECC

MonitorEnumType

The type of this monitor, e.g. a threshold, delta or periodic monitor.

ValueDescription
UpperThreshold
LowerThreshold
Delta
Periodic
PeriodicClockAligned
TargetDelta
TargetDeltaRelative

MonitoringBaseEnumType

Specify which monitoring base will be set

ValueDescription
All
FactoryDefault
HardWiredOnly

MonitoringCriterionEnumType

OCPP MonitoringCriterionEnumType enumeration

ValueDescription
ThresholdMonitoring
DeltaMonitoring
PeriodicMonitoring

MutabilityEnumType

Defines the mutability of this attribute. Default is ReadWrite when omitted.

ValueDescription
ReadOnly
WriteOnly
ReadWrite

NotifyAllowedEnergyTransferStatusEnumType

OCPP NotifyAllowedEnergyTransferStatusEnumType enumeration

ValueDescription
Accepted
Rejected

NotifyEVChargingNeedsStatusEnumType

Returns whether the CSMS has been able to process the message successfully. It does not imply that the evChargingNeeds can be met with the current charging profile.

ValueDescription
Accepted
Rejected
Processing
NoChargingProfile

OCPPInterfaceEnumType

Applicable Network Interface. Charging Station is allowed to use a different network interface to connect if the given one does not work.

ValueDescription
Wired0
Wired1
Wired2
Wired3
Wireless0
Wireless1
Wireless2
Wireless3
Any

OCPPTransportEnumType

Defines the transport protocol (e.g. SOAP or JSON). Note: SOAP is not supported in OCPP 2.x, but is supported by earlier versions of OCPP.

ValueDescription
SOAP
JSON

OCPPVersionEnumType

(2.1) This field is ignored, since the OCPP version to use is determined during the websocket handshake. The field is only kept for backwards compatibility with the OCPP 2.0.1 JSON schema.

ValueDescription
OCPP12
OCPP15
OCPP16
OCPP20
OCPP201
OCPP21

OperationalStatusEnumType

This contains the type of availability change that the Charging Station should perform.

ValueDescription
Inoperative
Operative

OperationModeEnumType

(2.1) Charging operation mode to use during this time interval. When absent defaults to ChargingOnly.

ValueDescription
Idle
ChargingOnly
CentralSetpoint
ExternalSetpoint
ExternalLimits
CentralFrequency
LocalFrequency
LocalLoadBalancing

PaymentStatusEnumType

The status of the settlement attempt.

ValueDescription
Settled
Canceled
Rejected
Failed

PhaseEnumType

Indicates how the measured value is to be interpreted. For instance between L1 and neutral (L1-N) Please note that not all values of phase are applicable to all Measurands. When phase is absent, the measured value is interpreted as an overall value.

ValueDescription
L1
L2
L3
N
L1-N
L2-N
L3-N
L1-L2
L2-L3
L3-L1

PowerDuringCessationEnumType

Parameter is only sent, if the EV has to feed-in power or reactive power during fault-ride through (FRT) as defined by HVMomCess curve and LVMomCess curve.

ValueDescription
Active
Reactive

PreconditioningStatusEnumType

(2.1) The current preconditioning status of the BMS in the EV. Default value is Unknown.

ValueDescription
Unknown
Ready
NotReady
Preconditioning

PriorityChargingStatusEnumType

Result of the request.

ValueDescription
Accepted
Rejected
NoProfile

PublishFirmwareStatusEnumType

This contains the progress status of the publishfirmware installation.

ValueDescription
Idle
DownloadScheduled
Downloading
Downloaded
Published
DownloadFailed
DownloadPaused
InvalidChecksum
ChecksumVerified
PublishFailed

ReadingContextEnumType

Type of detail value: start, end or sample. Default = "Sample.Periodic"

ValueDescription
Interruption.Begin
Interruption.End
Other
Sample.Clock
Sample.Periodic
Transaction.Begin
Transaction.End
Trigger

ReasonEnumType

The stoppedReason is the reason/event that initiated the process of stopping the transaction. It will normally be the user stopping authorization via card (Local or MasterPass) or app (Remote), but it can also be CSMS revoking authorization (DeAuthorized), or disconnecting the EV when TxStopPoint = EVConnected (EVDisconnected). Most other reasons are related to technical faults or energy limitations. + MAY only be omitted when stoppedReason is "Local"

ValueDescription
DeAuthorized
EmergencyStop
EnergyLimitReached
EVDisconnected
GroundFault
ImmediateReset
MasterPass
Local
LocalOutOfCredit
Other
OvercurrentFault
PowerLoss
PowerQuality
Reboot
Remote
SOCLimitReached
StoppedByEV
TimeLimitReached
Timeout
ReqEnergyTransferRejected

RecurrencyKindEnumType

Indicates the start point of a recurrence.

ValueDescription
Daily
Weekly

RegistrationStatusEnumType

This contains whether the Charging Station has been registered within the CSMS.

ValueDescription
Accepted
Pending
Rejected

ReportBaseEnumType

This field specifies the report base.

ValueDescription
ConfigurationInventory
FullInventory
SummaryInventory

RequestStartStopStatusEnumType

Status indicating whether the Charging Station accepts the request to start a transaction.

ValueDescription
Accepted
Rejected

ReservationUpdateStatusEnumType

The updated reservation status.

ValueDescription
Expired
Removed
NoTransaction

ReserveNowStatusEnumType

This indicates the success or failure of the reservation.

ValueDescription
Accepted
Faulted
Occupied
Rejected
Unavailable

ResetEnumType

This contains the type of reset that the Charging Station or EVSE should perform.

ValueDescription
Immediate
OnIdle
ImmediateAndResume

ResetStatusEnumType

This indicates whether the Charging Station is able to perform the reset.

ValueDescription
Accepted
Rejected
Scheduled

SendLocalListStatusEnumType

This indicates whether the Charging Station has successfully received and applied the update of the Local Authorization List.

ValueDescription
Accepted
Failed
VersionMismatch

SetMonitoringStatusEnumType

Status is OK if a value could be returned. Otherwise this will indicate the reason why a value could not be returned.

ValueDescription
Accepted
UnknownComponent
UnknownVariable
UnsupportedMonitorType
Rejected
Duplicate

SetNetworkProfileStatusEnumType

Result of operation.

ValueDescription
Accepted
Rejected
Failed

SetVariableStatusEnumType

Result status of setting the variable.

ValueDescription
Accepted
Rejected
UnknownComponent
UnknownVariable
NotSupportedAttributeType
RebootRequired

TariffChangeStatusEnumType

Status of the operation

ValueDescription
Accepted
Rejected
TooManyElements
ConditionNotSupported
TxNotFound
NoCurrencyChange

TariffClearStatusEnumType

OCPP TariffClearStatusEnumType enumeration

ValueDescription
Accepted
Rejected
NoTariff

TariffCostEnumType

Type of cost: normal or the minimum or maximum cost.

ValueDescription
NormalCost
MinCost
MaxCost

TariffGetStatusEnumType

Status of operation

ValueDescription
Accepted
Rejected
NoTariff

TariffKindEnumType

Kind of tariff (driver/default)

ValueDescription
DefaultTariff
DriverTariff

TariffSetStatusEnumType

OCPP TariffSetStatusEnumType enumeration

ValueDescription
Accepted
Rejected
TooManyElements
ConditionNotSupported
DuplicateTariffId

TransactionEventEnumType

This contains the type of this event. The first TransactionEvent of a transaction SHALL contain: "Started" The last TransactionEvent of a transaction SHALL contain: "Ended" All others SHALL contain: "Updated"

ValueDescription
Ended
Started
Updated

TriggerMessageStatusEnumType

Indicates whether the Charging Station will send the requested notification or not.

ValueDescription
Accepted
Rejected
NotImplemented

TriggerReasonEnumType

Reason the Charging Station sends this message to the CSMS

ValueDescription
AbnormalCondition
Authorized
CablePluggedIn
ChargingRateChanged
ChargingStateChanged
CostLimitReached
Deauthorized
EnergyLimitReached
EVCommunicationLost
EVConnectTimeout
EVDeparted
EVDetected
LimitSet
MeterValueClock
MeterValuePeriodic
OperationModeChanged
RemoteStart
RemoteStop
ResetCommand
RunningCost
SignedDataReceived
SoCLimitReached
StopAuthorized
TariffChanged
TariffNotAccepted
TimeLimitReached
Trigger
TxResumed
UnlockCommand

UnlockStatusEnumType

This indicates whether the Charging Station has unlocked the connector.

ValueDescription
Unlocked
UnlockFailed
OngoingAuthorizedTransaction
UnknownConnector

UnpublishFirmwareStatusEnumType

Indicates whether the Local Controller succeeded in unpublishing the firmware.

ValueDescription
DownloadOngoing
NoFirmware
Unpublished

UpdateEnumType

This contains the type of update (full or differential) of this request.

ValueDescription
Differential
Full

UpdateFirmwareStatusEnumType

This field indicates whether the Charging Station was able to accept the request.

ValueDescription
Accepted
Rejected
AcceptedCanceled
InvalidCertificate
RevokedCertificate

UploadLogStatusEnumType

This contains the status of the log upload.

ValueDescription
BadMessage
Idle
NotSupportedOperation
PermissionDenied
Uploaded
UploadFailure
Uploading
AcceptedCanceled

VPNEnumType

Type of VPN

ValueDescription
IKEv2
IPSec
L2TP
PPTP