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.1.tar.gz (49.5 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.1-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_openevse_http-0.3.1.tar.gz
  • Upload date:
  • Size: 49.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for python_openevse_http-0.3.1.tar.gz
Algorithm Hash digest
SHA256 55220a8f01a531e02a25a782b3ed9d069bcc361d2954cffd8a589a5a3d8ce79a
MD5 a95da146be45ffa104373fe0dc925423
BLAKE2b-256 934ba03cb518f33cb264f851d18b2349607a0b2f5b84e29f0f693e3cad9eb726

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_openevse_http-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 43712e0ce5e75c612109a46af9242b0bff01353bd49ecbcf419c950481f06fde
MD5 78041140c2f38c85f7435e0cf92fa50f
BLAKE2b-256 bd6c3030cabe57d1f3fc861ceca0c7c959c2d3249da70b97cc23303f470158cb

See more details on using hashes here.

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