Expand description
OCPP 2.1 composite datatypes.
Structs§
- ACCharging
Parameters - EV AC charging parameters for ISO 15118-2
- APN
- Collection of configuration data needed to make a data-connection over a cellular network. NOTE: When asking a GSM modem to dial in, it is possible to specify which mobile operator should be used. This can be done with the mobile country code (MCC) in combination with a mobile network code (MNC). Example: If your preferred network is Vodafone Netherlands, the MCC=204 and the MNC=04 which means the key PreferredNetwork = 20404 Some modems allows to specify a preferred network, which means, if this network is not available, a different network is used. If you specify UseOnlyPreferredNetwork and this network is not available, the modem will not dial in.
- Absolute
Price Schedule - The AbsolutePriceScheduleType is modeled after the same type that is defined in ISO 15118-20, such that if it is supplied by an EMSP as a signed EXI message, the conversion from EXI to JSON (in OCPP) and back to EXI (for ISO 15118-20) does not change the digest and therefore does not invalidate the signature. image::images/AbsolutePriceSchedule-Simple.png[]
- Additional
Info - Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.
- Additional
Selected Services - Part of ISO 15118-20 price schedule.
- Address
- (2.1) A generic address format.
- Authorization
Data - Contains the identifier to use for authorization.
- Battery
Data - Certificate
Hash Data - Certificate
Hash Data Chain - Certificate
Status - Revocation status of certificate
- Certificate
Status Request Info - Data necessary to request the revocation status of a certificate.
- Charging
Limit - Charging
Needs - Charging
Period - A ChargingPeriodType consists of a start time, and a list of possible values that influence this period, for example: amount of energy charged this period, maximum current during this period etc.
- Charging
Profile - A ChargingProfile consists of 1 to 3 ChargingSchedules with a list of ChargingSchedulePeriods, describing the amount of power or current that can be delivered per time interval. image::images/ChargingProfile-Simple.png[]
- Charging
Profile Criterion - A ChargingProfileCriterionType is a filter for charging profiles to be selected by a GetChargingProfilesRequest.
- Charging
Schedule - Charging schedule structure defines a list of charging periods, as used in: NotifyEVChargingScheduleRequest and ChargingProfileType. When used in a NotifyEVChargingScheduleRequest only duration and chargingSchedulePeriod are relevant and chargingRateUnit must be ‘W’. + An ISO 15118-20 session may provide either an absolutePriceSchedule or a priceLevelSchedule. An ISO 15118-2 session can only provide a_salesTariff_ element. The field digestValue is used when price schedule or sales tariff are signed. image::images/ChargingSchedule-Simple.png[]
- Charging
Schedule Period - Charging schedule period structure defines a time period in a charging schedule. It is used in: CompositeScheduleType and in ChargingScheduleType. When used in a NotifyEVChargingScheduleRequest only startPeriod, limit, limit_L2, limit_L3 are relevant.
- Charging
Schedule Update - Updates to a ChargingSchedulePeriodType for dynamic charging profiles.
- Charging
Station - The physical system where an Electrical Vehicle (EV) can be charged.
- Clear
Charging Profile - A ClearChargingProfileType is a filter for charging profiles to be cleared by ClearChargingProfileRequest.
- Clear
Monitoring Result - Clear
Tariffs Result - Component
- A physical or logical component
- Component
Variable - Class to report components, variables and variable attributes and characteristics.
- Composite
Schedule - Constant
Stream Data - Consumption
Cost - Cost
- Cost
Details - CostDetailsType contains the cost as calculated by Charging Station based on provided TariffType. NOTE: Reservation is not shown as a chargingPeriod, because it took place outside of the transaction.
- Cost
Dimension - Volume consumed of cost dimension.
- Custom
Data - This class does not get ‘AdditionalProperties = false’ in the schema generation, so it can be extended with arbitrary JSON properties to allow adding custom data.
- DCCharging
Parameters - EV DC charging parameters for ISO 15118-2
- DERCharging
Parameters - (2.1) DERChargingParametersType is used in ChargingNeedsType during an ISO 15118-20 session for AC_BPT_DER to report the inverter settings related to DER control that were agreed between EVSE and EV. Fields starting with “ev” contain values from the EV. Other fields contain a value that is supported by both EV and EVSE. DERChargingParametersType type is only relevant in case of an ISO 15118-20 AC_BPT_DER/AC_DER charging session. NOTE: All these fields have values greater or equal to zero (i.e. are non-negative)
- DERCurve
- DERCurve
Get - DERCurve
Points - EVAbsolute
Price Schedule - (2.1) Price schedule of EV energy offer.
- EVAbsolute
Price Schedule Entry - (2.1) An entry in price schedule over time for which EV is willing to discharge.
- EVEnergy
Offer - (2.1) A schedule of the energy amount over time that EV is willing to discharge. A negative value indicates the willingness to discharge under specific conditions, a positive value indicates that the EV currently is not able to offer energy to discharge.
- EVPower
Schedule - (2.1) Schedule of EV energy offer.
- EVPower
Schedule Entry - (2.1) An entry in schedule of the energy amount over time that EV is willing to discharge. A negative value indicates the willingness to discharge under specific conditions, a positive value indicates that the EV currently is not able to offer energy to discharge.
- EVPrice
Rule - (2.1) An entry in price schedule over time for which EV is willing to discharge.
- EVSE
- Electric Vehicle Supply Equipment
- Enter
Service - Enter
Service Get - Event
Data - Class to report an event notification for a component-variable.
- Firmware
- Represents a copy of the firmware that can be loaded/updated on the Charging Station.
- FixedPF
- FixedPF
Get - Fixed
Var - Fixed
VarGet - Freq
Droop - Freq
Droop Get - GetVariable
Data - Class to hold parameters for GetVariables request.
- GetVariable
Result - Class to hold results of GetVariables request.
- Gradient
- Gradient
Get - Hysteresis
- IdToken
- Contains a case insensitive identifier to use for the authorization and the type of authorization to support multiple forms of identifiers.
- IdToken
Info - Contains status information about an identifier. It is advised to not stop charging for a token that expires during charging, as ExpiryDate is only used for caching purposes. If ExpiryDate is not given, the status has no end date.
- Limit
AtSoC - Limit
MaxDischarge - Limit
MaxDischarge Get - LogParameters
- Generic class for the configuration of logging entries.
- Message
Content - Contains message details, for a message to be displayed on a Charging Station.
- Message
Info - Contains message details, for a message to be displayed on a Charging Station.
- Meter
Value - Collection of one or more sampled values in MeterValuesRequest and TransactionEvent. All sampled values in a MeterValue are sampled at the same point in time.
- Modem
- Defines parameters required for initiating and maintaining wireless communication with other devices.
- Monitoring
Data - Class to hold parameters of SetVariableMonitoring request.
- Network
Connection Profile - The NetworkConnectionProfile defines the functional and technical parameters of a communication link.
- OCSP
Request Data - Information about a certificate for an OCSP check.
- Overstay
Rule - Part of ISO 15118-20 price schedule.
- Overstay
Rule List - Part of ISO 15118-20 price schedule.
- Periodic
Event Stream Params - Price
- Price with and without tax. At least one of exclTax, inclTax must be present.
- Price
Level Schedule - The PriceLevelScheduleType is modeled after the same type that is defined in ISO 15118-20, such that if it is supplied by an EMSP as a signed EXI message, the conversion from EXI to JSON (in OCPP) and back to EXI (for ISO 15118-20) does not change the digest and therefore does not invalidate the signature.
- Price
Level Schedule Entry - Part of ISO 15118-20 price schedule.
- Price
Rule - Part of ISO 15118-20 price schedule.
- Price
Rule Stack - Part of ISO 15118-20 price schedule.
- Rational
Number - Part of ISO 15118-20 price schedule.
- Reactive
Power Params - Relative
Time Interval - Report
Data - Class to report components, variables and variable attributes and characteristics.
- Sales
Tariff - A SalesTariff provided by a Mobility Operator (EMSP) . NOTE: This dataType is based on dataTypes from <<ref-ISOIEC15118-2,ISO 15118-2>>.
- Sales
Tariff Entry - Sampled
Value - Single sampled value in MeterValues. Each value can be accompanied by optional fields. To save on mobile data usage, default values of all of the optional fields are such that. The value without any additional fields will be interpreted, as a register reading of active import energy in Wh (Watt-hour) units.
- SetMonitoring
Data - Class to hold parameters of SetVariableMonitoring request.
- SetMonitoring
Result - Class to hold result of SetVariableMonitoring request.
- SetVariable
Data - SetVariable
Result - Signed
Meter Value - Represent a signed version of the meter value.
- Status
Info - Element providing more information about the status.
- Stream
Data Element - Tariff
- A tariff is described by fields with prices for: energy, charging time, idle time, fixed fee, reservation time, reservation fixed fee. + Each of these fields may have (optional) conditions that specify when a price is applicable. + The description contains a human-readable explanation of the tariff to be shown to the user. + The other fields are parameters that define the tariff. These are used by the charging station to calculate the price.
- Tariff
Assignment - Shows assignment of tariffs to EVSE or IdToken.
- Tariff
Conditions - These conditions describe if and when a TariffEnergyType or TariffTimeType applies during a transaction. When more than one restriction is set, they are to be treated as a logical AND. All need to be valid before this price is active. For reverse energy flow (discharging) negative values of energy, power and current are used. NOTE: minXXX (where XXX = Kwh/A/Kw) must be read as “closest to zero”, and maxXXX as “furthest from zero”. For example, a charging power range from 10 kW to 50 kWh is given by minPower = 10000 and maxPower = 50000, and a discharging power range from -10 kW to -50 kW is given by minPower = -10 and maxPower = -50. NOTE: startTimeOfDay and endTimeOfDay are in local time, because it is the time in the tariff as it is shown to the EV driver at the Charging Station. A Charging Station will convert this to the internal time zone that it uses (which is recommended to be UTC, see section Generic chapter 3.1) when performing cost calculation.
- Tariff
Conditions Fixed - These conditions describe if a FixedPrice applies at start of the transaction. When more than one restriction is set, they are to be treated as a logical AND. All need to be valid before this price is active. NOTE: startTimeOfDay and endTimeOfDay are in local time, because it is the time in the tariff as it is shown to the EV driver at the Charging Station. A Charging Station will convert this to the internal time zone that it uses (which is recommended to be UTC, see section Generic chapter 3.1) when performing cost calculation.
- Tariff
Energy - Price elements and tax for energy
- Tariff
Energy Price - Tariff with optional conditions for an energy price.
- Tariff
Fixed - Tariff
Fixed Price - Tariff with optional conditions for a fixed price.
- Tariff
Time - Price elements and tax for time
- Tariff
Time Price - Tariff with optional conditions for a time duration price.
- TaxRate
- Tax percentage
- TaxRule
- Part of ISO 15118-20 price schedule.
- Total
Cost - This contains the cost calculated during a transaction. It is used both for running cost and final cost of the transaction.
- Total
Price - Total cost with and without tax. Contains the total of energy, charging time, idle time, fixed and reservation costs including and/or excluding tax.
- Total
Usage - This contains the calculated usage of energy, charging time and idle time during a transaction.
- Transaction
- Transaction
Limit - Cost, energy, time or SoC limit for a transaction.
- Unit
OfMeasure - Represents a UnitOfMeasure with a multiplier
- V2XCharging
Parameters - Charging parameters for ISO 15118-20, also supporting V2X charging/discharging.+ All values are greater or equal to zero, with the exception of EVMinEnergyRequest, EVMaxEnergyRequest, EVTargetEnergyRequest, EVMinV2XEnergyRequest and EVMaxV2XEnergyRequest.
- V2XFreq
Watt Point - (2.1) A point of a frequency-watt curve.
- V2XSignal
Watt Point - (2.1) A point of a signal-watt curve.
- VPN
- VPN Configuration settings
- Variable
- Reference key to a component-variable.
- Variable
Attribute - Attribute data of a variable.
- Variable
Characteristics - Fixed read-only parameters of a variable.
- Variable
Monitoring - A monitoring setting for a variable.
- Voltage
Params