Skip to main content

Python client library for the Ampere.IQ energy management system by Energiekonzepte Deutschland

Project description

Ampere

A Python client library for fetching data from the Ampere.IQ energy management system by Energiekonzepte Deutschland.

Note: This library was generated with AI assistance but designed and reviewed by a human.

Installation

pip install -e .

Or install from requirements:

pip install -r requirements.txt

Usage

from ampere import AmpereClient

# Initialize the client with your Ampere.IQ system URL
client = AmpereClient('https://your-ampere-system.local')

# Authenticate
client.login('your-password')

# Fetch energy overview data
overview = client.energy_overview()
print(overview.production)
print(overview.consumption)

API Reference

AmpereClient(base_url)

Initialize a new Ampere.IQ API client.

Parameters:

  • base_url (str): Base URL of your Ampere.IQ system

Methods

login(password)

Authenticate with the Ampere.IQ system.

Parameters:

  • password (str): The installer password

Raises:

  • requests.exceptions.HTTPError: If authentication fails

energy_overview()

Fetch current energy overview data from the system.

Returns:

  • SimpleNamespace: Energy data with attribute access (e.g., production, consumption)

Raises:

  • requests.exceptions.RequestException: If the request fails

License

MIT

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

ampere_iq-0.1.0.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

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

ampere_iq-0.1.0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file ampere_iq-0.1.0.tar.gz.

File metadata

  • Download URL: ampere_iq-0.1.0.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ampere_iq-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1c86f9b5c11400e639b1c4ca37a9917b088d1d66d512a906b24a5b1740400129
MD5 677ccebe4ba637cdfe0fe1e4c862c933
BLAKE2b-256 c06b7b3174520a46dbd45ae9bddcda860c28c211a2cbffec75dd0b1543dc25ec

See more details on using hashes here.

Provenance

The following attestation bundles were made for ampere_iq-0.1.0.tar.gz:

Publisher: publish.yml on Frdnspnzr/ampere-iq

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

File details

Details for the file ampere_iq-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ampere_iq-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ampere_iq-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83aff0714965a46a69f547cd33c37db462e38c2a1b2454c9eda633ae667091e6
MD5 e11e534485a20deb7d544c231ffcc71e
BLAKE2b-256 4499d974a5b77aed3835b46497f14b8a66bf5e09480698855c556cbe94aff479

See more details on using hashes here.

Provenance

The following attestation bundles were made for ampere_iq-0.1.0-py3-none-any.whl:

Publisher: publish.yml on Frdnspnzr/ampere-iq

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