MicroOcpp
MicroOcpp copied to clipboard
matth-x
Missing documentation about OCPP configuration keys
Hi,
I was looking for the listing of all supported configuration keys and how to use them but didn't find it, except in the code:
| Key | Default value | Readonly | Reboot required | Accessible | Source | Documentation |
|---|---|---|---|---|---|---|
| AllowOfflineTxForUnknownId | false | false | false | true | OCPP | Specification |
| AuthorizeRemoteTxRequests | false | false | false | true | OCPP | Specification |
| AuthorizationCacheEnabled | OCPP (missing-optional) | Specification | ||||
| BlinkRepeat | OCPP (missing-optional) | Specification | ||||
| BUILD_NUMBER | <> | false | false | false | CUSTOM | TBD |
| CertificateSignedMaxChain | OCPP (missing) | Specification Security profile | ||||
| CertificateStoreMaxLength | OCPP (missing) | Specification Security profile | ||||
| ChargeProfileMaxStackLevel | MO_ChargeProfileMaxStackLevel | true | false | true | OCPP | Specification |
| ChargingScheduleAllowedChargingRateUnit | "" | true | false | true | OCPP | Specification |
| ChargingScheduleMaxPeriods | MO_ChargingScheduleMaxPeriods | true | false | true | OCPP | Specification |
| ClockAlignedDataInterval | 0 | false | false | true | OCPP | Specification |
| ConnectionTimeOut | 30 | false | false | true | OCPP | Specification |
| ConnectorPhaseRotation | OCPP (missing-required) | Specification | ||||
| ConnectorPhaseRotationMaxLength | OCPP (missing-optional) | Specification | ||||
| ConnectorSwitch3to1PhaseSupported | OCPP (missing-optional) | Specification | ||||
| CpoName | OCPP (missing) | Specification Security profile | ||||
| GetConfigurationMaxKeys | 30 | true | false | true | OCPP | Specification |
| HeartbeatInterval | 86400 | false | false | true | OCPP | Specification |
| LightIntensity | OCPP (missing-optional) | Specification | ||||
| LocalAuthListEnabled | true | false | false | true | OCPP | Specification |
| LocalAuthListMaxLength | MO_LocalAuthListMaxLength | false | false | true | OCPP | Specification |
| LocalAuthorizeOffline | true | false | false | true | OCPP | Specification |
| LocalPreAuthorize | false | false | false | true | OCPP | Specification |
| MaxChargingProfilesInstalled | MO_MaxChargingProfilesInstalled | true | false | true | OCPP | Specification |
| MaxEnergyOnInvalidId | OCPP (missing-optional) | Specification | ||||
| MeterValueSampleInterval | 60 | false | false | true | OCPP | Specification |
| MeterValuesAlignedData | "" | false | false | true | OCPP | Specification |
| MeterValuesAlignedDataMaxLength | 8 | true | false | true | OCPP | Specification |
| MeterValuesSampledData | "" | false | false | true | OCPP | Specification |
| MeterValuesSampledDataMaxLength | 8 | true | false | true | OCPP | Specification |
| MinimumStatusDuration | 0 | false | false | true | OCPP | Specification |
| NumberOfConnectors | numConn >= 1 ? numConn - 1 : 0 | true | false | true | OCPP | Specification |
| ReserveConnectorZeroSupported | true | false | false | true | OCPP | Specification |
| ResetRetries | 2 | false | false | true | OCPP | Specification |
| SecurityProfile | OCPP (missing) | Specification Security profile | ||||
| SendLocalListMaxLength | MO_SendLocalListMaxLength | true | false | true | OCPP | Specification |
| StopTransactionOnEVSideDisconnect | true | false | false | true | OCPP | Specification |
| StopTransactionOnInvalidId | true | false | false | true | OCPP | Specification |
| StopTxnAlignedData | "" | false | false | true | OCPP | Specification |
| StopTxnAlignedDataMaxLength | OCPP (missing-optional) | Specification | ||||
| StopTxnSampledData | "" | false | false | true | OCPP | Specification |
| StopTxnSampledDataMaxLength | 8 | true | false | true | OCPP | Specification |
| SupportedFeatureProfiles | "" | true | false | true | OCPP | Specification |
| SupportedFeatureProfilesMaxLength | OCPP (missing-optional) | Specification | ||||
| SupportedFileTransferProtocols | OCPP (missing) | Specification | ||||
| TransactionMessageAttempts | 3 | false | false | true | OCPP | Specification |
| TransactionMessageRetryInterval | 60 | false | false | true | OCPP | Specification |
| UnlockConnectorOnEVSideDisconnect | true if MO_ENABLE_CONNECTOR_LOCK | false if MO_ENABLE_CONNECTOR_LOCK | false | true | OCPP | Specification |
| MO_CONFIG_EXT_PREFIX AVAIL_CONN_%d | true | false | false | false | CUSTOM | TBD |
| MO_CONFIG_EXT_PREFIX AuthorizationTimeout | 20 | false | false | true | CUSTOM | TBD |
| MO_CONFIG_EXT_PREFIX FreeVendActive | false | false | false | true | CUSTOM | TBD |
| MO_CONFIG_EXT_PREFIX FreeVendIdTag | "" | false | false | true | CUSTOM | TBD |
| MO_CONFIG_EXT_PREFIX MeterValuesInTxOnly | true | false | false | true | CUSTOM | TBD |
| MO_CONFIG_EXT_PREFIX PreBootTransactions | false | false | false | true | CUSTOM | TBD |
| MO_CONFIG_EXT_PREFIX SilentOfflineTransactions | false | false | false | true | CUSTOM | TBD |
| MO_CONFIG_EXT_PREFIX StopTxnDataCapturePeriodic | false | false | false | true | CUSTOM | TBD |
| MO_CONFIG_EXT_PREFIX TxStartOnPowerPathClosed | false | false | false | true | CUSTOM | TBD |
| MO_RESERVATION_CID_KEY %u | -1 | false | false | false | CUSTOM | TBD |
| MO_RESERVATION_EXPDATE_KEY %u | "" | false | false | false | CUSTOM | TBD |
| MO_RESERVATION_IDTAG_KEY %u | "" | false | false | false | CUSTOM | TBD |
| MO_RESERVATION_PARENTID_KEY %u | "" | false | false | false | CUSTOM | TBD |
| MO_RESERVATION_RESID_KEY %u | -1 | false | false | false | CUSTOM | TBD |
| AuthorizationKey | true | true | false | OCPP (mongoose) | Specification OCPPJ only | |
| WebSocketPingInterval | 5 | false | false | true | OCPP (mongoose) | Specification OCPPJ only |
| MO_CONFIG_EXT_PREFIX BackendUrl | true | true | false | CUSTOM (mongoose) | TBD | |
| MO_CONFIG_EXT_PREFIX ChargeBoxId | true | true | false | CUSTOM (mongoose) | TBD | |
| MO_CONFIG_EXT_PREFIX ReconnectInterval | 10 | false | false | true | CUSTOM (mongoose) | TBD |
| MO_CONFIG_EXT_PREFIX StaleTimeout | 300 | false | false | true | CUSTOM (mongoose) | TBD |
OCPP keys are described into the specification. I added OCPP keys that are not yet implemented (most of them are optional).
Maybe an explaination about the missing OCPP keys and a description about the CUSTOM keys should be added and updated in the documentation after each release?
