Skip to main content

Python wrapper for OpenEVSE HTTP API

Project description

Codecov branch GitHub commit activity (branch) GitHub last commit GitHub release (latest SemVer)

python-openevse-http

A Python library for communicating with OpenEVSE chargers via the HTTP API on ESP8266 and ESP32-based WiFi modules.

Features

  • Asynchronous: Built on aiohttp for non-blocking I/O.
  • WebSocket Support: Real-time updates for charger status.
  • Firmware Support: Compatible with ESP8266 (2.x) and ESP32 (4.x+) WiFi firmware.
  • Comprehensive API:
    • Query status and configuration.
    • Manage manual overrides.
    • Control charging claims and limits.
    • Handle schedules.
    • Shaper Toggle: Enable or disable the grid shaper feature (requires firmware 4.0.0+).

Installation

pip install python_openevse_http

Quick Start

import asyncio
from openevsehttp import OpenEVSE

async def main():
    # Initialize the charger
    charger = OpenEVSE("192.168.1.30")

    # Update state
    await charger.update()

    print(f"Charger State: {charger.status}")
    print(f"Current Charge: {charger.charge_current}A")

    # Toggle the Shaper feature
    if charger.shaper_active:
        print("Shaper is active, disabling...")
    else:
        print("Shaper is inactive, enabling...")

    await charger.toggle_shaper()

    # Clean up
    await charger.close()

if __name__ == "__main__":
    asyncio.run(main())

API Support Matrix

Endpoint Methods Supported Description
/status GET, POST Real-time status, sensors, and Vehicle SoC pushing
/config GET, POST System and WiFi configuration
/override GET, POST, PATCH, DELETE Manual charging overrides & current limits
/claims GET, POST, DELETE Client-based charging claims
/schedule GET, POST Charging schedule management
/limit GET, POST, DELETE Charge limits (Time, Energy, SoC)
/shaper POST Grid shaper control (v4.0.0+)
/restart POST Reboot WiFi gateway or EVSE module
/divertmode POST Solar divert mode control
/r (RAPI) POST Direct RAPI command interface
/ws GET WebSocket real-time updates
/time GET, POST RTC and NTP time settings
/logs GET System and debug event logs
/emeter DELETE Energy meter reset
/wifi GET, POST Network scanning and AP configuration
/tesla GET Tesla vehicle integration
/certificates GET, POST, DELETE SSL/TLS certificate management
/schedule/plan GET Schedule planning and optimization
/update POST Firmware update interface
/rfid/add POST RFID tag management

✅ = Fully Supported | ⚠️ = Partial Support | ❌ = Not yet implemented

License

This project is licensed under the Apache-2.0 License.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_openevse_http-0.3.5.tar.gz (64.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_openevse_http-0.3.5-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file python_openevse_http-0.3.5.tar.gz.

File metadata

  • Download URL: python_openevse_http-0.3.5.tar.gz
  • Upload date:
  • Size: 64.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for python_openevse_http-0.3.5.tar.gz
Algorithm Hash digest
SHA256 a6b683d4c5b868412e65a600f3dddf5be76e63d178acd0f863c1b1cec91fb0b0
MD5 ced481b5944dad2b3ea787290e63a395
BLAKE2b-256 036089c887b68b2a702600dda96b8f30f0b0b3746955d3132339b5c6f3928746

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_openevse_http-0.3.5.tar.gz:

Publisher: publish-to-pypi.yml on firstof9/python-openevse-http

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file python_openevse_http-0.3.5-py3-none-any.whl.

File metadata

File hashes

Hashes for python_openevse_http-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d1ccf8389fa36c8433c59aacc185af48713ae769bc18082f5b95428560773d81
MD5 125cad05c63d438c6a984ee1793c922a
BLAKE2b-256 e0417758b4a1eba22ca2873897103371e774e3ba1c1cc057086754845d7bfc0a

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_openevse_http-0.3.5-py3-none-any.whl:

Publisher: publish-to-pypi.yml on firstof9/python-openevse-http

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page