Skip to content

API Reference

This section is a fast lookup for the public interfaces provided by rtd-acquire. For concepts and task-oriented explanations, use the main Documentation.

Python API

The Python API in the current rtd-acquire 0.2.0 release includes:

  • Core contracts — AcquisitionDevice, Measurement, diagnostics, and exceptions.
  • max31865 — MAX31865 configuration, driver, timing, and SPI emulator.
  • simulation — deterministic generic acquisition simulation.
  • transports — SPI contracts and Linux spidev adapter.

Portable C API

The independent portable C11 implementation is included in rtd-acquire 0.2.0. Its public contracts live in a separate API area so the C interfaces are not mixed into the Python module reference.

  • Portable C API overview — portability and ownership rules.
  • Core result contracts — caller-owned measurement, diagnostic, and native-evidence storage.
  • HAL interfaces — capability-specific SPI and blocking-delay contracts.
  • MAX31865 — portable C configuration, threshold encoding, native decoding, and fault-checked one-shot acquisition.
  • Arduino AVR / HERO — UNO-class SPI and blocking-delay bindings for the portable C driver.

Portable C distribution

The portable C sources, tests, conformance artifacts, and Arduino AVR / HERO adapter ship in the 0.2.0 source distribution and repository. The Python wheel intentionally contains only the Python package.

From resistance to temperature

The API stops at acquisition. For RTD model APIs and interactive model experiments, continue to rtd-sensor.

Visit the RTD Playground