OCPP Connection

warp1

Not supported on this hardware!

warp2

ocpp/config

OCPP connection configuration

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Read

curl http://$HOST/ocpp/config

{
  "enable_ocpp": false,
  "url": "",
  "identity": "WARP-AAA",
  // Not returned
  "pass": null,
  "cs_0": null,
  "cs_1": null,
  "cs_2": null,
  "cs_3": null,
  "cs_4": null,
  "cfg0": null,
  "cfg1": null,
  "cfg2": null,
  "cfg3": null
}

Write

curl http://$HOST/ocpp/config -d '{
  "enable": true,
  "url": "wss://10.0.3.5:8180/steve/websocket/CentralSystemService",
  "identity": "warp2-AbCd",
  "enable_auth": true,
  "pass": "mypassword",
  "cert_id": -1
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ocpp/config

{
  "enable_ocpp": false,
  "url": "",
  "identity": "WARP-AAA",
  // Not returned
  "pass": null,
  "cs_0": null,
  "cs_1": null,
  "cs_2": null,
  "cs_3": null,
  "cs_4": null,
  "cfg0": null,
  "cfg1": null,
  "cfg2": null,
  "cfg3": null
}

Write

With MQTT on $PREFIX/ocpp/config_update

mosquitto_pub -h $BROKER -t $PREFIX/ocpp/config_update -m '{
  "enable": true,
  "url": "wss://10.0.3.5:8180/steve/websocket/CentralSystemService",
  "identity": "warp2-AbCd",
  "enable_auth": true,
  "pass": "mypassword",
  "cert_id": -1
}'

Name	Description
enable bool	Indicates whether a connection to the configured OCPP server should be established. For control functionality in addition to state readout, evse/ocpp_enabled must also be true.
url string	Endpoint URL of the OCPP server. Must start with the scheme ws:// (unencrypted!) or wss:// (TLS-encrypted) and must not end with /.
identity string	Identity of the charger. Appended to the endpoint URL and used as username for authorization
enable_auth bool	Indicates that authorization via HTTP Basic Auth should be performed.
pass string	HTTP Basic Auth password. If the password is exactly 40 characters long and consists only of hex characters (0-9, A-F, a-f), it is treated as a hexadecimal representation of a 20-byte authorization key.
cert_id int	ID of the TLS certificate to be used for establishing a TLS-encrypted connection. -1 - Use embedded certificate bundle >= 0 - Use certificate with this ID

ocpp/reset

Resets the OCPP state. Unsent transaction data will be lost! Empty payload. One of the following values must be passed: null, "", false, 0, [] or {}

Example

HTTP (curl)

# $HOST e.g. warp2-AbCd

Write

curl http://$HOST/ocpp/reset -d 'null'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/ocpp/reset -m 'null'

warp3

ocpp/config

OCPP connection configuration

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Read

curl http://$HOST/ocpp/config

{
  "enable_ocpp": false,
  "url": "",
  "identity": "WARP-AAA",
  // Not returned
  "pass": null,
  "cs_0": null,
  "cs_1": null,
  "cs_2": null,
  "cs_3": null,
  "cs_4": null,
  "cfg0": null,
  "cfg1": null,
  "cfg2": null,
  "cfg3": null
}

Write

curl http://$HOST/ocpp/config -d '{
  "enable": true,
  "url": "wss://10.0.3.5:8180/steve/websocket/CentralSystemService",
  "identity": "warp3-AbCd",
  "enable_auth": true,
  "pass": "mypassword",
  "cert_id": -1
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ocpp/config

{
  "enable_ocpp": false,
  "url": "",
  "identity": "WARP-AAA",
  // Not returned
  "pass": null,
  "cs_0": null,
  "cs_1": null,
  "cs_2": null,
  "cs_3": null,
  "cs_4": null,
  "cfg0": null,
  "cfg1": null,
  "cfg2": null,
  "cfg3": null
}

Write

With MQTT on $PREFIX/ocpp/config_update

