Skip to main content

Asynchronous Python client for Peblar EV chargers.

Project description

Python: Peblar EV Chargers

GitHub Release Python Versions Project Stage Project Maintenance License

Build Status Code Coverage OpenSSF Scorecard Open in Dev Containers

Sponsor Frenck via GitHub Sponsors

Support Frenck on Patreon

Asynchronous Python client for Peblar's rock-solid EV chargers.

About

This package allows you to control and monitor Peblar EV Chargers programmatically. It is mainly created to allow third-party programs to automate the behavior of a Peblar charger.

Additionally, this package contains a CLI tool, which can be used standalone, providing a command-line interface to control and monitor Peblar chargers.

Known compatible and tested Peblar chargers:

  • Peblar Home

Installation

pip install peblar

In case you want to use the CLI tools, install the package with the following extra:

pip install peblar[cli]

CLI usage

The Peblar CLI tool exposes the full functionality of this library from the command line.

The CLI ships with built-in help, accessible via the --help flag:

peblar --help

To scan for Peblar chargers on your network:

peblar scan

For more details on each command, use --help against any subcommand.

Python usage

Using this library in Python:

import asyncio

from peblar import Peblar


async def main() -> None:
    """Show an example of programmatically controlling a Peblar charger."""
    async with Peblar(host="192.168.1.123") as peblar:
        await peblar.login(password="Sup3rS3cr3t!")

        await peblar.identify()

        system_information = await peblar.system_information()
        print(system_information)


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

Changelog & releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up a development environment

The easiest way to start is by opening a CodeSpace here on GitHub, or by using the Dev Container feature of Visual Studio Code.

Open in Dev Containers

This Python project is fully managed using the Poetry dependency manager. It also relies on NodeJS for certain checks during development.

You need at least:

  • Python 3.11+
  • Poetry
  • NodeJS 24+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install --all-extras

As this repository uses the prek framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run prek run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2024-2026 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

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

Source Distribution

peblar-0.5.0.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

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

peblar-0.5.0-py3-none-any.whl (28.5 kB view details)

Uploaded Python 3

File details

Details for the file peblar-0.5.0.tar.gz.

File metadata

  • Download URL: peblar-0.5.0.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for peblar-0.5.0.tar.gz
Algorithm Hash digest
SHA256 c0042373333ce37048b798736548244734f10dcb0513eb8a2cfb90017248ba75
MD5 b3d8cdb0c63a388c996af5930357dc41
BLAKE2b-256 c8f66a3724d8ceb0768eaefc0a2634ebc02f81623c1e8aa2141cfbde1e927689

See more details on using hashes here.

Provenance

The following attestation bundles were made for peblar-0.5.0.tar.gz:

Publisher: release.yaml on frenck/python-peblar

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

File details

Details for the file peblar-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: peblar-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 28.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for peblar-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3780de5706097d45ef23a253f26a47ae1d3504249dc62671b7678a684785fb21
MD5 3a56c0dbb8034b21edb468870eeea66b
BLAKE2b-256 bf260831914e4948e7db9e421df0a0d8874c1b26c4e109073e1e3324aa357903

See more details on using hashes here.

Provenance

The following attestation bundles were made for peblar-0.5.0-py3-none-any.whl:

Publisher: release.yaml on frenck/python-peblar

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