clickplc 0.3.0

Python driver for Koyo Ethernet ClickPLCs.

clickplc

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

Installation

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 ≥3.5's 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

Using named tags

The ClickPLC software provides the ability to export a file containing all the addresses in use along with their user assign nicknames. To export this file, open the Address Picker, select "Display MODBUS address" and export the file. If a path to this tags file is provided when the driver is initialized, tag nicknames can be used to set values. Calling .get() without arguments will return all named tags.

async with ClickPLC('the-plc-ip-address', 'path-to-tags-csv') as plc:
        await plc.set('myTagNickname', True)
        print(await plc.get())

Currently, only X, Y, C, DS, and DF are supported:

x	bool	Input point
y	bool	Output point
c	bool	(C)ontrol relay
df	float	(D)ata register, (f)loating point
ds	int16	(D)ata register, (s)igned int

I personally haven't needed to use the other categories, but they are straightforward to add if needed.