Skip to main content

clickplc

Python driver and command-line tool for Koyo Ethernet ClickPLCs.

Installation

uv pip install clickplc

Usage

Command Line

$ clickplc the-plc-ip-address

This will print all the X, Y, DS, and DF registers to stdout as JSON. You can pipe this as needed. However, you'll likely want the python functionality below.

Python

This uses Python async/await syntax to asynchronously communicate with a ClickPLC. For example:

import asyncio
from clickplc import ClickPLC

async def get():
    async with ClickPLC('the-plc-ip-address') as plc:
        print(await plc.get('df1-df500'))

asyncio.run(get())

The entire API is get and set, and takes a range of inputs:

>>> await plc.get('df1')
0.0
>>> await plc.get('df1-df20')
{'df1': 0.0, 'df2': 0.0, ..., 'df20': 0.0}
>>> await plc.get('y101-y316')
{'y101': False, 'y102': False, ..., 'y316': False}

>>> await plc.set('df1', 0.0)  # Sets DF1 to 0.0
>>> await plc.set('df1', [0.0, 0.0, 0.0])  # Sets DF1-DF3 to 0.0.
>>> await plc.set('y101', True)  # Sets Y101 to true

Currently, the following datatypes are supported:

x bool Input point R
y bool Output point RW
c bool (C)ontrol relay RW
t bool (T)imer R
ct bool (C)oun(t)er R
ds int16 (D)ata register, (s)ingle signed int RW
dd int32 (D)ata register, (d)double signed int RW
dh uint16 (D) register, (h)ex RW
df float (D)ata register, (f)loating point RW
td int16 (T)ime (d)elay register RW
ctd int32 (C)oun(t)er Current Values, (d)ouble int RW
sd int16 (S)ystem (D)ata register R*
txt char (T)e(xt) RW

* Note: Only certain System Data registers are writeable.

Tags / Nicknames

Recent ClickPLC software provides the ability to export a "tags file", which contains all variables with user-assigned nicknames. The tags file can be used with this driver to improve code readability. (Who really wants to think about modbus addresses and register/coil types?)

To export a tags file, open the ClickPLC software, go to the Address Picker, select "Display MODBUS address", and export the file.

Once you have this file, simply pass the file path to the driver. You can now set variables by name and get all named variables by default.

async with ClickPLC('the-plc-ip-address', 'path-to-tags.csv') as plc:
    await plc.set('my-nickname', True)  # Set variable by nickname
    print(await plc.get())  # Get all named variables in tags file

Additionally, the tags file can be used with the commandline tool to provide more informative output:

$ clickplc the-plc-ip-address tags-filepath

Metadata

Release files for clickplc 0.15.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clickplc 0.15.0
File Size Uploaded Provenance Actions
clickplc-0.15.0.tar.gz 22.2 kB Without provenance Details for clickplc-0.15.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for clickplc 0.15.0
File Interpreter ABI Platform Actions
clickplc-0.15.0-py3-none-any.whl Python 3 none any Details for clickplc-0.15.0-py3-none-any.whl

Total release size: 43.6 kB

Release files / clickplc-0.15.0.tar.gz

Download URL clickplc-0.15.0.tar.gz
Size 22.2 kB
Tags Source
SHA-256 checksum
How to use checksums
4b854120422d1d2a7eacb4ba2f4f596b4aa5a71e5e703d82ae25d90a257ac982
BLAKE2b-256 checksum
How to use checksums
ccbfe35a75e60357da23d7e29234af0f2c368124b22cba35df0a136fd9949dc7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Release files / clickplc-0.15.0-py3-none-any.whl

Download URL clickplc-0.15.0-py3-none-any.whl
Size 21.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
75dabac7888defd42f0458ef0b274c8ec9709c63c567c1c53bd349a4c5fc98e4
BLAKE2b-256 checksum
How to use checksums
fc82c488f159370e14faf194e1ef995304d8ff2da60b2b13053c2e6a2ee64524
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.3

Security for clickplc 0.15.0

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.

Release history Release notifications | RSS feed

This release

0.15.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page