enode 0.2.0

Python Client SDK Generated by Speakeasy.

enode

Developer-friendly & type-safe Python SDK specifically catered to leverage enode API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Enode API: The Enode API is designed to make smart charging applications easy to develop. We provide an abstraction layer that reduces the complexity when extracting vehicle data and sending commands to vehicles from a variety of manufacturers. The API has a RESTful architecture and utilizes OAuth2 authorization.

Table of Contents

• enode
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with uv, pip, or poetry package managers.

uv

uv is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.

uv add enode

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install enode

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add enode

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from enode python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "enode",
# ]
# ///

from enode import Enode

sdk = Enode(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from enode import Enode, models
import os


with Enode(
    security=models.Security(
        client_id=os.getenv("ENODE_CLIENT_ID", ""),
        client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
    ),
) as e_client:

    res = e_client.batteries.list(after="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", before="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", page_size=50)

    # Handle response
    print(res)

The same SDK client can also be used to make asynchronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from enode import Enode, models
import os

async def main():

    async with Enode(
        security=models.Security(
            client_id=os.getenv("ENODE_CLIENT_ID", ""),
            client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
        ),
    ) as e_client:

        res = await e_client.batteries.list_async(after="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", before="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", page_size=50)

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
client_id client_secret	oauth2	OAuth2 Client Credentials Flow	ENODE_CLIENT_ID ENODE_CLIENT_SECRET ENODE_TOKEN_URL

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

from enode import Enode, models
import os


with Enode(
    security=models.Security(
        client_id=os.getenv("ENODE_CLIENT_ID", ""),
        client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
    ),
) as e_client:

    res = e_client.batteries.list(after="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", before="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", page_size=50)

    # Handle response
    print(res)

Available Resources and Operations

Available methods

batteries

• list - List Batteries
• list_user_batteries - List User Batteries
• get - Get Battery
• set_operation_mode - Set Operation Mode for Battery
• get_action - Get Operation Mode Action
• cancel_action - Cancel Battery Action
• refresh_data - Refresh Battery Data

chargers

• list - List Chargers
• list_for_user - List User Chargers
• get - Get Charger
• update - Set location for a charger
• control_charging - Control Charging
• set_max_current - Set Max Current
• get_action - Get Charger Action
• cancel_action - Cancel Charger Action
• refresh_data - Refresh Charger Data

experimental

• set_max_current - Set Max Current

hem_systems

• get_hems_status - Get HEMS status

hems

• get_hems_statistics - Get HEMS statistics
• list - Get HEMS status

hvac

• list - List HVAC units
• update - Set Location for an HVAC unit
• get_action - Get Action
• list_user_hva_cs - List User HVAC units
• cancel_hvac_action - Cancel HVAC Action

hvacs

• get - Get HVAC Unit
• set_follow_schedule - Set HVAC unit to follow device schedule
• refresh_hint - Refresh HVAC unit data
• set_permanent_hold - Set HVAC unit Mode as Permanent Hold

interventions

• list - List Interventions
• get - Get Intervention

locations

• list - List Locations
• list_for_user - List User Locations
• create - Create Location
• get - Get Location
• delete - Delete Location
• update - Update Location

meters

• get_meter - Get Meter
• refresh_hint - Refresh meter data
• get_by_user - List User Meters
• list - List Meters

schedules

• get_by_user - List Schedules
• create - Create Schedule
• get - Get Schedule
• update - Update Schedule
• delete - Delete Schedule
• get_status - Get Schedule Status

service_health

• list_integrations - List supported vendors per asset type
• check_charger_vendors - Check Available Charger Vendors
• get_vehicle_vendors - Check Available Vehicle Vendors
• get_battery_vendors - Check Available Battery Vendors
• get_inverter_vendors - Check Available Inverter Vendors
• get_hvac_vendors - Check Available Hvac Vendors
• get_meter_vendors - Check Available Meter Vendors
• check_readiness - Check Service Readiness

solar_inverters

• list_inverters - List Solar Inverters
• list_user_inverters - List User Solar Inverters
• get_inverter - Get Solar Inverter
• refresh_hint - Refresh Inverter data
• get_statistics - Get Inverter Statistics

statistics

• get_charging_sessions - Get User Statistics on Charging Sessions
• get_charging - Get User Charging Statistics

tariffs

• get - Get Tariff
• create - Create a Tariff
• link_to_location - Link Tariff to Location
• get_by_location - Get Tariff Schedule

user_management

• list - List Users
• get - Get User
• post_users_userid_link - Link User
• delete_users_userid_authorization - Deauthorize User
• unlink_user - Unlink User
• relink_asset - Relink Asset

vehicles

• list - List Vehicles
• list_for_user - List User Vehicles
• get - Get Vehicle
• control_charging - Control Charging
• set_max_current - Set Max Current
• get_action - Get Vehicle Action
• cancel_action - Cancel Vehicle Action
• refresh_hint - Refresh Vehicle Data
• get_smart_charging_policy - Get Vehicle Smart Charging Policy
• update_smart_charging_policy - Update Vehicle Smart Charging Policy
• create_smart_override - Create Smart Override
• end_smart_override - End Smart Override
• get_smart_charging_status - Get Vehicle Smart Charging Status

webhooks

• create - Create Webhook
• list - List Webhooks
• update - Update Webhook
• get - Get Webhook
• delete - Delete Webhook
• test - Test Webhook

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from enode import Enode, models
from enode.utils import BackoffStrategy, RetryConfig
import os


with Enode(
    security=models.Security(
        client_id=os.getenv("ENODE_CLIENT_ID", ""),
        client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
    ),
) as e_client:

    res = e_client.batteries.list(after="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", before="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", page_size=50,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from enode import Enode, models
from enode.utils import BackoffStrategy, RetryConfig
import os


with Enode(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    security=models.Security(
        client_id=os.getenv("ENODE_CLIENT_ID", ""),
        client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
    ),
) as e_client:

    res = e_client.batteries.list(after="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", before="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", page_size=50)

    # Handle response
    print(res)

Error Handling

EnodeError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
err.message	str	Error message
err.status_code	int	HTTP response status code eg 404
err.headers	httpx.Headers	HTTP response headers
err.body	str	HTTP body. Can be empty string if no body is returned.
err.raw_response	httpx.Response	Raw HTTP response
err.data		Optional. Some errors may contain structured data. See Error Classes.

Example

from enode import Enode, errors, models
import os


with Enode(
    security=models.Security(
        client_id=os.getenv("ENODE_CLIENT_ID", ""),
        client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
    ),
) as e_client:
    res = None
    try:

        res = e_client.batteries.set_operation_mode(battery_id="54d827e1-8355-4fed-97b5-55940d1d09ba", operation_mode=models.SetBatteryOperationModePayloadOperationMode.IMPORT_FOCUS)

        # Handle response
        print(res)


    except errors.EnodeError as e:
        # The base class for HTTP error responses
        print(e.message)
        print(e.status_code)
        print(e.body)
        print(e.headers)
        print(e.raw_response)

        # Depending on the method different errors may be thrown
        if isinstance(e, errors.ProblemError):
            print(e.data.type)  # str
            print(e.data.title)  # str
            print(e.data.detail)  # str
            print(e.data.issues)  # Optional[List[models.ProblemIssue]]

Error Classes

Primary error:

• EnodeError: The base class for HTTP error responses.

Less common errors (17)

Network errors:

• httpx.RequestError: Base class for request errors.
  • httpx.ConnectError: HTTP client was unable to make a request to a server.
  • httpx.TimeoutException: HTTP request timed out.

Inherit from EnodeError:

• ProblemError: Standard Problem Error. Applicable to 13 of 91 methods.*
• WebhookNotFoundProblemError: Webhook not found problem error. Status code 404. Applicable to 4 of 91 methods.*
• ChargeActionError: Successful. Status code 409. Applicable to 2 of 91 methods.*
• GetInverterStatisticsBadRequestError: Invalid date input. Status code 400. Applicable to 1 of 91 methods.*
• UpdateVehicleSmartChargingPolicyBadRequestError: Various Bad Request errors. Title and detail can vary. Status code 400. Applicable to 1 of 91 methods.*
• WebhookNotValidProblemError: Webhook input is not valid. Status code 400. Applicable to 1 of 91 methods.*
• ConnectionsLimitReachedProblemError: Connections limit reached. Status code 403. Applicable to 1 of 91 methods.*
• NotFoundError: Inverter not found. Status code 404. Applicable to 1 of 91 methods.*
• BatteryError: Action already in a resolved state and can therefore not be cancelled. Status code 409. Applicable to 1 of 91 methods.*
• MaxCurrentActionError: Successful. Status code 409. Applicable to 1 of 91 methods.*
• HvacActionPermanentHoldError: Successful. Status code 409. Applicable to 1 of 91 methods.*
• HvacActionFollowScheduleError: Successful. Status code 409. Applicable to 1 of 91 methods.*
• ResponseValidationError: Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the cause attribute.

* Check the method documentation to see if the error is applicable.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from enode import Enode, models
import os


with Enode(
    server_url="https://enode-api.production.enode.io",
    security=models.Security(
        client_id=os.getenv("ENODE_CLIENT_ID", ""),
        client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
    ),
) as e_client:

    res = e_client.batteries.list(after="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", before="MjAyMy0wNy0xOFQxMDowODowMi4zNzNa", page_size=50)

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from enode import Enode
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = Enode(client=http_client)

or you could wrap the client with your own custom logic:

from enode import Enode
from enode.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = Enode(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The Enode class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from enode import Enode, models
import os
def main():

    with Enode(
        security=models.Security(
            client_id=os.getenv("ENODE_CLIENT_ID", ""),
            client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
        ),
    ) as e_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with Enode(
        security=models.Security(
            client_id=os.getenv("ENODE_CLIENT_ID", ""),
            client_secret=os.getenv("ENODE_CLIENT_SECRET", ""),
        ),
    ) as e_client:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from enode import Enode
import logging

logging.basicConfig(level=logging.DEBUG)
s = Enode(debug_logger=logging.getLogger("enode"))

You can also enable a default debug logger by setting an environment variable ENODE_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy