OCPP Configuration Settings
This page explains the OCPP configuration settings that are available on the Evnex E&X Series charging station.
OCPP configuration values
The following values are available to be read and written via the Evnex dashboard (via the OCPP GetConfiguration and SetConfiguration call).
Configuration keys listed under 'Core Profile' and 'Smart Charging Profile' are standardised by the OCPP specification. Keys listed under 'Custom' are specific to the Evnex E&X Series charging stations.
Please take care when changing these values - incorrect settings can render charging stations inoperative or unable to connect to the network.
Core profile
Key name | Accessibility | Type | Default value | Reboot required | Description |
---|---|---|---|---|---|
AllowOfflineTxForUnknownId | Read & write | Boolean | 1 | N/A | When set to true, Unknown Offline Authorization is enabled |
AuthorizeRemoteTxRequests | Read & write | Boolean | 1 | N/A | When set to true, a remote request to start a transaction in the form of a RemoteStartTransaction.req message will be authorized beforehand like a local action to start a transaction |
ClockAlignedDataInterval | Read & write | Integer | 0 | N/A | Size (in seconds) of the clock-aligned data interval, a value of "0" is to be interpreted to mean that no clock-aligned data should be transmitted |
ConnectionTimeOut | Read & write | Integer | 120 | N/A | Interval (from successful authorization) until the charging session is automatically canceled due to failure of EV user to (correctly) insert the charging cable connector(s) into the appropriate connector(s) |
GetConfigurationMaxKeys | Read only | Integer | 10 | N/A | The maximum number of configuration keys that can be requested in a GetConfiguration.req PDU |
HeartbeatInterval | Read & write | Integer | 43,200 | N/A | The interval of inactivity in seconds (no OCPP exchanges) with central system after which the Charge Point should send a Heartbeat.req PDU |
LocalAuthorizeOffline | Read & write | Boolean | 1 | N/A | If true, the Charge Point, when offline, will start a transaction for locally authorized identifiers |
LocalPreAuthorize | Read & write | Boolean | 0 | N/A | If true, the Charge Point, when online, will start a transaction for locally authorized identifiers without waiting for or requesting an Authorize.conf from the Central System |
MeterValuesAlignedData | Read & write | CSL | N/A | The clock-aligned measurand(s) to be included in a MeterValues.req PDU, every ClockAlignedDataInterval seconds - not currently supported | |
MeterValuesAlignedDataMaxLength | Read only | Integer | 0 | N/A | The maximum number of items in a MeterValuesAlignedData Configuration Key - not currently supported |
MeterValuesSampledData | Read & write | CSL | Voltage,Power.Active.Import,Energy.Active.Import.Register, Current.Import,Frequency | N/A | The sampled measurands to be included in a MeterValues.req PDU, every MeterValueSampleInterval seconds |
MeterValuesSampledDataMaxLength | Read only | Integer | 5 | N/A | The maximum number of items in a MeterValuesSampledData Configuration Key |
MeterValueSampleInterval | Read & write | Integer | 300 | N/A | The interval (seconds) between sampling of metering (or other) data, intended to be transmitted by "MeterValues" PDUs |
NumberOfConnectors | Read only | Integer | 1 | N/A | The number of physical charging connectors of this Charge Point |
ResetRetries | Read & write | Integer | 0 | N/A | Number of times to retry an unsuccessful reset of the Charge Point |
ConnectorPhaseRotation | Read & write | CSL | NotApplicable | N/A | The phase rotation per connector in respect to the connector’s energy meter |
ConnectorPhaseRotationMaxLength | Read only | Integer | 0 | N/A | The maximum number of items in a ConnectorPhaseRotation Configuration Key |
StopTransactionOnEVSideDisconnect | Read & write | Boolean | 1 | N/A | When set to true, the Charge Point will administratively stop the transaction when the cable is unplugged from the EV |
StopTransactionOnInvalidId | Read & write | Boolean | 1 | N/A | When set to true, the Charge Point will stop an ongoing transaction when it receives a non- Accepted authorization status in a StartTransaction.conf for this transaction |
StopTxnAlignedData | Read & write | CSL | N/A | The clock-aligned periodic measurand(s) to be included in the TransactionData element of StopTransaction.req MeterValues.req PDU for every ClockAlignedDataInterval of the charging session | |
StopTxnAlignedDataMaxLength | Read only | Integer | 0 | N/A | The maximum number of items in a StopTxnAlignedData Configuration Key |
StopTxnSampledData | Read & write | CSL | N/A | The sampled measurands to be included in the TransactionData element of StopTransaction.req PDU, every MeterValueSampleInterval seconds from the start of the charging session | |
StopTxnSampledDataMaxLength | Read only | Integer | 0 | N/A | The maximum number of items in a StopTxnSampledData Configuration Key |
SupportedFeatureProfiles | Read only | CSL | Core,FirmwareManagement,SmartCharging | N/A | A list of supported Feature Profiles |
TransactionMessageAttempts | Read & write | Integer | 3 | N/A | How often the Charge Point should try to submit a transaction-related message when the Central System fails to process it |
TransactionMessageRetryInterval | Read & write | Integer | 15 | N/A | How long (in seconds) the Charge Point should wait before resubmitting a transaction related message that the Central System failed to process |
UnlockConnectorOnEVSideDisconnect | Read & write | Boolean | 1 | N/A | When set to true, the Charge Point will unlock the cable on the Charge Point side when the cable is unplugged at the EV |
WebSocketPingInterval | Read & write | Integer | N/A | N/A | When set to 0 client side websocket Ping/Pong is disabled, positive values are interpreted as number of seconds between pings |
SupportedFileTransferProtocols | Read only | CSL | HTTP,HTTPS | N/A | The supported protocols for diagnostics file transfer |
Smart charging profile
Key name | Accessibility | Type | Default value | Reboot required | Description |
---|---|---|---|---|---|
ChargeProfileMaxStackLevel | Read only | Integer | 2 | N/A | The number indicates the max allowed number of installed charging schedules |
ChargingScheduleAllowedChargingRateUnit | Read only | CSL | Current | N/A | The supported quantities for use in a ChargingSchedule |
ChargingScheduleMaxPeriods | Read only | Integer | 24 | N/A | Maximum number of periods that may be defined per ChargingSchedule |
MaxChargingProfilesInstalled | Read only | Integer | 9 | N/A | The maximum number of charging profiles that can be installed at a time |
Custom - Evnex Specific Config Settings
Key name | Accessibility | Type | Default value | Reboot required | Description |
---|---|---|---|---|---|
ChargePointIdentity | Read & write | String | N/A | Yes | Used as the Charge Point Identity in the path used during websocket connection. Also used as the user name for HTTP basic authorisation. |
APN | Read & write | String | m2m | Yes | The APN used for connection to the cellular network |
MNO | Read & write | Integer | 0 | Yes | The LTE M1 MNO (Mobile Network Operator) setting for connection to the cellular network 0 - Spark LTE M1 NZ (LTE Cat M1 only, bands 3 and 28) 1 - Default 2 - AT&T 3 - Verizon 4 - Telstra 5 - T-Mobile USA 6 - China Telecom 7 - Sprint 8 - Vodafone 9 - Telus 10 - Deutsche Telecom 11 - Standard Europe |
OCPPEndPoint | Read & write | String | wss://ocpp.evnex.io | Yes | The OCPP connection URL |
OCPPPort | Read & write | Integer | 443 | Yes | The port used for connection to the OCPP URL |
MaxWireCurrent | Read only | Integer | N/A | N/A | Displays the maximum wire current as currently set on the internal DIP switch |
BluetoothPassword | Read & write | String | N/A | Yes | The password required for the Evnex installation app to connect to the device |
LockCableUntilFinished | Read & write | Boolean | false | Yes | If enabled, the charge point will keep the cable locked into the connector until the charging session has been ended (e.g. by RFID or OCPI) |
AuthorisationEnabled | Read & write | Boolean | false | Yes | If disabled, the charge point will automatically start charging without sending an 'Authorize' message |
RFIDTagReaderEnabled | Read & write | Integer | 0 | Yes | If set to 0, the RFID reader is disabled |
AuthorizationKey | Read & write | String | N/A | Yes | The OCPP authorization key |
WifiSSID | Read & write | String | N/A | Yes | The Wi-Fi SSID to connect to |
WifiPassphrase | Read & write | String | N/A | Yes | The Wi-Fi password to use |
Custom - Evnex Specific Factory Settings
Key name | Accessibility | Type | Default value | Description |
---|---|---|---|---|
SerialNumber | Read only | String | N/A | The charge point serial number |
Vendor | Read only | String | Evnex | The charge point vendor (Evnex) |
Model | Read only | String | N/A | The charge point model |
UseProximityPin | Read only | Integer | 1 | Set to 1 for socket outlet charge points |
CableLockControlMode | Read only | Integer | ||
CableLockSensorMode | Read only | Integer | ||
EnergyMeterOption | Read only | Integer | The configuration setting for the energy meter installed in the charge point | |
RCMOption | Read only | Integer | 1 | 0 for no RCM installed, 1 for RCM installed |
Updated 5 months ago