Skip to content

Services Reference

firstof9@gmail.com edited this page Oct 2, 2026 · 2 revisions

Services Reference

All services are prefixed with openevse. (e.g., openevse.set_override).

Services can target any entity belonging to an OpenEVSE integration entry, or the device ID directly. The most convenient target is typically sensor.openevse_charging_status.

Note

Examples below use the modern action: syntax. The legacy service: key is also fully supported by Home Assistant automations and scripts.


Overrides

Manual overrides give you direct, one-shot control over the charger state.

openevse.set_override

Sets a manual override on the charger.

Parameter Type Required Description
state select No active (start charging) or disabled (stop charging)
charge_current integer (1–48) No Target charge current in Amps
max_current integer (1–48) No Hard cap on charge current, still allowing claim-based adjustments below this
energy_limit integer No Stop after this many Wh transferred (reserved, not currently implemented)
time_limit integer No Stop after this many seconds of charging (reserved, not currently implemented)
auto_release boolean No Automatically clear the override when the vehicle disconnects (default: true)

Example — start charging at 24 A, auto-release on disconnect:

action: openevse.set_override
target:
  entity_id: sensor.openevse_charging_status
data:
  state: active
  charge_current: 24
  auto_release: true

Example — stop charging immediately:

action: openevse.set_override
target:
  entity_id: sensor.openevse_charging_status
data:
  state: disabled

openevse.clear_override

Clears the active manual override, returning the charger to its normal programmed behavior.

action: openevse.clear_override
target:
  entity_id: sensor.openevse_charging_status

openevse.list_overrides (returns response data)

Returns a list of all active overrides on the EVSE.

action: openevse.list_overrides
target:
  entity_id: sensor.openevse_charging_status
response_variable: overrides

Claims

Claims are a priority-based system that allows multiple automations or apps to safely request different charger states simultaneously. The charger resolves conflicts based on claim priority.

openevse.make_claim

Register or update a state claim on the charger.

Parameter Type Required Description
state select No active or disabled
charge_current integer (1–48) No Requested charge current in Amps
max_current integer (1–48) No Maximum allowed current
auto_release boolean No Auto-release claim on vehicle disconnect
action: openevse.make_claim
target:
  entity_id: sensor.openevse_charging_status
data:
  state: active
  charge_current: 16
  auto_release: true

openevse.release_claim

Releases the current integration claim, allowing other claims to take effect.

action: openevse.release_claim
target:
  entity_id: sensor.openevse_charging_status

openevse.list_claims (returns response data)

Returns a dictionary of all active claims on the EVSE.

action: openevse.list_claims
target:
  entity_id: sensor.openevse_charging_status
response_variable: claims

Charge Limits

Session limits allow you to set automatic stop conditions based on energy, time, battery level, or range.

openevse.set_limit

Set a limit for the current charging session.

Parameter Type Required Description
type select Yes Limit type: time (minutes), energy (Wh), soc (%), range (km or mi)
value integer Yes Target value for the chosen limit type
auto_release boolean No Release limit on vehicle disconnect (default: true)

Example — stop at 80% SoC:

action: openevse.set_limit
target:
  entity_id: sensor.openevse_charging_status
data:
  type: soc
  value: 80
  auto_release: true

Example — limit to 10 kWh (10000 Wh):

action: openevse.set_limit
target:
  entity_id: sensor.openevse_charging_status
data:
  type: energy
  value: 10000

Example — charge for 60 minutes:

action: openevse.set_limit
target:
  entity_id: sensor.openevse_charging_status
data:
  type: time
  value: 60

openevse.clear_limit

Clear any active session limit.

action: openevse.clear_limit
target:
  entity_id: sensor.openevse_charging_status

openevse.get_limit (returns response data)

Retrieve the current session limit from the charger.

action: openevse.get_limit
target:
  entity_id: sensor.openevse_charging_status
response_variable: limit

Time & NTP

openevse.get_time (returns response data)

Retrieves the current date, time, timezone, and SNTP status from the charger.

action: openevse.get_time
target:
  entity_id: sensor.openevse_charging_status
response_variable: charger_time

openevse.set_time

Configures the charger's clock, timezone, or NTP settings.

Parameter Type Required Description
time text No ISO-8601 datetime string, e.g., 2026-03-25T15:30:00Z
timezone text No POSIX timezone string or location, e.g., America/New_York|EST5EDT,M3.2.0,M11.1.0 or Europe/London
sntp boolean No Enable or disable NTP synchronization

Example — enable NTP and set timezone:

action: openevse.set_time
target:
  entity_id: sensor.openevse_charging_status
data:
  timezone: "America/New_York|EST5EDT,M3.2.0,M11.1.0"
  sntp: true

openevse.sync_time

Triggers an immediate NTP time sync on the charger.

action: openevse.sync_time
target:
  entity_id: sensor.openevse_charging_status

RFID Management

See also: RFID Management for the full guide.

openevse.add_rfid_tag (requires firmware 4.0.0+)

Puts the charger into RFID learning/pairing mode to register the next scanned card or tag.

action: openevse.add_rfid_tag
target:
  entity_id: sensor.openevse_charging_status

openevse.set_rfid_user (requires firmware 5.0.0+)

Maps an RFID tag ID to a Home Assistant person entity or a friendly name string.

Parameter Type Required Description
rfid text Yes RFID tag ID (e.g., 01020304)
person entity_id No HA person entity to associate (e.g., person.john_doe)
name text No Friendly name string (used if person is not set)
action: openevse.set_rfid_user
target:
  entity_id: sensor.openevse_charging_status
data:
  rfid: "01020304"
  person: person.john_doe

openevse.delete_rfid_user (requires firmware 5.0.0+)

Deletes an RFID tag mapping from the charger.

Parameter Type Required Description
rfid text Yes RFID tag ID to delete
action: openevse.delete_rfid_user
target:
  entity_id: sensor.openevse_charging_status
data:
  rfid: "01020304"

openevse.get_rfid_users (requires firmware 5.0.0+) (returns response data)

Retrieves all registered RFID tag → user mappings from the charger.

action: openevse.get_rfid_users
target:
  entity_id: sensor.openevse_charging_status
response_variable: rfid_users

Energy Meter

openevse.reset_energy_meter (requires firmware 4.0.0+)

Resets the OpenEVSE energy meter counter.

Parameter Type Required Description
hard boolean No Perform a hard reset instead of soft reset (default: false)
import boolean No Reset import energy counters (default: false)
action: openevse.reset_energy_meter
target:
  entity_id: sensor.openevse_charging_status
data:
  hard: false
  import: false

Advisory Notifications

openevse.get_notifications (requires firmware 5.1.0+) (returns response data)

Retrieves all active advisory notifications from the OpenEVSE charger.

action: openevse.get_notifications
target:
  entity_id: sensor.openevse_charging_status
response_variable: notifications

openevse.acknowledge_notification (requires firmware 5.1.0+)

Acknowledges (mutes) an active advisory notification on the charger.

Parameter Type Required Description
notification_id text Yes The notification ID to acknowledge
action: openevse.acknowledge_notification
target:
  entity_id: sensor.openevse_charging_status
data:
  notification_id: "0"

Targeting by Device ID

All services also accept a device_id target instead of an entity. This is useful in scripts and blueprints where you may not know entity names:

action: openevse.set_override
target:
  device_id: <YOUR_OPENEVSE_DEVICE_ID>
data:
  state: active
  charge_current: 32

You can find your device_id at: Settings → Devices & Services → OpenEVSE → (your device) → Device Info → Device ID

Clone this wiki locally