Skip to content

pyclickplc

Talk to AutomationDirect CLICK PLCs from Python. Read and write registers over Modbus TCP, simulate a PLC for local development, and manage CLICK nickname and DataView files.

It's the wire under pyrung and ClickNick, and it stands on its own as a Modbus client for any CLICK.

Start here

The quickstart connects to a simulated PLC, reads and writes values, and generates project files. No hardware needed.

Guides

Client Read and write PLC values with ClickClient
Types & values Native Python types per bank family
Addressing Normalization, sparse X/Y ranges, XD/YD display indexing
Modbus Service Sync + polling API for UI applications
Server & simulator Simulate a CLICK PLC with ClickServer
File I/O Nickname CSV and DataView CDV read/write
Examples Runnable scripts

API Reference

Auto-generated from source. See API Reference overview for the full list.

API stability

The public API is stable: client, service, server, file I/O, address, and validation. The low-level Modbus mapping helpers and bank metadata (ModbusMapping, plc_to_modbus, BANKS) may still change between minor versions.