mosquitto_pub -h $BROKER -t $PREFIX/ocpp/config_update -m '{
  "enable": true,
  "url": "wss://10.0.3.5:8180/steve/websocket/CentralSystemService",
  "identity": "warp3-AbCd",
  "enable_auth": true,
  "pass": "mypassword",
  "cert_id": -1
}'

Name	Description
enable bool	Indicates whether a connection to the configured OCPP server should be established. For control functionality in addition to state readout, evse/ocpp_enabled must also be true.
url string	Endpoint URL of the OCPP server. Must start with the scheme ws:// (unencrypted!) or wss:// (TLS-encrypted) and must not end with /.
identity string	Identity of the charger. Appended to the endpoint URL and used as username for authorization
enable_auth bool	Indicates that authorization via HTTP Basic Auth should be performed.
pass string	HTTP Basic Auth password. If the password is exactly 40 characters long and consists only of hex characters (0-9, A-F, a-f), it is treated as a hexadecimal representation of a 20-byte authorization key.
cert_id int	ID of the TLS certificate to be used for establishing a TLS-encrypted connection. -1 - Use embedded certificate bundle >= 0 - Use certificate with this ID

ocpp/reset

Resets the OCPP state. Unsent transaction data will be lost! Empty payload. One of the following values must be passed: null, "", false, 0, [] or {}

Example

HTTP (curl)

# $HOST e.g. warp3-AbCd

Write

curl http://$HOST/ocpp/reset -d 'null'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/ocpp/reset -m 'null'

wem

Not supported on this hardware!

wem2

Not supported on this hardware!

any

ocpp/config

OCPP connection configuration

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Read

curl http://$HOST/ocpp/config

{
  "enable_ocpp": false,
  "url": "",
  "identity": "WARP-AAA",
  // Not returned
  "pass": null,
  "cfg0": null,
  "cfg1": null,
  "cfg2": null,
  "cfg3": null
}

Write

curl http://$HOST/ocpp/config -d '{
  "enable": true,
  "url": "wss://10.0.3.5:8180/steve/websocket/CentralSystemService",
  "identity": "warp-AbCd",
  "enable_auth": true,
  "pass": "mypassword",
  "cert_id": -1
}'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Read

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/ocpp/config

{
  "enable_ocpp": false,
  "url": "",
  "identity": "WARP-AAA",
  // Not returned
  "pass": null,
  "cfg0": null,
  "cfg1": null,
  "cfg2": null,
  "cfg3": null
}

Write

With MQTT on $PREFIX/ocpp/config_update

mosquitto_pub -h $BROKER -t $PREFIX/ocpp/config_update -m '{
  "enable": true,
  "url": "wss://10.0.3.5:8180/steve/websocket/CentralSystemService",
  "identity": "warp-AbCd",
  "enable_auth": true,
  "pass": "mypassword",
  "cert_id": -1
}'

Name	Description
enable bool	Indicates whether a connection to the configured OCPP server should be established. For control functionality in addition to state readout, evse/ocpp_enabled must also be true.
url string	Endpoint URL of the OCPP server. Must start with the scheme ws:// (unencrypted!) or wss:// (TLS-encrypted) and must not end with /.
identity string	Identity of the charger. Appended to the endpoint URL and used as username for authorization
enable_auth bool	Indicates that authorization via HTTP Basic Auth should be performed.
pass string	HTTP Basic Auth password. If the password is exactly 40 characters long and consists only of hex characters (0-9, A-F, a-f), it is treated as a hexadecimal representation of a 20-byte authorization key.
cert_id int	ID of the TLS certificate to be used for establishing a TLS-encrypted connection. -1 - Use embedded certificate bundle >= 0 - Use certificate with this ID

ocpp/reset

Resets the OCPP state. Unsent transaction data will be lost! Empty payload. One of the following values must be passed: null, "", false, 0, [] or {}

Example

HTTP (curl)

# $HOST e.g. warp-AbCd

Write

curl http://$HOST/ocpp/reset -d 'null'

MQTT (mosquitto)

# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd

Write

mosquitto_pub -h $BROKER -t $PREFIX/ocpp/reset -m 'null'