Charge Time and Energy Limits
The charge_limits module allows defining energy and time limits after which a charging session is terminated. Both default limits can be set (charge_limits/default_limits), as well as overriding limits for the current or next charging session (charge_limits/override_duration and charge_limits/override_energy)
charge_limits/state
Current state of time and energy limits
{
"start_timestamp_ms": 786598059,
"start_energy_kwh": 886.1900024,
"target_timestamp_ms": 797398059,
"target_energy_kwh": 901.1900024
}
| Name | Description |
|---|---|
start_timestamp_msint (ms) | Start timestamp of the current charging session. 0 if no charging session is running. |
target_timestamp_msint (ms) | Target timestamp of the current charging session. 0 if no charging session is running. Equal to the start timestamp if no time limit is set. |
start_energy_kwhfloat (kWh) | Start meter value of the current charging session. null if no charging session is running or no electricity meter is available. |
target_energy_kwhfloat (kWh) | Target meter value of the current charging session. null if no charging session is running or no electricity meter is available. Equal to the start meter value if no energy value is set. |
charge_limits/default_limits
Configuration of time and energy limits for charging sessions.
# $HOST e.g. warp-AbCd
Read
curl http://$HOST/charge_limits/default_limits
{ "duration": 8, "energy_wh": 50000 }
Write
curl http://$HOST/charge_limits/default_limits -d '{ "duration": 8, "energy_wh": 50000 }'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd
Read
mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/charge_limits/default_limits
{ "duration": 8, "energy_wh": 50000 }
Write
With MQTT on $PREFIX/charge_limits/default_limits_update
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/default_limits_update -m '{ "duration": 8, "energy_wh": 50000 }'
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/active_limits
Active time and energy limits for the current or next charging session. Can be updated via charge_limits/override_duration and charge_limits/override_energy.
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/override_duration
Overrides the time limit for the current or next charging session.
# $HOST e.g. warp-AbCd
Write
curl http://$HOST/charge_limits/override_duration -d '{ "duration": 12 }'
or abbreviated:
curl http://$HOST/charge_limits/override_duration -d '12'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd
Write
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_duration -m '{ "duration": 12 }'
or abbreviated:
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_duration -m '12'
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
charge_limits/override_energy
Overrides the energy limit for the current or next charging session.
# $HOST e.g. warp-AbCd
Write
curl http://$HOST/charge_limits/override_energy -d '{ "energy_wh": 25000 }'
or abbreviated:
curl http://$HOST/charge_limits/override_energy -d '25000'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd
Write
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_energy -m '{ "energy_wh": 25000 }'
or abbreviated:
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_energy -m '25000'
| Name | Description |
|---|---|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/restart
Resets the charge limits as if a new charging session had started, but keeps the overridden charge limits. With this API and charge_limits/override_duration and charge_limits/override_energy, a new "absolute" charge limit can be set at any time.
Empty payload. One of the following values must be passed: null, "", false, 0, [] or {}
charge_limits/state
Current state of time and energy limits
{
"start_timestamp_ms": 786598059,
"start_energy_kwh": 886.1900024,
"target_timestamp_ms": 797398059,
"target_energy_kwh": 901.1900024
}
| Name | Description |
|---|---|
start_timestamp_msint (ms) | Start timestamp of the current charging session. 0 if no charging session is running. |
target_timestamp_msint (ms) | Target timestamp of the current charging session. 0 if no charging session is running. Equal to the start timestamp if no time limit is set. |
start_energy_kwhfloat (kWh) | Start meter value of the current charging session. null if no charging session is running or no electricity meter is available. |
target_energy_kwhfloat (kWh) | Target meter value of the current charging session. null if no charging session is running or no electricity meter is available. Equal to the start meter value if no energy value is set. |
charge_limits/default_limits
Configuration of time and energy limits for charging sessions.
# $HOST e.g. warp2-AbCd
Read
curl http://$HOST/charge_limits/default_limits
{ "duration": 8, "energy_wh": 50000 }
Write
curl http://$HOST/charge_limits/default_limits -d '{ "duration": 8, "energy_wh": 50000 }'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd
Read
mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/charge_limits/default_limits
{ "duration": 8, "energy_wh": 50000 }
Write
With MQTT on $PREFIX/charge_limits/default_limits_update
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/default_limits_update -m '{ "duration": 8, "energy_wh": 50000 }'
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/active_limits
Active time and energy limits for the current or next charging session. Can be updated via charge_limits/override_duration and charge_limits/override_energy.
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/override_duration
Overrides the time limit for the current or next charging session.
# $HOST e.g. warp2-AbCd
Write
curl http://$HOST/charge_limits/override_duration -d '{ "duration": 12 }'
or abbreviated:
curl http://$HOST/charge_limits/override_duration -d '12'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd
Write
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_duration -m '{ "duration": 12 }'
or abbreviated:
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_duration -m '12'
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
charge_limits/override_energy
Overrides the energy limit for the current or next charging session.
# $HOST e.g. warp2-AbCd
Write
curl http://$HOST/charge_limits/override_energy -d '{ "energy_wh": 25000 }'
or abbreviated:
curl http://$HOST/charge_limits/override_energy -d '25000'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp2/AbCd
Write
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_energy -m '{ "energy_wh": 25000 }'
or abbreviated:
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_energy -m '25000'
| Name | Description |
|---|---|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/restart
Resets the charge limits as if a new charging session had started, but keeps the overridden charge limits. With this API and charge_limits/override_duration and charge_limits/override_energy, a new "absolute" charge limit can be set at any time.
Empty payload. One of the following values must be passed: null, "", false, 0, [] or {}
charge_limits/state
Current state of time and energy limits
{
"start_timestamp_ms": 786598059,
"start_energy_kwh": 886.1900024,
"target_timestamp_ms": 797398059,
"target_energy_kwh": 901.1900024
}
| Name | Description |
|---|---|
start_timestamp_msint (ms) | Start timestamp of the current charging session. 0 if no charging session is running. |
target_timestamp_msint (ms) | Target timestamp of the current charging session. 0 if no charging session is running. Equal to the start timestamp if no time limit is set. |
start_energy_kwhfloat (kWh) | Start meter value of the current charging session. null if no charging session is running or no electricity meter is available. |
target_energy_kwhfloat (kWh) | Target meter value of the current charging session. null if no charging session is running or no electricity meter is available. Equal to the start meter value if no energy value is set. |
charge_limits/default_limits
Configuration of time and energy limits for charging sessions.
# $HOST e.g. warp3-AbCd
Read
curl http://$HOST/charge_limits/default_limits
{ "duration": 8, "energy_wh": 50000 }
Write
curl http://$HOST/charge_limits/default_limits -d '{ "duration": 8, "energy_wh": 50000 }'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd
Read
mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/charge_limits/default_limits
{ "duration": 8, "energy_wh": 50000 }
Write
With MQTT on $PREFIX/charge_limits/default_limits_update
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/default_limits_update -m '{ "duration": 8, "energy_wh": 50000 }'
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/active_limits
Active time and energy limits for the current or next charging session. Can be updated via charge_limits/override_duration and charge_limits/override_energy.
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/override_duration
Overrides the time limit for the current or next charging session.
# $HOST e.g. warp3-AbCd
Write
curl http://$HOST/charge_limits/override_duration -d '{ "duration": 12 }'
or abbreviated:
curl http://$HOST/charge_limits/override_duration -d '12'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd
Write
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_duration -m '{ "duration": 12 }'
or abbreviated:
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_duration -m '12'
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
charge_limits/override_energy
Overrides the energy limit for the current or next charging session.
# $HOST e.g. warp3-AbCd
Write
curl http://$HOST/charge_limits/override_energy -d '{ "energy_wh": 25000 }'
or abbreviated:
curl http://$HOST/charge_limits/override_energy -d '25000'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp3/AbCd
Write
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_energy -m '{ "energy_wh": 25000 }'
or abbreviated:
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_energy -m '25000'
| Name | Description |
|---|---|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/restart
Resets the charge limits as if a new charging session had started, but keeps the overridden charge limits. With this API and charge_limits/override_duration and charge_limits/override_energy, a new "absolute" charge limit can be set at any time.
Empty payload. One of the following values must be passed: null, "", false, 0, [] or {}
Not supported on this hardware!
Not supported on this hardware!
charge_limits/state
Current state of time and energy limits
{
"start_timestamp_ms": 786598059,
"start_energy_kwh": 886.1900024,
"target_timestamp_ms": 797398059,
"target_energy_kwh": 901.1900024
}
| Name | Description |
|---|---|
start_timestamp_msint (ms) | Start timestamp of the current charging session. 0 if no charging session is running. |
target_timestamp_msint (ms) | Target timestamp of the current charging session. 0 if no charging session is running. Equal to the start timestamp if no time limit is set. |
start_energy_kwhfloat (kWh) | Start meter value of the current charging session. null if no charging session is running or no electricity meter is available. |
target_energy_kwhfloat (kWh) | Target meter value of the current charging session. null if no charging session is running or no electricity meter is available. Equal to the start meter value if no energy value is set. |
charge_limits/default_limits
Configuration of time and energy limits for charging sessions.
# $HOST e.g. warp-AbCd
Read
curl http://$HOST/charge_limits/default_limits
{ "duration": 8, "energy_wh": 50000 }
Write
curl http://$HOST/charge_limits/default_limits -d '{ "duration": 8, "energy_wh": 50000 }'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd
Read
mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/charge_limits/default_limits
{ "duration": 8, "energy_wh": 50000 }
Write
With MQTT on $PREFIX/charge_limits/default_limits_update
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/default_limits_update -m '{ "duration": 8, "energy_wh": 50000 }'
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/active_limits
Active time and energy limits for the current or next charging session. Can be updated via charge_limits/override_duration and charge_limits/override_energy.
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/override_duration
Overrides the time limit for the current or next charging session.
# $HOST e.g. warp-AbCd
Write
curl http://$HOST/charge_limits/override_duration -d '{ "duration": 12 }'
or abbreviated:
curl http://$HOST/charge_limits/override_duration -d '12'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd
Write
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_duration -m '{ "duration": 12 }'
or abbreviated:
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_duration -m '12'
| Name | Description |
|---|---|
durationint | Time limit of a charging session. The charging session is stopped after the time limit expires.
|
charge_limits/override_energy
Overrides the energy limit for the current or next charging session.
# $HOST e.g. warp-AbCd
Write
curl http://$HOST/charge_limits/override_energy -d '{ "energy_wh": 25000 }'
or abbreviated:
curl http://$HOST/charge_limits/override_energy -d '25000'
# $BROKER e.g. my_mosquitto.localdomain
# $PREFIX e.g. warp/AbCd
Write
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_energy -m '{ "energy_wh": 25000 }'
or abbreviated:
mosquitto_pub -h $BROKER -t $PREFIX/charge_limits/override_energy -m '25000'
| Name | Description |
|---|---|
energy_whint (Wh) | Energy limit of a charging session. The charging session is stopped after the energy limit expires. |
charge_limits/restart
Resets the charge limits as if a new charging session had started, but keeps the overridden charge limits. With this API and charge_limits/override_duration and charge_limits/override_energy, a new "absolute" charge limit can be set at any time.
Empty payload. One of the following values must be passed: null, "", false, 0, [] or {}