You are on page 1of 7

Appendix A: OCPP configuration keys

Standard OCPP configuration keys


Notes:

1. Not all keys defined by standard(s) are documented here. Here are only standard keys that are related to Ensto chargers. For full OCPP
key list (1.5, 1.6 and 2.0), visit here: https://www.openchargealliance.org/
2. Default parameter values and in some cases their appearance (numeric versus string value) are related to Ensto chargers.

Key name Description Accessibility Type Range, Default or


example

StopTxnSampledData Types of meter values R/W String Energy.Active.Import.


that should be sent as Register
sample data elements in
stop transaction
messages

StopTxnAlignedData Types of meter values R/W String Energy.Active.Import.


that should be sent as Register
clock aligned data
elements in stop
transaction messages

MeterValuesAlignedData Comma-separated list of R/W String Energy.Active.Import.


types of meter values Register
that should be sent as
clock aligned data
elements in separate
meter values messages.
Supported are 'Energy.
Active.Import.Register',
'Power.Active.Import' and
'Current.Import'.

MeterValuesSampledData Comma-separated list of R/W String Energy.Active.Import.


types of meter values Register
that should be sent as
sampled data elements
in separate meter value
messages. Supported
are 'Energy.Active.Import.
Register', 'Power.Active.
Import' and 'Current.
Import'.

SupportedFeatureProfiles A list of supported R String


Feature Profiles.
Possible profile
identifiers: Core,
FirmwareManagement,
LocalAuthListManagemen
t, Reservation,
SmartCharging and
RemoteTrigger.

ChargingScheduleAllowe A list of supported R String Current


dChargingRateUnit quantities for use in a
ChargingSchedule.

