Skip to content

API reference

Auto-generated from source docstrings via mkdocstrings-python. Every public name on the guide pages (Controllers, Commands, Parameters, Streaming, …) links back to the relevant reference section here.

Top-level

  • watlowlib — top-level re-exports (open_device, find_devices, WatlowManager, record, Recording, PollSourceAdapter, DiscoveryResult, DeviceSnapshot, WatlowDeviceSnapshot, pipe, the typed error hierarchy, the parameter registry, ProtocolKind, ControllerFamily, Capability, SafetyTier, …).
  • watlowlib.units — to_pint(unit) lossy mapping to pint-compatible unit strings.

Subpackages

  • watlowlib.transport — Transport Protocol, SerialTransport, FakeTransport, SerialSettings.
  • watlowlib.protocol — ProtocolKind, ProtocolClient, Std Bus and Modbus RTU clients / codecs / tables.
  • watlowlib.commands — Command[Req, Resp], StdBusVariant, ModbusVariant, the per-category command catalogue.
  • watlowlib.devices — Controller, Session, models (Reading, DeviceInfo, PartNumber, AlarmState, LoopState, DiscoveryResult, DeviceSnapshot, WatlowDeviceSnapshot, …), ControllerFamily, Capability, SafetyTier, open_device, discovery helpers.
  • watlowlib.manager — WatlowManager, DeviceResult, ErrorPolicy.
  • watlowlib.streaming — Sample, record(), OverflowPolicy, AcquisitionSummary, PollSource.
  • watlowlib.sinks — SampleSink Protocol, pipe(), first-party sinks (InMemory / CSV / JSONL / SQLite / Parquet / Postgres).
  • watlowlib.sync — sync facade over the async core.
  • watlowlib.registry — PARAMETERS, ParameterRegistry, ParameterSpec, RwesFlag, family table, enumerations, units.
  • watlowlib.testing — FakeTransport, FakeSlave, fixture parsers, controller_from_fixture.
  • watlowlib.errors — typed exception hierarchy and ErrorContext.
  • watlowlib.firmware — FirmwareVersion.
  • watlowlib.config — Defaults.
  • watlowlib.maintenance — port-level change_baud, change_modbus_address, change_stdbus_address, change_protocol_mode helpers.