pub enum VariableName {
Show 261 variants
ACCurrent,
ACPhaseSwitchingSupported,
ACVoltage,
Active,
ActiveMonitoringBase,
ActiveMonitoringLevel,
ActiveNetworkProfile,
ActiveTransactionId,
AdditionalInfoItemsPerMessage,
AdditionalRootCertificateCheck,
AllowEnergyTransferResumption,
AllowNewSessionsPendingFirmwareUpdate,
AllowReset,
AllowSecurityProfileDowngrade,
Angle,
Attempts,
AuthorizeRemoteStart,
AvailabilityState,
Available,
BasicAuthPassword,
BytesPerMessage,
CentralContractValidationAllowed,
CertSigningRepeatTimes,
CertSigningWaitMinimum,
Certificate,
CertificateEntries,
CertificateStatusSource,
ChargeProtocol,
ChargingCompleteBulk,
ChargingCompleteFull,
ChargingProfilePersistence,
ChargingState,
ChargingTime,
Color,
CommunicationParent,
Complete,
ConditionsSupported,
ConfigurationValueSize,
ConnectedTime,
ConnectorType,
ContractCertificateInstallationEnabled,
ContractValidationOffline,
Count,
CountryName,
Currency,
CurrentImbalance,
CustomImplementationEnabled,
CustomTriggers,
DCCurrent,
DCInputPhaseControl,
DCVoltage,
DataText,
DateTime,
DepartureTime,
DisablePostAuthorize,
DisableRemoteAuthorization,
DisplayMessages,
ECVariant,
EVConnectionTimeOut,
ElectricalParent,
Enabled,
Energy,
EnergyCapacity,
EnergyExport,
EnergyExportRegister,
EnergyImport,
EnergyImportRegister,
Entries,
ExternalConfigChangeDate,
ExternalConstraintsProfileDisallowed,
ExternalControlSignalsEnabled,
Fallback,
FanSpeed,
FieldLength,
FileTransferProtocols,
FirmwareVersion,
Force,
Formats,
Frequency,
FrequencySchedule,
FuseRating,
HeartbeatInterval,
Height,
Humidity,
Hysteresis,
ICCID,
IMSI,
ISO15118EvseId,
IdToken,
Identity,
Impedance,
Interval,
ItemsPerMessage,
Label,
Language,
Length,
LifeTime,
Light,
LimitChangeSignificance,
LocalAuthorizeOffline,
LocalLoadBalancing,
LocalPreAuthorize,
LogicalParent,
Manufacturer,
MasterPassGroupId,
MaxCertificateChainSize,
MaxEnergyOnInvalidId,
MaxExternalConstraintsId,
MaxPriceElements,
Measurands,
Message,
MessageAttemptInterval,
MessageAttempts,
MessageTimeout,
MinimumStatusDuration,
Mode,
Model,
NetworkAddress,
NetworkConfigurationPriority,
NetworkProfileConnectionAttempts,
NextTimeOffsetTransitionDateTime,
NonEvseSpecific,
NotificationMaxDelay,
NotifyChargingLimitWithSchedules,
NtpServerUri,
NtpSource,
OfflineQueuingSeverity,
OfflineTariffFallbackMessage,
OfflineThreshold,
OfflineTxForUnknownIdEnabled,
Operated,
OperatingTimes,
OrganizationName,
Overload,
Percent,
PeriodsPerSchedule,
PhaseRotation,
Phases3to1,
PhysicalParent,
PnCEnabled,
Policy,
PostChargingTime,
Power,
Present,
Problem,
ProfileStackLevel,
Protecting,
ProtocolAgreed,
ProtocolSupported,
ProtocolSupportedByEV,
PublicKey,
PublicKeyWithSignedMeterValue,
QueueAllMessages,
RateUnit,
RegisterValuesWithoutPhases,
RemainingTimeBulk,
RemainingTimeFull,
ReportingValueSize,
RequestMeteringReceipt,
ResetRetries,
ResumptionTimeout,
SampledMeasurands,
SamplingInterval,
SeccId,
SecurityProfile,
SendDuringIdle,
SerialNumber,
ServiceRenegotiationSupport,
SignReadings,
SignStartedReadings,
SignUpdatedReadings,
SignalStrength,
SlotStatus,
SoC,
SoH,
State,
StateOfCharge,
StateOfChargeBulk,
StopTxOnEVSideDisconnect,
StopTxOnInvalidId,
Storage,
SupplyPhases,
SupportsExpiryDateTime,
Suspending,
Suspension,
TariffFallbackMessage,
Temperature,
Time,
TimeAdjustmentReportingThreshold,
TimeOffset,
TimeSource,
TimeZone,
Timeout,
Token,
TokenType,
TotalCostFallbackMessage,
Tries,
Tripped,
TxBeforeAcceptedEnabled,
TxEndedInterval,
TxEndedMeasurands,
TxStartPoint,
TxStartedMeasurands,
TxStopPoint,
TxUpdatedInterval,
TxUpdatedMeasurands,
UnlockOnEVSideDisconnect,
V2GCertificateInstallationEnabled,
VehicleCertificate,
VehicleId,
VersionDate,
VersionNumber,
VoltageImbalance,
VendorName,
SupportedIdTokenType,
SelftestActive,
CHAdeMOProtocolNumber,
VehicleStatus,
DynamicControl,
HighCurrentControl,
HighVoltageControl,
AutoManufacturerCode,
VehicleID,
BatteryCapacity,
ValueSize,
EvseId,
MaxScheduleEntries,
RequestedEnergyTransferMode,
NotificationDelay,
Capacity,
MonitoringBase,
MonitoringLevel,
RetryBackOffRandomRange,
RetryBackOffRepeatTimes,
RetryBackOffWaitMinimum,
WebSocketPingInterval,
EnergyTransferResumptionRandomRange,
OcppCsmsUrl,
OcppInterface,
OcppTransport,
OcppVersion,
CsmsRootCertificateHashAlgorithm,
CsmsRootCertificateIssuerKeyHash,
CsmsRootCertificateIssuerNameHash,
CsmsRootCertificateSerialNumber,
VpnEnabled,
VpnType,
VpnServer,
VpnUser,
VpnGroup,
VpnPassword,
VpnKey,
ApnEnabled,
Apn,
ApnUserName,
ApnPassword,
SimPin,
PreferredNetwork,
UseOnlyPreferredNetwork,
ApnAuthentication,
Other(String<50usize>),
}Expand description
Standardized Variable.name values.
The schema types Variable.name as a plain string, since a Charging Station may expose vendor-specific variables alongside these.
An open set: values the specification doesn’t define are carried
in Self::Other rather than rejected, so a deployment’s own
values survive a deserialize/serialize round trip.
Comparison and hashing go through the wire string, not the variant,
so Other("...") holding a standardized value compares equal to
that variant.
Variants§
ACCurrent
RMS AC Current (in amperes). For 3-phase circuits, each phase (and optional neutral) is represented by a Variable instance equal to a value of the PhaseEnumType (e.g. L1,N). Unkeyed values reported for a Component declared to be multi-phase are assumed to be an average of all per-phase readings and written values are common per-phase settings. Example(s): ChargingStation: Total AC current consumption (all EVSE’s, ancillaries), EVSE: Total current consumed by EVSE: includes losses (AC->DC) and EVSE specific ancillaries (e.g. fans), ElectricalFeed: Inflow AC current on feed
ACPhaseSwitchingSupported
If defined and true, this EVSE supports the selection of which phase to use for 1 phase AC charging.
ACVoltage
RMS AC Voltage (in volts). For 3-phase circuits, each phase (and optional neutral) is represented by a Variable instance equal to a value of the PhaseEnumType (e.g. L1,N). Unkeyed values reported for a Component declared to be multi-phase are assumed to be an average ofall per-phase readings and written values are common per-phase settings. Example(s): ElectricalFeed: Input Voltage
Active
Component is in its non-resting / active state: e.g: On, Engaged, Locked. Some Components may have secondary functions that have corresponding Active Variables with an explicit Variable instance., Note: Monitoring of changes in the Active state of any Component can be specified by setting Delta monitoring on the boolean value with a delta values of 1. Setting/clearing an Active Variable activates/stops the associated functionality, where remotely controllable. Only components that are Available and Enabled can be in the Active state.
ActiveMonitoringBase
Shows the currently used MonitoringBase.
ActiveMonitoringLevel
Shows the currently use MonitoringLevel.
ActiveNetworkProfile
Indicates the configuration profile the station uses to connect to the network.
ActiveTransactionId
Active transaction on charging station or EVSE.
AdditionalInfoItemsPerMessage
Maximum number of additionalInfo items that can be sent in one message.
AdditionalRootCertificateCheck
When set to true, only one certificate (plus a temporarily fallback certificate) of certificateType CSMSRootCertificate is allowed to be installed at a time.
AllowEnergyTransferResumption
This variable defines whether energy transfer is allowed to be resumed when the transaction is resumed after a reset or power outage.
AllowNewSessionsPendingFirmwareUpdate
Indicates whether new sessions can be started on EVSEs, while Charging Station is waiting for all EVSEs to become Available in order to start a pending firmware update.
AllowReset
Component can be reset. Can be used to announce that an EVSE can be reset individually.
AllowSecurityProfileDowngrade
If this variable is implemented and set to true, then the Charging Station allows downgrading the security profile from 3 to 2.
Angle
Angle(s) relative to normal/design idle position. Multiple Variable instance values may be used to indicate angular position in multiple axes (e.g. Left-Right, Forward-Back).
Attempts
Number of attempts (INCLUDING the original attempt) in the last successful or attempted, cycle of operation. Applies typically to self-monitoring motorized electro-mechanical equipment, etc. {Null}: Unknown, 0: Not Attempted/Not allowed, 1: Single attempt/No retries [allowed], 2-N: [up to] N tries [allowed]
AuthorizeRemoteStart
Whether a remote request to start a transaction in the form of RequestStartTransactionRequest message should be authorized beforehand like a local action to start a transaction.
AvailabilityState
A value of ConnectorStatusEnumType (See part 2): replicates ConnectorStatus values reported in StatusNotification messages.
Available
The Component exists and is locally configured/wired for use, but might not be (remotely) Enabled.
BasicAuthPassword
The basic authentication password is used for HTTP Basic Authentication.
BytesPerMessage
Message Size (in bytes) - puts constraint on GetReportRequest, GetMonitoringReportRequest or GetVariableRequest message size.
CentralContractValidationAllowed
If this variable exists and has the value true, then Charging Station can provide a contract certificate that it cannot validate, to the CSMS for validation as part of the AuthorizeRequest.
CertSigningRepeatTimes
This variable can be used to configure the amount of times the Charging Station SHALL double the previous back-off time, starting with the number of seconds configured at CertSigningWaitMinimum, every time the back-off time expires without having received the CertificateSignedRequest containing the from the CSR generated signed certificate.
CertSigningWaitMinimum
This configuration variable defines how long the Charging Station has to wait before generating another CSR, in the case the CSMS accepts the SignCertificateRequest, but never returns the signed certificate.
Certificate
Digital Certificate (in Base64 encoding)
CertificateEntries
Amount of Certificates currently installed on the Charging Station.
CertificateStatusSource
When present, this variable tells CSMS whether Charging Station uses OCSP or CRL to check for revoked certificates.
ChargeProtocol
The Charging Control Protocol applicable to a Connector. CHAdeMO: CHAdeMO protocol, ISO15118: ISO15118 V2G protocol (wired or wireless) as used with CCS, CPPWM: IEC61851-1 / SAE J1772 protocol (ELV DC & PWM signalling via Control Pilot wire), Uncontrolled: No charging power management applies (e.g. Schuko socket), Undetermined: Yet to be determined (e.g. before plugged in), Unknown: Not determinable, NOTE: ChargeProtocol is distinct from and orthogonal to connectorType.
ChargingCompleteBulk
Charging up to StateOfChargeBulk has completed.
ChargingCompleteFull
Charging up to StateOfCharge.maxSet has completed.
ChargingProfilePersistence
If an instance of this variable is true, then charging profiles with the chargingProfilePurpose mentioned in the variableInstance are persistent, i.e. they are stored persistently and will still exist after a reboot.
ChargingState
This variable reports the current transaction charging state for an EVSE.
ChargingTime
Time from earliest to latest substantive energy transfer
Color
Standard 24 bit hexadecimal RGB values. Reg Green Blue color intensity, expressed as standard 24 bit hexadecimal RGB values: 3 00-FF (0-255), in order RRGGBB). E.g. 000000: Black, FF0000: Red, 00FF00: Green, 0000FF: Blue, FFFF00:Yellow, FFFFFF: White, 008000: Medium intensity green.
CommunicationParent
Points to a communication parent component (data flow source), to allow rendering the communication hierarchy in a UI.
Complete
Component’s operation cycle has completed. Used only in event notifications, where it is always true.
ConditionsSupported
If set to true the Charging Station supports tariffs with conditions.
ConfigurationValueSize
This Configuration Variable can be used to limit the following fields: SetVariableData.attributeValue and VariableCharacteristics.valuesList.
ConnectedTime
Time since logical connection established
ConnectorType
A value of ConnectorStringEnumType (See Appendix 7). Specific type of connector, including sub-variant information. Note: Distinct and orthogonal to Charging Protocol, Power Type, Phases.
ContractCertificateInstallationEnabled
If this variable is true, then ISO 15118 contract certificate installation/update as described by use case M01 - Certificate installation EV
ContractValidationOffline
If this variable is true, then Charging Station will try to validate a contract certificate when it is offline.
Count
General purpose integer count variable for Component state reporting
CountryName
The countryName of the SECC in the ISO 3166-1 format.
Currency
Currency in a ISO 4217 formatted currency code.
CurrentImbalance
Percentage current imbalance in an AC three phase supply.
CustomImplementationEnabled
This standard configuration variable is used to enable/disable the custom implementation named in the variableInstance.
CustomTriggers
This variable defines the names of custom triggers that Charging Station supports in a customTrigger field of TriggerMessageRequest.
DCCurrent
DC Current (in amperes). May be an instantaneous measurement, or a period average, depending on context/equipment.
DCInputPhaseControl
When DCInputPhaseControl is true, then the values of numberPhases and PhaseToUse in a ChargingSchedulePeriodType will select the input phases from the grid to be used by the DC EVSE.
DCVoltage
DC Voltage (volts). May be an instantaneous measurement, or a period average, depending on context/equipment.
DataText
Text associated with a Component, e.g. a Display.
DateTime
Point in time value, in [RFC3339] datetime format. Time zone optional.
DepartureTime
Time in [RFC3339] datetime format, when an EV intends to leave the charging station.
DisablePostAuthorize
When set to true this variable disables the behavior to request authorization for an
DisableRemoteAuthorization
When set to true this instructs the Charging Station to not issue any AuthorizationRequests, but only use Authorization Cache and Local Authorization List to determine validity of idTokens.
DisplayMessages
Maximum number of different messages that can configured in this Charging Station simultaneous, via SetDisplayMessageRequest.
ECVariant
Production series variants reflecting internal design changes or sub-component substitutions not affecting external functionality.
EVConnectionTimeOut
Interval from between ‘starting’ of a transaction until incipient transaction is automatically canceled, due to failure of EV driver to (correctly) insert the charging cable connector(s) into the appropriate socket(s).
ElectricalParent
Points to a electrical parent component (energy flow source), to allow rendering the electrical hierarchy in a UI.
Enabled
The Component is Enabled for operation. For Available components that cannot be selectively (remotely) enabled / disabled, this value is always true. Note: Available cannot be false of Enabled is true, so during inventory reporting, Enabled=1 also logically states Available=true
Energy
Energy quantity (in Wh) for reporting/configuring values related to stored energy (i.e. not transferred energy).
EnergyCapacity
Energy capacity in Wh of an energy storage device.
EnergyExport
Total energy transferred: e.g. from EV during (ongoing or terminated) charging session (in wH by default)
EnergyExportRegister
Cumulative export kWh register value, such as from a (certified) fiscal energy meter.
EnergyImport
Total energy transferred.
EnergyImportRegister
Cumulative export kWh register value, such as from a (certified) fiscal energy meter.
Entries
General purpose variable for reporting/managing numbers of entries in repetitive data structures. maxLimit characteristic reports maximum possible entries.
ExternalConfigChangeDate
Date/time when the configuration was changed externally, i.e. outside of CSMS, for example by a local service action.
ExternalConstraintsProfileDisallowed
Indicates whether a Charging Station allows an external system to submit a ChargingStationExternalConstraints charging profile.
ExternalControlSignalsEnabled
Indicates whether a Charging Station is able to respond to external control signals that influence charging. If the variable is true, but CSMS has set <<configkey-external-constraints-profile-disallowed>> = true, then external control signals are only allowed during a charging profile with a chargingProfilePeriod = ExternalLimits or ExternalSetpoint.
Fallback
Component is operating in a fallback, or backup mode. In inventory reports, a Value of 1 for the maxLimit characteristic indicates that the component can enter a fallback state (i.e. a fallback mode is present).
FanSpeed
Fan Speed (in RPM). A value of 0 represents stopped/stalled. An empty value indicates that fan speed cannot be read.
FieldLength
This variable is used to report the length of <field> in <message> when it is larger
FileTransferProtocols
List of supported file transfer protocols.
FirmwareVersion
Version number of firmware.
Force
Reports (impact) force/ acceleration values (estimates) in one or more directions, in units of Newtons or “g”. Multiple force readings in different (orthogonal) dimensions may be reported using Variable instance values, such as Down, Right, Forward.
Formats
List of message formats supported by this Charging Station. Possible values: ASCII, HTML, URI, UTF-8.
Frequency
Frequency of AC power, signal, or component operation.
FrequencySchedule
A JSON-formatted string with an array of { time, freq } pairs, in which time is
FuseRating
Current rating of a fuse/breaker. Variable instances keyed by phase identifier (L1/L2/L3/N).
HeartbeatInterval
Interval of inactivity (no OCPP exchanges) with CSMS after which the Charging Station should send HeartbeatRequest.
Height
Height above(+)/below(-) reference level (ground level unless context demands otherwise).
Humidity
The relative humidity in %.
Hysteresis
Specifies the width of a ‘dead band’ (as a percentage of the threshold) around the central value of a threshold setting (e.g. MinSet, MaxSet, monitor thresholds) to avoid repeated triggering when the measured quantity lies close to the threshold and is subject to small variations.
ICCID
ICCID (Integrated Circuit Card IDentifier) of mobile data SIM card.
IMSI
IMSI (International Mobile Subscriber Identity) number of mobile data SIM card
ISO15118EvseId
EVSE ID in string format as used in ISO 15118 and IEC 63119-2
IdToken
The IdToken used to authorize a charging transaction.
Identity
The Charging Station identity.
Impedance
Impedance: Primary value is real (resistive only) impedance. Where a complex impedance is to be reported, the imaginary part (reactance) must be represented with a separate Variable instance value of ‘reactance’. Reactance values are expressed at the (nominal) relevant operating frequency of the Component (e.g. 50/60Hz for mains electricity feed).
Interval
Minimum Interval (in seconds) between (attempted) operations.
ItemsPerMessage
Maximum number of ComponentVariable entries that can be sent in one GetReportRequest or GetMonitoringReportRequest message.
Label
Label for a component. Specifies a non-unique label to be used in a hierarchy UI rendering, in place of the unique component name and instance
Language
Default language code, per RFC 5646, of this Charging Station.
Length
General Purpose linear distance measure.
LifeTime
Indicates how long it takes until a token expires in the authorization cache since it is last used.
Light
(Ambient) light level. The value is in Lux.
LimitChangeSignificance
If at the Charging Station side a change in the limit in a ChargingProfile is lower than this percentage, the Charging Station MAY skip sending a NotifyChargingLimitRequest or a TransactionEventRequest message to the CSMS.
LocalAuthorizeOffline
Whether the Charging Station, when Offline, will start a transaction for locally-authorized identifiers.
LocalLoadBalancing
Variable with instances to control local load-balancing.
LocalPreAuthorize
Whether the Charging Station, when online, will start a transaction for locally-authorized identifiers without waiting for or requesting an AuthorizeResponse from the CSMS.
LogicalParent
Points to a logical parent component, to allow rendering a comprehensive overview of the Charging Station components in a UI.
Manufacturer
Component Manufacturer name
MasterPassGroupId
IdTokens that have this id as groupId belong to the Master Pass Group.
MaxCertificateChainSize
This configuration variable can be used to limit the size of the ‘certificateChain’ field from the CertificateSignedRequest PDU.
MaxEnergyOnInvalidId
Maximum amount of energy in Wh delivered when an identifier is deauthorized by the CSMS after start of a transaction.
MaxExternalConstraintsId
Defines the highest value that a charging profile id of a ChargingStationExternalConstraints profile in the Charging Station can have.
MaxPriceElements
For ISO15118Ctrlr: The maximum number of priceRuleStacks and priceLevelScheduleEntries that Charging Station is able to accept in a ChargingScheduleType.
Measurands
Measurand(s) to be included in <<metervaluesrequest,MeterValuesRequest>> or <<transactioneventrequest,TransactionEventRequest>>
Message
Specific stored message for display.
MessageAttemptInterval
How long the Charging Station should wait before resubmitting a TransactionEventRequest message that the CSMS failed to process.
MessageAttempts
How often the Charging Station should try to submit a TransactionEventRequest message when the CSMS fails to process it.
MessageTimeout
The purpose of the message timeout is to be able to consider a request message as not sent and continue with other tasks when the message did not arrive due to communication errors or software failure.
MinimumStatusDuration
Minimum duration that a Charging Station or EVSE status is stable before StatusNotificationRequest is sent to the CSMS.
Mode
Operating mode string from among valid options (communicated by OptionList, etc. during capability/configuration discovery).
Model
Manufacturer’s Model code/number of Component, including suffixes etc. to identify functional, regional or linguistic variation, but NOT engineering change level internal variation not affecting external behaviour, etc.
NetworkAddress
Current network address of a Component.
NetworkConfigurationPriority
A comma separated ordered list of the priority of the possible Network Connection Profiles. The list of possible available profile slots for the network configuration profiles SHALL be reported, via the valuesList characteristic of this Variable.
NetworkProfileConnectionAttempts
Specifies the number of connection attempts the Charging Station executes before switching to a different profile.
NextTimeOffsetTransitionDateTime
Date time of the next time offset transition. On this date time, the clock displayed to the EV driver will be given the new offset as configured via TimeOffsetNextTransition.
NonEvseSpecific
For ReservationCtrlr: If this configuration variable is present and set to true: Charging Station supports reservation where EVSE id is not specified.
NotificationMaxDelay
For ISO15118Ctrlr: The SECC (EVSE) uses the NotificationMaxDelay element in the EVSEStatus to indicate the time in seconds until it expects the EVCC (EV) to react on the action request indicated in EVSENotification.
NotifyChargingLimitWithSchedules
Indicates if the Charging Station should include the externally set charging limit/schedule in the message when it sends a NotifyChargingLimitRequest message.
NtpServerUri
This contains the address of the NTP server.
NtpSource
Use the NTP server provided via DHCP, or use the manually configured NTP server.
OfflineQueuingSeverity
When set and the Charging Station is offline, the Charging Station shall queue any NotifyEventRequest messages triggered by a monitor with a severity number equal to or lower than the severity configured here.
OfflineTariffFallbackMessage
Message (and/or tariff information) to be shown to an EV Driver when Charging Station is offline.
OfflineThreshold
When the offline period of a Charging Station exceeds the OfflineThreshold it is recommended to send a StatusNotificationRequest for all its Connectors when the Charging Station is back online.
OfflineTxForUnknownIdEnabled
If this key exists and is true, the Charging Station supports Unknown Offline Authorization.
Operated
The Component operated in an instantaneous, transient, or immediately self-resetting pattern. Used only in event notifications, where it is always true.
OperatingTimes
Recurring operating times in iCalendar RRULE format.
OrganizationName
The organizationName of the CSO operating the charging station.
Overload
Component is in Overload state.
Percent
Generic dimensionless value reporting/setting value.
PeriodsPerSchedule
Maximum number of periods that may be defined per ChargingSchedule.
PhaseRotation
This variable describes the phase rotation of a Component relative to its parent Component, using a
Phases3to1
If defined and true, this Charging Station supports switching from 3 to 1 phase during a transaction.
PhysicalParent
Points to a physical parent component (container), to allow rendering an overview of the Charging Station component locations in a UI.
PnCEnabled
If this variable is true, then ISO 15118 plug and charge as described by use case C07 - Authorization using Contract Certificates is enabled.
Policy
Cache Entry Replacement Policy: least recently used, least frequently used, first in first out, other custom mechanism.
PostChargingTime
Elapsed time in seconds since last substantive energy transfer
Power
Instantaneous (real) Power (measured/calculated, including power factor for AC). Where a component (e.g. AC to DC Power Converter) has multiple power measurements, the default (unkeyed) instance is “input” power.
Present
Component exists, but might not be locally configured/wired for use, nor (remotely) Enabled.
Problem
Component itself has a ‘Problem’ condition that impacts in any significant way on its normal operation. By definition, ‘Problem’ state includes (logical OR) ‘Fault’ state. ‘Problem’ specifically INCLUDES inability to operate that is propagated (up/down/sideways) from any other associated/connected/containing/contained Component.
ProfileStackLevel
Maximum acceptable value for stackLevel in a ChargingProfile.
Protecting
Applies to ‘sensor’ type Components that have an associated protection capability, whereby they can disconnect power (e.g. using the main PowerContactor) if the sensed quantity is outside preset/configured limits. If Protecting is true, the Component is actively preventing/interrupting charging.
ProtocolAgreed
For ConnectedEV: A string with the following comma-separated items: “<uri>,<major>,<minor>”. This is the protocol uri and version information that was agreed upon between EV and EVSE in the supportedAppProtocolReq handshake from ISO 15118.
ProtocolSupported
For ISO15118Ctrlr: A string with the following comma-separated items: “<uri>,<major>,<minor>”. <uri> is in the format as used in the SupportedAppProtocolReq message from ISO 15118-2 and ISO 15118-20. This variable has at most 20 instances, one for each supported protocol version.
ProtocolSupportedByEV
For ConnectedEV: A string with the following comma-separated items: “<uri>,<major>,<minor>”. This is information from the SupportedAppProtocolReq message from ISO 15118. Each priority is given its own variable instance. Priority is a number from 1 to 20 as a string.
PublicKey
Configuration variable that can be used to retrieve the public key for a meter connected to a specific EVSE.
PublicKeyWithSignedMeterValue
This Configuration Variable can be used to configure whether a public key needs to be sent with a signed meter value.
QueueAllMessages
When this variable is set to true, the Charging Station will queue all message until they are delivered to the CSMS.
RateUnit
A list of supported quantities (A, W) for use in a ChargingSchedule.
RegisterValuesWithoutPhases
If this variable reports a value of true, then meter values of measurand Energy.Active.Import.Register will only report the total energy over all phases without reporting the individual phase values.
RemainingTimeBulk
Number of seconds remaining to charge to bulk state of charge, given by StateOfChargeBulk.
RemainingTimeFull
Number of seconds remaining to charge to 100% state of charge.
ReportingValueSize
This Configuration Variable can be used to limit the following fields: GetVariableResult.attributeValue, VariableAttribute.value and EventData.actualValue.
RequestMeteringReceipt
For ISO15118Ctrlr: If this variable is true, then Charging Station shall request a metering receipt
ResetRetries
Number of times to retry a reset of the Charging Station when a reset was unsuccessful.
ResumptionTimeout
This variable defines the maximum number of seconds that a transaction may be interrupted by a power outage and still be resumed afterwards.
SampledMeasurands
The set of measurands to be sampled by the DataCollector component.
SamplingInterval
The sampling interval in seconds.
SeccId
The name of the SECC in the string format as required by ISO 15118.
SecurityProfile
This configuration variable is used to report the security profile used by the Charging Station.
SendDuringIdle
For AlignedDataCtrlr: If set to true, the Charging Station SHALL only send clock aligned meter values when there is no transaction ongoing.
SerialNumber
Serial number of Component.
ServiceRenegotiationSupport
For ISO15118Ctrlr: If set to ‘True’ the SECC (EVSE) is capable of ServiceRenegotiation.
SignReadings
If set to true, the Charging Station SHALL include signed meter values in the TransactionEventRequest(Ended).
SignStartedReadings
If set to true, the Charging Station SHALL include signed meter values for context = Transaction.Begin in the metervalues field in the TransactionEventRequest(Started or Updated).
SignUpdatedReadings
If set to true, the Charging Station SHALL include signed meter values in the metervalues field in the TransactionEventRequest(Updated).
SignalStrength
(Radio/Wired/Optical) data signal strength, in ASU (typically 0-31 or 99 for unknown). Or dbmW (typically -140 to -50).
SlotStatus
This variable represents the status of the door of the battery slot.
SoC
SoC of the component BatteryCartridge which refers to the battery that is inserted at the EVSE.
SoH
SoH of the component BatteryCartridge which refers to the battery that is inserted at the EVSE.
State
A state code or name identifier string, to allow the internal state of components to be reported and/or controlled
StateOfCharge
Energy Storage Device (e.g. battery) state of charge, expressed as a percentage of nominal design 0-100% operating range. The value of StateOfCharge.maxSet represents the maximum state of charge for a full battery and is usually at or near 100%.
StateOfChargeBulk
Energy Storage Device (e.g. battery) state of charge up to which fast charging is possible. Above this percentage charging speed will drop significantly.
StopTxOnEVSideDisconnect
When set to true, the Charging Station SHALL deauthorize the transaction when the cable is unplugged from the EV.
StopTxOnInvalidId
Whether the Charging Station will deauthorize an ongoing transaction when it receives a non- Accepted authorization status in TransactionEventResponse for this transaction.
Storage
In bytes. Amount of storage occupied. Storage(maxLimit) specifies absolute limit Storage(MaxSet) restricts usage to specified Max, if supported.
SupplyPhases
Number of alternating current phases connected/available. 1 or 3 for AC, 0 means DC (no alternating phases). Null value indicates that the number of phases (e.g. in use) is unknown.
SupportsExpiryDateTime
For LocalAuthListCtrlr: When set to true Charging Station will disregard idTokens for authorization as if not present in the Local Authorization List when current date/time is past the value of cacheExpiryDateTime.
Suspending
If Suspending is true, the Component can is currently suspending charging.
Suspension
Applies to ‘sensor’ type Components that have a charging suspension capability, typically for safety or equipment protection reasons. If Suspension is true, the component can suspend charging when the sensed quantity is outside preset/configured limits.
TariffFallbackMessage
Message (and/or tariff information) to be shown to an EV Driver when there is no driver specific tariff information available.
Temperature
Temperature(s) of component (in Celsius, by default). Components may have multiple indexed temperature sensors.
Time
Point in time value, in ISO 8601 datetime format. Time zone optional.
TimeAdjustmentReportingThreshold
When the clock time is adjusted forwards or backwards for more then TimeAdjustmentReportingThreshold number of seconds, a SecurityEventNotification( ‘SettingSystemTime’ ) is sent by the charging station.
TimeOffset
A Time Offset with respect to Coordinated Universal Time (aka UTC or Greenwich Mean Time) in the form of an [RFC3339] time (zone) offset suffix, including the mandatory “+” or “-“ prefix.
TimeSource
Via this variable, the Charging Station provides the CSMS with the option to configure a clock source.
TimeZone
Configured current local time zone in the format: ‘Europe/Oslo’, ‘Asia/Singapore’ etc.
Timeout
Generic timeout value for Component operation (in seconds).
Also listed as: For BatterySwapCtrlr: Timeout in seconds in which a set of batteries must be inserted or removed after successful authorization.
Token
String of bytes representing an ID token.
TokenType
Type of Token. Value is one of IdTokenEnumStringType (See Appendix 7).
TotalCostFallbackMessage
Message to be shown to an EV Driver when the Charging Station cannot retrieve the cost for a transaction at the end of the transaction.
Tries
Number of attempts done by a Component.
Tripped
Single-shot device requires explicit intervention to re-prime/activate to normal.
TxBeforeAcceptedEnabled
With this configuration variable the Charging Station can be configured to allow charging before having received a BootNotificationResponse with status: Accepted.
TxEndedInterval
Interval between sampling of metering (or other) data, intended to be transmitted in the TransactionEventRequest(Ended) message.
TxEndedMeasurands
Sampled measurands to be included in the meterValues element of TransactionEventRequest(Ended).
TxStartPoint
Start points for a transaction.
TxStartedMeasurands
Sampled measurands to be included in the meterValues element of TransactionEventRequest(Started).
TxStopPoint
Stop points of a transaction.
TxUpdatedInterval
Interval between sampling of metering (or other) data, intended to be transmitted in the TransactionEventRequest(Updated) message.
TxUpdatedMeasurands
Sampled measurands to be included in the meterValues element of TransactionEventRequest(Updated).
UnlockOnEVSideDisconnect
When set to true, the Charging Station SHALL unlock the cable on the Charging Station side when the cable is unplugged at the EV.
V2GCertificateInstallationEnabled
If this variable is true, then ISO 15118 V2G Charging Station certificate installation as described by use case A02 - Update Charging Station Certificate by request of CSMS
VehicleCertificate
For ConnectedEV: The PEM encoded X.509 leaf/intermediate/root certificate when present in the vehicle certificate chain.
VehicleId
ID that EV provides to charging station. Encoded as a hexbinary string. In ISO 15118 the EVCCID is 6 bytes (MAC address), in CHAdeMO the vehicle id can be 24 bytes.
VersionDate
[RFC3339]
VersionNumber
Version number of hardware
VoltageImbalance
Percentage voltage imbalance in three phase supply.
VendorName
Listed in the specification’s device model table but not in its dedicated name table.
SupportedIdTokenType
Listed in the specification’s device model table but not in its dedicated name table.
SelftestActive
Listed in the specification’s device model table but not in its dedicated name table.
CHAdeMOProtocolNumber
Listed in the specification’s device model table but not in its dedicated name table.
VehicleStatus
Listed in the specification’s device model table but not in its dedicated name table.
DynamicControl
Listed in the specification’s device model table but not in its dedicated name table.
HighCurrentControl
Listed in the specification’s device model table but not in its dedicated name table.
HighVoltageControl
Listed in the specification’s device model table but not in its dedicated name table.
AutoManufacturerCode
Listed in the specification’s device model table but not in its dedicated name table.
VehicleID
Listed in the specification’s device model table but not in its dedicated name table.
BatteryCapacity
Listed in the specification’s device model table but not in its dedicated name table.
ValueSize
Listed in the specification’s device model table but not in its dedicated name table.
EvseId
Listed in the specification’s device model table but not in its dedicated name table.
MaxScheduleEntries
Listed in the specification’s device model table but not in its dedicated name table.
RequestedEnergyTransferMode
Listed in the specification’s device model table but not in its dedicated name table.
NotificationDelay
Listed in the specification’s device model table but not in its dedicated name table.
Capacity
Listed in the specification’s device model table but not in its dedicated name table.
MonitoringBase
Listed in the specification’s device model table but not in its dedicated name table.
MonitoringLevel
Listed in the specification’s device model table but not in its dedicated name table.
RetryBackOffRandomRange
Listed in the specification’s device model table but not in its dedicated name table.
RetryBackOffRepeatTimes
Listed in the specification’s device model table but not in its dedicated name table.
RetryBackOffWaitMinimum
Listed in the specification’s device model table but not in its dedicated name table.
WebSocketPingInterval
Listed in the specification’s device model table but not in its dedicated name table.
EnergyTransferResumptionRandomRange
Listed in the specification’s device model table but not in its dedicated name table.
OcppCsmsUrl
Listed in the specification’s device model table but not in its dedicated name table.
OcppInterface
Listed in the specification’s device model table but not in its dedicated name table.
OcppTransport
Listed in the specification’s device model table but not in its dedicated name table.
OcppVersion
Listed in the specification’s device model table but not in its dedicated name table.
CsmsRootCertificateHashAlgorithm
Listed in the specification’s device model table but not in its dedicated name table.
CsmsRootCertificateIssuerKeyHash
Listed in the specification’s device model table but not in its dedicated name table.
CsmsRootCertificateIssuerNameHash
Listed in the specification’s device model table but not in its dedicated name table.
CsmsRootCertificateSerialNumber
Listed in the specification’s device model table but not in its dedicated name table.
VpnEnabled
Listed in the specification’s device model table but not in its dedicated name table.
VpnType
Listed in the specification’s device model table but not in its dedicated name table.
VpnServer
Listed in the specification’s device model table but not in its dedicated name table.
VpnUser
Listed in the specification’s device model table but not in its dedicated name table.
VpnGroup
Listed in the specification’s device model table but not in its dedicated name table.
VpnPassword
Listed in the specification’s device model table but not in its dedicated name table.
VpnKey
Listed in the specification’s device model table but not in its dedicated name table.
ApnEnabled
Listed in the specification’s device model table but not in its dedicated name table.
Apn
Listed in the specification’s device model table but not in its dedicated name table.
ApnUserName
Listed in the specification’s device model table but not in its dedicated name table.
ApnPassword
Listed in the specification’s device model table but not in its dedicated name table.
SimPin
Listed in the specification’s device model table but not in its dedicated name table.
PreferredNetwork
Listed in the specification’s device model table but not in its dedicated name table.
UseOnlyPreferredNetwork
Listed in the specification’s device model table but not in its dedicated name table.
ApnAuthentication
Listed in the specification’s device model table but not in its dedicated name table.
Other(String<50usize>)
A value this version’s specification doesn’t define – typically a vendor-specific one, which OCPP explicitly permits.
Bounded at 50 bytes, the same maxLength the wire field carries,
so anything the field can hold this can hold. Prefer
Self::from_wire_or_other over constructing this directly: it
returns the standardized variant when the value is one, keeping a
single representation per wire string.
Implementations§
Source§impl VariableName
impl VariableName
Sourcepub const ALL: &'static [Self]
pub const ALL: &'static [Self]
Every value this version’s specification defines (260), in spec order.
Does not include Self::Other, which is unbounded in the
values it can hold.
Sourcepub fn from_wire(value: &str) -> Option<Self>
pub fn from_wire(value: &str) -> Option<Self>
Parses a wire value, returning None for values the
specification doesn’t define.
Use this to ask “is this one of the spec’s values?”. To accept
any value, use Self::from_wire_or_other.
Sourcepub fn from_wire_or_other(value: &str) -> Result<Self, ValueTooLong>
pub fn from_wire_or_other(value: &str) -> Result<Self, ValueTooLong>
Parses any wire value, falling back to Self::Other.
Fails only if value is longer than the specification’s
maxLength for this field, in which case it isn’t a value the
field could have carried in the first place.
Sourcepub fn is_standardized(&self) -> bool
pub fn is_standardized(&self) -> bool
Whether this is one of the values the specification defines, as opposed to a vendor’s own.
Trait Implementations§
Source§impl Clone for VariableName
impl Clone for VariableName
Source§fn clone(&self) -> VariableName
fn clone(&self) -> VariableName
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for VariableName
impl Debug for VariableName
Source§impl<'de> Deserialize<'de> for VariableName
Available on crate feature serde only.
impl<'de> Deserialize<'de> for VariableName
serde only.