python-openevse-http 1.4.0

Python wrapper for OpenEVSE HTTP API

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
import aiohttp
from openevsehttp import OpenEVSE

async def main():
    async with aiohttp.ClientSession() as session:
        charger = OpenEVSE("192.168.1.30", session=session)
        await charger.update()

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

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

        await charger.toggle_shaper()
        await charger.ws_disconnect()

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

HTTPS and SSL Verification Options

If your OpenEVSE WiFi/ethernet module uses HTTPS, you can configure the client to connect securely using the ssl=True parameter:

        # Connect securely using HTTPS (validating SSL/TLS certificates)
        charger = OpenEVSE(
            "192.168.1.30",
            session=session,
            ssl=True,
        )

Bypassing SSL Verification (Self-Signed Certificates)

[!WARNING] Disabling SSL certificate validation (ssl_verify=False) disables TLS verification and exposes the connection to Man-in-the-Middle (MITM) attacks. Only use this configuration when connecting to an OpenEVSE module with a self-signed certificate over a trusted local network.

To bypass certificate verification:

        # Connect using HTTPS, and disable certificate verification
        charger = OpenEVSE(
            "192.168.1.30",
            session=session,
            ssl=True,
            ssl_verify=False,
        )

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 (Retrieval only)
/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.