GetConfiguration

Core CSMS->CP

Sent by the Central System to retrieve configuration parameters from the Charge Point.

Quick Reference

Optional Fields

key array

List of specific keys to retrieve (omit for all)

Example Payload

{
  "key": [
    "HeartbeatInterval",
    "MeterValueSampleInterval"
  ]
}

Example Full Frame

[
  2,
  "msg-001",
  "GetConfiguration",
  {
    "key": [
      "HeartbeatInterval",
      "MeterValueSampleInterval"
    ]
  }
]

Format: [MessageType, MessageId, Action, Payload]

Open in Builder Go to Validator

Overview

The GetConfiguration command retrieves configuration parameters from the Charge Point. Essential for discovering available settings before modification.

When to Send

  • During initial CP commissioning
  • Before ChangeConfiguration to verify keys
  • For diagnostics and troubleshooting
  • To audit CP settings

Expected Response

The CP responds with:

  • configurationKey: Array of key/value pairs with readonly flag
  • unknownKey: Array of requested keys that don’t exist (if any)

Response Format

{
  "configurationKey": [
    {
      "key": "HeartbeatInterval",
      "readonly": false,
      "value": "300"
    }
  ],
  "unknownKey": ["NonExistentKey"]
}

Usage Notes

  • Omit key parameter to get all configuration parameters
  • Include specific keys to get subset of parameters
  • Response includes readonly flag indicating if key is writable
  • Unknown keys are listed separately in response

Best Practices

  1. Get all on commissioning - Retrieve full config during setup
  2. Check before change - Use GetConfiguration before ChangeConfiguration
  3. Cache configuration - Store config locally to reduce queries
  4. Document settings - Maintain inventory of CP configurations
  5. Filter requests - Request only needed keys to reduce payload size

Common Configuration Keys

  • AllowOfflineTxForUnknownId: Allow offline transactions
  • AuthorizationCacheEnabled: Enable authorization cache
  • AuthorizeRemoteTxRequests: Require authorization for remote starts
  • ClockAlignedDataInterval: Clock-aligned sampling interval
  • ConnectionTimeOut: WebSocket timeout
  • HeartbeatInterval: Heartbeat frequency
  • LocalAuthorizeOffline: Allow offline authorization
  • MeterValueSampleInterval: Meter sampling interval
  • NumberOfConnectors: Total connectors (readonly)
  • ResetRetries: Reset retry attempts
  • StopTransactionOnEVSideDisconnect: Auto-stop on cable disconnect
  • TransactionMessageAttempts: Transaction message retry count

Testing Tips

  • Test without key parameter (get all)
  • Test with specific keys
  • Test with non-existent keys
  • Verify readonly flags in response
  • Test with empty key array

Common Errors

NotSupported

Cause: Configuration feature disabled

Solution: Enable configuration management on CP

Related Actions

ChangeConfiguration