HeartBeatInterval(1 The interval in seconds R/W Int [10..3600] Def:240


with which OCPP
heartbeat messages are
sent to the backend
system. Modifying this
parameter may upset the
backend system (OCPP
1.5).
HeartbeatInterval(1 he interval in seconds R/W Int [10..3600] Def:240
with which OCPP
heartbeat messages are
sent to the backend
system. Modifying this
parameter may upset the
backend system (OCPP
1.6).

ConnectionTimeOut Interval (from successful R/W Int [10..300] Def:45


authorization) until
incipient charging
session is automatically
canceled due to failure of
EV user to (correctly)
insert the charging cable
connector(s) into the
appropriate connector(s).

NumberOfConnectors The number of physical R Int [0..254] Def:1


charging connectors of
this Charge Point.

GetConfigurationMaxKeys Maximum number of R Int [0..2000] Def:1


requested configuration
keys in a
GetConfiguration.req
PDU.

LocalAuthListMaxLength Maximum number of R Uint [0..1000000] Def:1000000


identifications that can be
stored in the Local
Authorization List

SendLocalListMaxLength Maximum number of R Uint [0..45000] Def:45000


identifications that can be
send in a single
SendLocalList.req

ConnectorPhaseRotation Maximum number of R Uint [1..255] Def:1


MaxLength items in a
ConnectorPhaseRotation
Configuration Key.

ChargeProfileMaxStackLe Max StackLevel of a R Uint [1..255] Def:255


vel ChargingProfile.

ChargingScheduleMaxPe Maximum number of R Uint [1..255] Def:255


riods periods that may be
defined per
ChargingSchedule.

MaxChargingProfilesInsta Maximum number of R Uint [1..255] Def:255


lled Charging profiles
installed at a time.

LocalAuthListEnabled Whether the Local R Enum (0)Off


Authorization List is (1)On
enabled Def:Off

AuthorizeRemoteTxRequ This parameter R/W Enum (0)Off


ests determines whether after (1)On
receiving an OCPP Def:On
RemoteStart request the
charger should still send
an OCPP Authorize
message to the backend
system. Some backends
require this as OCPP
could be interpreted to
require this. Some
backends are upset if this
is done
AllowOfflineTxForUnknow This parameter R/W Enum (0)Off
nId determines whether a (1)On
client is allowed to (2)
charge in case its ImmediatelyWhenPlugged
authorization cannot be
processed because the Def:Off
backend is offline or not
reachable. If set to ON,
the client is allowed to
charge even if it cannot
get authenticated from
the white list nor from
local cache.

LocalAuthorizeOffline Whether the Charge R/W Enum (0)Off


Point, when offline, will (1)On
start a transaction for Def:On
locally authorized
identifiers

AuthorizationCacheEnabl Parameter that enables R/W Enum (0)Off


ed the use of the internal (1)On
cache of RFID UID. If Def:On
disabled, RFIDs even if
reported from the
backend with an expiry
date are not added to an
internal cache.

LocalPreAuthorize Whether the Charge R/W Enum (0)Off


Point, when online, will (1)On
start a transaction for Def:On
locally authorized
identifiers without
requesting an Authorize.
conf from the Central
System

StopTransactionOnEVSid When set to true, the R Enum (0)Off


eDisconnect Charge Point SHALL (1)On
administratively stop the Def:On
transaction when the
cable is unplugged from
the EV.

UnlockConnectorOnEVSi When set to true, the R Enum (0)Off


deDisconnect Charge Point SHALL (1)On
unlock the cable on Def:On
Charge Point side when
the cable is unplugged at
the EV.

ReserveConnectorZeroSu If this configuration key is R Enum (0)Off


pported present and set to true: (1)On
Charge Point support Def:On
reservations on
connector 0.

ConnectorSwitch3to1Pha If defined and true, this R Enum (0)Off


seSupported Charge Point support (1)On
switching from 3 to 1 Def:Off
phase during a charging
session.

1. Although these two parameter names look alike, there is a slight difference in their appearance (one upper case 'L' versus one lower
case 'l').
Ensto charger specific OCPP configuration keys
Note that only most commonly used keys are documented here.

Key name Description Accessibility Type Range, Default or


example

RfidTagFreeCharging Rfid Tag for Free R/W String


Charging with OCPP
Full, fixed rfid modes

FreeChargingMode This allows to set the R/W Enum (0)No OCPP


OCPP behavior in free (1)With OCPP status
charging mode. Note that notif without auth
in case of master slave (2)With OCPP status
scenario the slave will be notif with auth
automatically configured (3)With OCPP Full fixed
to the same mode the Rfid with auth
master uses (4)With OCPP Full fixed
Rfid without auth
(5)With OCPP Full any
Rfid
Def:No OCPP

FreeCharging This mode allows R/W Enum (0)Off


charging without (1)On
authorization via RFID or Def:Off
the backend. Charging is
started immediately after
a vehicle is connected.

Dynamic Load Management available settings

For instruction how to use settings, please visit Ensto EV Wiki.

Key Name Master-Slave Scope Description Accessibility Type Range, Default or


example

DlmState Individual DLM State R String

DlmMasterIp Individual DLM Master IP R/W String


which is used for
DLM-Slaves
configured with
Master-Fixed-IP.
Additionally the
connection port can
be specified (IP[:
port]).

DlmInput1CurrOffset Master Offset added to R/W Int [-1000..0] Def:0


Phase1 'EVSE Sub-
Distribution Limit'
DlmInput1CurrOffset Master case external input 1 R/W Int [-1000..0] Def:0
Phase2 is high. Note:
currently only
DlmInput1CurrOffset Master negative values are R/W Int [-1000..0] Def:0
Phase3 supported

DlmInput2CurrOffset Master Offset added to R/W Int [-1000..0] Def:0


Phase1 'EVSE Sub-
Distribution Limit' in
DlmInput2CurrOffset Master case external input 2 R/W Int [-1000..0] Def:0
Phase2 is high. Note:
currently only
DlmInput2CurrOffset Master negative values are R/W Int [-1000..0] Def:0
Phase3 supported

DlmPhase1Limit Master R/W Uint [0..1000] Def:16


Overall current limit
DlmPhase2Limit Master R/W Uint [0..1000] Def:16
for DLM available for
DlmPhase3Limit Master distribution to EVs R/W Uint [0..1000] Def:16

DlmOperatorPhase1 Master Operator current R/W Uint [0..1000] Def:16


Limit limit for DLM
available for
DlmOperatorPhase2 Master distribution to EVs. R/W Uint [0..1000] Def:16
Limit The 'Operator EVSE
Sub-Distribution
DlmOperatorPhase3 Master Limit ' is equal or R/W Uint [0..1000] Def:16
Limit smaller than the
'EVSE Sub-
Distribution Limit'. It
can be changed
without rebooting
the chargepoint.
Thus, a backend
could use this
parameter to alter
the energy available
for charging EVs
dynamically. The
backend will not be
able to set a value
higher than the
'EVSE Sub-
Distribution Limit'

DlmExtMeterMainDis Master Current limit for DLM R/W Uint [0..10000] Def:100
tributionLimitPhase1 available for
distribution to EVs
DlmExtMeterMainDis Master and additional R/W Uint [0..10000] Def:100
tributionLimitPhase2 energy loads. This
value is typically
DlmExtMeterMainDis Master higher than the R/W Uint [0..10000] Def:100
tributionLimitPhase3 'EVSE Sub-
Distribution Limit'
above. An external
meter is required to
detect the energy
consumption of the
additional load

DlmExtMeterDisconn Master In the error case, R/W Uint [0..10000] Def:9999


ectedFallbackPhase1 where the external
meter is
DlmExtMeterDisconn Master disconnected or R/W Uint [0..10000] Def:9999
ectedFallbackPhase2 fails, 'External Meter
Disconnected
DlmExtMeterDisconn Master Fallback' is assumed R/W Uint [0..10000] Def:9999
ectedFallbackPhase3 as external meter
value. Set to a high
value (like the 'Main
Distribution Limit' or
higher) will result in
no current available
for the EVSE sub-
distribution in that
particular situation.
Thus, charging
would stop

DlmDisconnectedLim Individual Current limit when R/W Uint [0..1000] Def:6


it disconnected from
DLM network

DlmMinCurrentRating Individual Minimum current R/W Uint [0..1000] Def:6


limit that charging
should not go below
DlmDiscoveryNetwor Individual Several DLM R/W Uint [0..255] Def:0
kId groupings might
coexist in one
physical LAN. In
case of DLM Master-
Auto-Discovery, they
are distinguished by
Master-Auto-
Discovery Network Id

DlmMode Individual Specifies the R/W Enum (0)Disabled


ChargePoint's role in (1)DLM Master (With
a DLM network. internal DLM-Slave)
There MUST be (2)DLM Master
exactly one DLM (Standalone)
Master in a DLM (3)DLM Slave
network managing (Master-Auto-
multiple DLM- Discovery)
Slaves. Typically, a (4)DLM Slave
ChargePoint (Master-Fixed-IP)
configured as DLM Def:Disabled
Master will also host
an internal DLM-
Slave. Note: A
ChargePoint
configured as
standalone DLM
Master will not host
an internal DLM-
Slave. If used for
charging anyway, its
power consumption
will be not controlled
by DLM!

DlmAlgo Master Dynamic Load R/W Enum (0)Fair Trade (FIFO)


Management Def:Fair Trade
Algorithm to be used (FIFO)
on the DLM Master
for load
balancing;'Fair
Trade (FIFO)'
selects a fair
distribution algorithm
which works in a
first-in-first-out
manner. In case
there is no energy
remaining to
distribute, the car
has to wait for a free
slot.

DlmExtMeterEnabled Master If enabled, an R/W Enum (0)Off


external, secondary (1)On
meter allows to also Def:Off
consider the power
consumption of
additional load. The
power available for
charging EVs will be
adjusted
accordingly. Please
make sure, 'Meter
configuration
(Second)' is
configured,
preferably to a 3-
phase, phase aware
meter
DlmExtMeterLocation Master Specifies, how the R/W Enum (0)Including EVSE
external meter is Sub-Distribution
connected: in case (1)Excluding EVSE
the external meter Sub-Distribution
measures the Def:Including EVSE
energy of Sub-Distribution
chargepoints and
additional consumer
altogether, the value
shall be set to
'Including EVSE Sub-
Distribution',
otherwise to
'Excluding EVSE
Sub-Distribution'

DlmRecalcInterval Master The DLM algorithm R/W Enum (0)2 sec


will not calculate and (1)5 sec
re-assign current to (2)15 sec
it's DLM slaves any (3)30 sec
faster than at this (4)1 min
configured rate. As (5)10 min
an exception, EVs (6)15 min
getting ready to Def:30 sec
charge will be
considered and
assigned current
immedeately.
Between algorithm
calculation times
external meter
values will be
averaged.

DlmInput1CurrOffset Master Adds a configurable R/W Enum (0)DISABLE


Cfg offset to 'EVSE Sub- (1)ENABLE OPTO 1
Distribution Limit' (2)ENABLE OPTO 2
based on GPI Def:DISABLE
External Input 1

DlmInput2CurrOffset Master Adds a configurable R/W Enum (0)DISABLE


Cfg offset to 'EVSE Sub- (1)ENABLE OPTO 1
Distribution Limit' (2)ENABLE OPTO 2
based on GPI Def:DISABLE
External Input 2

You might also like