em-data-ingester 1.0.0

Python library for pushing data to the Energy Mutual (Konductor) platform

em-data-ingester

Python helper module for publishing data to the Energy Mutual platform

About Energy Mutual

Energy Mutual helps owners of distributed energy assets make the most of their renewable resources.

Check us out at energymutual.com

Getting Started

Prerequisites

You will need the following. Please contact Energy Mutual Support if you do not have them already.

1. Certificate files
   • private.pem.key
   • certificate.pem.crt
   • CA.pem
2. Your client_id and topic

Python 3.9 or newer is required.

Installation

pip install em-data-ingester

or, with uv:

uv add em-data-ingester

Usage

All examples below assume the following:

• client_id of EM123456
• topic of MyTopicName
• All required key/certificate files in a certificates/ subdirectory

Creating an EMDataIngester and connecting

from em_data_ingester import EMDataIngester

ingester = EMDataIngester(
    client_id="EM123456",
    topic="MyTopicName",
    key_path="certificates/private.pem.key",
    cert_path="certificates/certificate.pem.crt",
    ca_path="certificates/CA.pem",
)

ingester.connect()

Adding attributes to the payload

from datetime import datetime, timezone

# Add a powerOutput reading (timestamp defaults to now, UTC)
ingester.add_to_payload("powerOutput", 123, units="kW")

# Or pass an explicit datetime
ingester.add_to_payload(
    "reservoirLevel",
    10,
    dt=datetime.now(timezone.utc),
    units="m",
)

Adding the same attribute name more than once will overwrite the previous value.

Sending the payload

ingester.send_payload()

This will clear the payload after a successful publish.

Clearing the payload

ingester.clear_payload()

Viewing the payload

print(ingester.payload)

Closing the connection (Important!)

ingester.end()

Context manager

EMDataIngester also works as a context manager, which connects on entry and closes the connection on exit:

with EMDataIngester(
    client_id="EM123456",
    topic="MyTopicName",
    key_path="certificates/private.pem.key",
    cert_path="certificates/certificate.pem.crt",
    ca_path="certificates/CA.pem",
) as ingester:
    ingester.add_to_payload("powerOutput", 123, units="kW")
    ingester.send_payload()

(back to top)

Contact

Energy Mutual - [e-mail]