Microcycler Python SDK
Python SDK for the Microcycler battery testing platform.
Status: Pre-alpha — API subject to change.
Installation
pip install microcycler
The package is a thin Python layer over a Rust core (core/ in the repository: the same code the Microcycler dashboard and the headless agent run), shipped as one prebuilt wheel per platform (Windows, macOS, Linux; Python 3.9+). pip install microcycler needs no compiler. Installing from a source checkout (pip install -e sdk) builds the core and needs a Rust toolchain (rustup.rs).
Uplink agent
Set up a headless computer (for example a Linux box in the lab) in two steps, with no browser and nothing to copy:
pip install microcycler
microcycler-agent enroll --install-service # prints a code like ABCD-EFGH
An admin enters the code in the dashboard (Settings → Organization → Uplink → Add a computer) after checking the fingerprint, and the computer then uploads this network's licensed cyclers to your organization as a background service. microcycler-agent run runs it in the foreground instead; import <credential> is the offline alternative for a credential file made in the dashboard. Local telemetry needs UDP 5001/5002 open on a host firewall (sudo ufw allow in proto udp from 169.254.0.0/16 to any port 5001,5002, adjusting the source range to your cyclers' subnet).
Quickstart
Connect and read telemetry
import asyncio
from microcycler import Cycler
async def main():
async with Cycler("192.168.1.100") as cycler:
print(await cycler.identify())
t = await cycler.get_telemetry()
print(f"State: {t.state}")
print(f"Voltage: {t.voltage:.3f} V")
print(f"Current: {t.current:.3f} A")
print(f"Temp: {t.temperature:.1f} °C")
print(f"Capacity: {t.capacity_mah:.1f} mAh")
asyncio.run(main())
Discover cyclers on the network
import asyncio
from microcycler import Cycler, discover
async def main():
# Listens for the discovery beacon on UDP 5002. The beacon is periodic
# and unsolicited, so this is a collection window, not a deadline —
# allow at least one beacon period (10 s by default).
for dev in await discover():
print(dev) # HADES-042 @ 169.254.10.5:5000 (standby)
async with Cycler(dev.host, port=dev.port) as cycler:
print(await cycler.get_life())
asyncio.run(main())
Stream live telemetry via UDP
from microcycler.streaming import CyclerStream
async def monitor():
async with CyclerStream() as stream:
async for telemetry in stream:
print(telemetry.voltage, telemetry.current)
Build and run a recipe
from microcycler import Cycler
from microcycler.recipes import Recipe, CC, CV, Rest, Loop
recipe = (
Recipe(name="Standard Formation")
.add(CC(current=0.1, cutoff_voltage_high=4.2))
.add(CV(voltage=4.2, limit_current_high=0.1, cutoff_current_low=0.02))
.add(Rest(duration=1800))
.add(CC(current=-0.2, cutoff_voltage_low=2.8))
.add(Rest(duration=1800))
.add(Loop(cycles=3))
)
async def run():
async with Cycler("192.168.1.100") as cycler:
await cycler.load_recipe(recipe)
await cycler.start()
Recipe steps
| Step | Description |
|---|---|
CC(current, cutoff_voltage_high, cutoff_voltage_low, cutoff_time, cutoff_capacity) |
Constant current. current is signed: positive = charge, negative = discharge. |
CV(voltage, limit_current_high, cutoff_current_low, cutoff_time) |
Constant voltage |
CP(power, cutoff_voltage, cutoff_time) |
Constant power |
CR(resistance, cutoff_voltage, cutoff_time) |
Constant resistance |
Rest(duration) |
Open-circuit rest |
EIS(freq_start, freq_end, amplitude, points_per_decade) |
Impedance sweep |
Loop(cycles) |
Repeat preceding steps N times |
ACRipple(duration, dc_current, ac_amplitude, ac_freq, cutoff_temp) |
AC ripple excitation for calorimetry / thermal characterisation |
License
MIT
Lifetime wear counters
Every board keeps an odometer in its EEPROM. Three independent axes, because a unit can be worn out along any one of them while the others look fine: mechanical (relay actuations), calendar (powered time) and electrical (charge through the output).
from microcycler import Cycler
async with Cycler("192.168.1.200") as cycler:
life = await cycler.get_life()
print(f"boots {life.boot_count}")
print(f"powered {life.powered_hours:,.0f} h")
print(f"throughput {life.throughput_ah:,.1f} Ah")
print(f"MAIN relay {life.relay_main:,} closings")
print(f"FAN relay {life.relay_fan:,} closings")
if not life.durable:
print("WARNING: counters are not reaching the EEPROM")
These belong to the physical board, not to your database, so they survive a reinstall, an MCU swap, or the unit moving to another lab. There is deliberately no way to reset them — an odometer that can be wound back is not evidence of anything.
life.durable (i.e. write_errors == 0) is the field worth alerting on. A
unit with a dead EEPROM still counts perfectly well in RAM and reports entirely
plausible numbers; nothing else distinguishes a kept odometer from one that is
lost at every power cut.
Counters are flushed at most once every few minutes to spare the part, so up to that much accrued wear is in RAM only. Before deliberately powering a unit down:
await cycler.flush_life()
1 maintainer
Metadata
1 maintainer
Release files for microcycler 0.1.25
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| microcycler-0.1.25.tar.gz | 144.9 kB | Without provenance | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| microcycler-0.1.25-cp39-abi3-win_amd64.whl | CPython 3.9 | abi3 | Windows x86-64 | Details |
| microcycler-0.1.25-cp39-abi3-manylinux_2_28_aarch64.whl | CPython 3.9 | abi3 | Linux glibc 2.28+ ARM64 | Details |
| microcycler-0.1.25-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.9 | abi3 | Linux glibc 2.17+ x86-64 | Details |
| microcycler-0.1.25-cp39-abi3-macosx_11_0_arm64.whl | CPython 3.9 | abi3 | macOS 11.0+ ARM64 | Details |
| microcycler-0.1.25-cp39-abi3-macosx_10_12_x86_64.whl | CPython 3.9 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 18.4 MB
Release files / microcycler-0.1.25.tar.gz
| Download URL | microcycler-0.1.25.tar.gz |
|---|---|
| Size | 144.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eefc75269b33286bcaeafb765a59c7a95e2294cd5d343c471db58d2230d8bdb9
|
|
BLAKE2b-256 checksum How to use checksums |
571ae291f8023c03c819287e9b6fe57cdc2a482af8012a3ae89f239e0898ccb3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / microcycler-0.1.25-cp39-abi3-win_amd64.whl
| Download URL | microcycler-0.1.25-cp39-abi3-win_amd64.whl |
|---|---|
| Size | 3.5 MB |
| Tags | CPython 3.9 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
4b9d244800f11f1a462b9f6ce0527fd7c7b266e5f647688dc0258878edf9f57b
|
|
BLAKE2b-256 checksum How to use checksums |
a67f0f474f2ee62a68f38cf1515d0c8f454d0ed492a87af14bbff42772ba309c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / microcycler-0.1.25-cp39-abi3-manylinux_2_28_aarch64.whl
| Download URL | microcycler-0.1.25-cp39-abi3-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 3.3 MB |
| Tags | CPython 3.9 Linux glibc 2.28+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
cd5d070ffac8b481237cfe4a83663190ca66054bc1e3348837ad34b75cb33ad5
|
|
BLAKE2b-256 checksum How to use checksums |
49e245fcdf6a908e908ef34f5a838df91ec95e6b7c033cc9a901afa32cb79aa2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / microcycler-0.1.25-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | microcycler-0.1.25-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 4.0 MB |
| Tags | CPython 3.9 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
c05cf8c9744bf1ccdb74bc8182670608a58150a77f0e60710668ac3cec128ed3
|
|
BLAKE2b-256 checksum How to use checksums |
271c888d1b7f7381172a0247f8d4c63da5544d6c6d2cadec503d6748fab3cb23
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / microcycler-0.1.25-cp39-abi3-macosx_11_0_arm64.whl
| Download URL | microcycler-0.1.25-cp39-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 3.6 MB |
| Tags | CPython 3.9 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
00f5c3c42e6aca7bb05f93da22055e48b01d0cb8afc0b78256fa1f75e6159671
|
|
BLAKE2b-256 checksum How to use checksums |
cfcf9bff7d4d9cd367a3fb463f8fe0f7b87a6d4aa5b6e3d862720447432ea880
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / microcycler-0.1.25-cp39-abi3-macosx_10_12_x86_64.whl
| Download URL | microcycler-0.1.25-cp39-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 3.7 MB |
| Tags | CPython 3.9 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
dff1117e7efe1c59e4f80feeee429821afd6495f3a5799711f0aa456d454c185
|
|
BLAKE2b-256 checksum How to use checksums |
bc5f7a1e405c923118ea0ba083ec5fb498e934bec0d12097b3c8d547e31ead9d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Security for microcycler 0.1.25
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
