API Documentation

iolink.get_port(interface)

Factory of specific instances of the abstract Port class.

Parameters:

interface (str) – ID of your IO-Link master device - currently only iqLink is supported.

class iolink.port.PortABC

Abstract base class that represents one Masters IO-Link port.

abstract change_device_state_to(target_state: str)

Sends a request to the device to change the state.

Parameters:

target_state (str) – allowed strings are ‘Inactive’, ‘PreOperate’ or ‘Operate’.

abstract get_device_pd_input_and_status() → Tuple[bytes, int]

Gets the input process data from a device and the state information.

abstract power_off()

Switches off the IO-Link power line of the port.

abstract power_on()

Switches on the IO-Link power line of the port.

abstract read_device_isdu(index: int, subindex: int)

Reads content of a parameter from the device.

abstract set_device_pd_output(data: bytes)

Sets the output process data for a device.

abstract write_device_isdu(index: int, subindex: int, data)

Writes content of a parameter from the device.

Make sure the size of the data matches the size of the devices parameter.