Skip to content

Client API

Tier: Stable Core

Async client and response mapping APIs.

Client Surface

  • Dynamic bank accessors: plc.ds, plc.df, plc.y, plc.txt, etc.
  • Display-indexed accessors: plc.xd and plc.yd use display indices 0..8.
  • Upper-byte aliases: plc.xd0u and plc.yd0u expose XD0u / YD0u.
  • String-address interface: plc.addr.read(...) and plc.addr.write(...).
  • Nickname/tag interface: plc.tag.read(...), plc.tag.write(...), and plc.tag.read_all(...).

Because accessor attributes are dynamic, this section is hand-curated and complements docstring-generated signatures below.

pyclickplc.ClickClient

Async Modbus TCP driver for CLICK PLCs.

pyclickplc.ModbusResponse

Bases: AddressNormalizerMixin, Mapping[str, TValue_co], Generic[TValue_co]

Immutable mapping with normalized PLC address keys.

Keys are stored in canonical uppercase form (DS1, X001). Look-ups normalise the key automatically, so response["ds1"] and response["DS1"] both work.