Expand description
OCPP 2.1 enumerations.
Enums§
- APNAuthentication
Enum - Authentication method.
- Attribute
Enum - Attribute type for which value is requested. When absent, default Actual is assumed.
- Authorization
Status Enum - Current status of the ID Token.
- Authorize
Certificate Status Enum - Certificate status information.
- Battery
Swap Event Enum - Battery in/out
- Boot
Reason Enum - This contains the reason for sending this message to the CSMS.
- Cancel
Reservation Status Enum - This indicates the success or failure of the canceling of a reservation by CSMS.
- Certificate
Action Enum - Defines whether certificate needs to be installed or updated.
- Certificate
Signed Status Enum - Returns whether certificate signing has been accepted, otherwise rejected.
- Certificate
Signing UseEnum - 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.
- Certificate
Status Enum - Status of certificate: good, revoked or unknown.
- Certificate
Status Source Enum - Source of status: OCSP, CRL
- Change
Availability Status Enum - This indicates whether the Charging Station is able to perform the availability change.
- Charging
Profile Kind Enum - Indicates the kind of schedule.
- Charging
Profile Purpose Enum - Specifies to purpose of the charging profiles that will be cleared, if they meet the other criteria in the request.
- Charging
Profile Status Enum - Result of request.
- Charging
Rate Unit Enum - Can be used to force a power or current profile.
- Charging
State Enum - 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.
- Clear
Cache Status Enum - Accepted if the Charging Station has executed the request, otherwise rejected.
- Clear
Charging Profile Status Enum - Indicates if the Charging Station was able to execute the request.
- Clear
Message Status Enum - Returns whether the Charging Station has been able to remove the message.
- Clear
Monitoring Status Enum - Result of the clear request for this monitor, identified by its Id.
- Component
Criterion Enum - Connector
Status Enum - This contains the current status of the Connector.
- Control
Mode Enum - (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)
- Cost
Dimension Enum - Type of cost dimension: energy, power, time, etc.
- Cost
Kind Enum - The kind of cost referred to in the message element amount
- Customer
Information Status Enum - Indicates whether the request was accepted.
- DERControl
Enum - Name of control settings to clear. Not used when controlId is provided.
- DERControl
Status Enum - Result of operation.
- DERUnit
Enum - Unit of the Y-axis of DER curve
- Data
Enum - Data type of this variable.
- Data
Transfer Status Enum - This indicates the success or failure of the data transfer.
- DayOf
Week Enum - Delete
Certificate Status Enum - Charging Station indicates if it can process the request.
- Display
Message Status Enum - This indicates whether the Charging Station is able to display the message.
- Energy
Transfer Mode Enum - Event
Notification Enum - Specifies the event notification type of the message.
- Event
Trigger Enum - Type of trigger for this event, e.g. exceeding a threshold value.
- Evse
Kind Enum - Type of EVSE (AC, DC) this tariff applies to.
- Firmware
Status Enum - This contains the progress status of the firmware installation.
- Generic
Device Model Status Enum - This indicates whether the Charging Station is able to accept this request.
- Generic
Status Enum - GetCertificate
IdUse Enum - GetCertificate
Status Enum - This indicates whether the charging station was able to retrieve the OCSP certificate status.
- GetCharging
Profile Status Enum - This indicates whether the Charging Station is able to process this request and will send <<reportchargingprofilesrequest, ReportChargingProfilesRequest>> messages.
- GetDisplay
Messages Status Enum - Indicates if the Charging Station has Display Messages that match the request criteria in the <<getdisplaymessagesrequest,GetDisplayMessagesRequest>>
- GetInstalled
Certificate Status Enum - Charging Station indicates if it can process the request.
- GetVariable
Status Enum - Grid
Event Fault Enum - Type of grid event that caused this
- Hash
Algorithm Enum - Used algorithms for the hashes provided.
- Install
Certificate Status Enum - Charging Station indicates if installation was successful.
- Install
Certificate UseEnum - Indicates the certificate type that is sent.
- Islanding
Detection Enum - Iso15118EV
Certificate Status Enum - Indicates whether the message was processed properly.
- Location
Enum - Indicates where the measured value has been sampled. Default = “Outlet”
- LogEnum
- This contains the type of log file that the Charging Station should send.
- LogStatus
Enum - This field indicates whether the Charging Station was able to accept the request.
- Measurand
Enum - Type of measurement. Default = “Energy.Active.Import.Register”
- Message
Format Enum - Format of the message.
- Message
Priority Enum - If provided the Charging Station shall return Display Messages with the given priority only.
- Message
State Enum - If provided the Charging Station shall return Display Messages with the given state only.
- Message
Trigger Enum - Type of message to be triggered.
- Mobility
Needs Mode Enum - (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)
- Monitor
Enum - The type of this monitor, e.g. a threshold, delta or periodic monitor.
- Monitoring
Base Enum - Specify which monitoring base will be set
- Monitoring
Criterion Enum - Mutability
Enum - Defines the mutability of this attribute. Default is ReadWrite when omitted.
- Notify
Allowed Energy Transfer Status Enum - NotifyEV
Charging Needs Status Enum - 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.
- OCPP
Interface Enum - Applicable Network Interface. Charging Station is allowed to use a different network interface to connect if the given one does not work.
- OCPP
Transport Enum - 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.
- OCPP
Version Enum - (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.
- Operation
Mode Enum - (2.1) Charging operation mode to use during this time interval. When absent defaults to
ChargingOnly. - Operational
Status Enum - This contains the type of availability change that the Charging Station should perform.
- Payment
Status Enum - The status of the settlement attempt.
- Phase
Enum - 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.
- Power
During Cessation Enum - 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.
- Preconditioning
Status Enum - (2.1) The current preconditioning status of the BMS in the EV. Default value is Unknown.
- Priority
Charging Status Enum - Result of the request.
- Publish
Firmware Status Enum - This contains the progress status of the publishfirmware installation.
- Reading
Context Enum - Type of detail value: start, end or sample. Default = “Sample.Periodic”
- Reason
Enum - 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”
- Recurrency
Kind Enum - Indicates the start point of a recurrence.
- Registration
Status Enum - This contains whether the Charging Station has been registered within the CSMS.
- Report
Base Enum - This field specifies the report base.
- Request
Start Stop Status Enum - Status indicating whether the Charging Station accepts the request to start a transaction.
- Reservation
Update Status Enum - The updated reservation status.
- Reserve
NowStatus Enum - This indicates the success or failure of the reservation.
- Reset
Enum - This contains the type of reset that the Charging Station or EVSE should perform.
- Reset
Status Enum - This indicates whether the Charging Station is able to perform the reset.
- Send
Local List Status Enum - This indicates whether the Charging Station has successfully received and applied the update of the Local Authorization List.
- SetMonitoring
Status Enum - Status is OK if a value could be returned. Otherwise this will indicate the reason why a value could not be returned.
- SetNetwork
Profile Status Enum - Result of operation.
- SetVariable
Status Enum - Result status of setting the variable.
- Tariff
Change Status Enum - Status of the operation
- Tariff
Clear Status Enum - Tariff
Cost Enum - Type of cost: normal or the minimum or maximum cost.
- Tariff
GetStatus Enum - Status of operation
- Tariff
Kind Enum - Kind of tariff (driver/default)
- Tariff
SetStatus Enum - Transaction
Event Enum - 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”
- Trigger
Message Status Enum - Indicates whether the Charging Station will send the requested notification or not.
- Trigger
Reason Enum - Reason the Charging Station sends this message to the CSMS
- Unlock
Status Enum - This indicates whether the Charging Station has unlocked the connector.
- Unpublish
Firmware Status Enum - Indicates whether the Local Controller succeeded in unpublishing the firmware.
- Update
Enum - This contains the type of update (full or differential) of this request.
- Update
Firmware Status Enum - This field indicates whether the Charging Station was able to accept the request.
- Upload
LogStatus Enum - This contains the status of the log upload.
- VPNEnum
- Type of VPN