-
-

Classes

+
+

Classes and Modules

Bus coupler

These classes are bus couplers and are used to connect the IO bus terminals to a Ethernet interface.

@@ -405,6 +1042,36 @@ +
+
+select(bus_terminal_type, terminal_number=0)
+

Returns the n-th bus terminal instance of the given bus terminal type and +terminal index.

+
+
Parameters:
+
    +
  • bus_terminals_type – The bus terminal class to select from.

  • +
  • terminal_number (int) – The index of the bus terminal to return. Counted for +all bus terminals of the same type, not all bus terminals. Started for the +first terminal with 0

  • +
+
+
Return type:
+

TypeVar(_BT, bound= BusTerminal)

+
+
Returns:
+

The selected bus terminal instance.

+
+
+

Example

+
>>> from pyhoff.devices import *
+>>> bk = BK9050("172.16.17.1", bus_terminals=[KL2404, KL2424])
+>>> # Select the first KL2425 terminal:
+>>> kl2404 = bk.select(KL2424, 0)
+
+
+
+
@@ -443,6 +1110,36 @@
+
+
+select(bus_terminal_type, terminal_number=0)
+

Returns the n-th bus terminal instance of the given bus terminal type and +terminal index.

+
+
Parameters:
+
    +
  • bus_terminals_type – The bus terminal class to select from.

  • +
  • terminal_number (int) – The index of the bus terminal to return. Counted for +all bus terminals of the same type, not all bus terminals. Started for the +first terminal with 0

  • +
+
+
Return type:
+

TypeVar(_BT, bound= BusTerminal)

+
+
Returns:
+

The selected bus terminal instance.

+
+
+

Example

+
>>> from pyhoff.devices import *
+>>> bk = BK9050("172.16.17.1", bus_terminals=[KL2404, KL2424])
+>>> # Select the first KL2425 terminal:
+>>> kl2404 = bk.select(KL2424, 0)
+
+
+
+
@@ -481,6 +1178,36 @@
+
+
+select(bus_terminal_type, terminal_number=0)
+

Returns the n-th bus terminal instance of the given bus terminal type and +terminal index.

+
+
Parameters:
+
    +
  • bus_terminals_type – The bus terminal class to select from.

  • +
  • terminal_number (int) – The index of the bus terminal to return. Counted for +all bus terminals of the same type, not all bus terminals. Started for the +first terminal with 0

  • +
+
+
Return type:
+

TypeVar(_BT, bound= BusTerminal)

+
+
Returns:
+

The selected bus terminal instance.

+
+
+

Example

+
>>> from pyhoff.devices import *
+>>> bk = BK9050("172.16.17.1", bus_terminals=[KL2404, KL2424])
+>>> # Select the first KL2425 terminal:
+>>> kl2404 = bk.select(KL2424, 0)
+
+
+
+
@@ -519,21 +1246,159 @@
+
+
+select(bus_terminal_type, terminal_number=0)
+

Returns the n-th bus terminal instance of the given bus terminal type and +terminal index.

+
+
Parameters:
+
    +
  • bus_terminals_type – The bus terminal class to select from.

  • +
  • terminal_number (int) – The index of the bus terminal to return. Counted for +all bus terminals of the same type, not all bus terminals. Started for the +first terminal with 0

  • +
+
+
Return type:
+

TypeVar(_BT, bound= BusTerminal)

+
+
Returns:
+

The selected bus terminal instance.

+
+
+

Example

+
>>> from pyhoff.devices import *
+>>> bk = BK9050("172.16.17.1", bus_terminals=[KL2404, KL2424])
+>>> # Select the first KL2425 terminal:
+>>> kl2404 = bk.select(KL2424, 0)
+
+
+
+

Beckhoff bus terminals

+
+
+class pyhoff.devices.KL1002(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1002: 2-channel digital input, 24 V DC, 3 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1012(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1012: 2-channel digital input, 24 V DC, 0.2 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1032(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1032: 2-channel digital input, 48 V DC, 3 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1052(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1052: 2-channel digital input, 24 V DC, 3 ms, positive/ground +switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
class pyhoff.devices.KL1104(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: DigitalInputTerminal4Bit

+

Bases: DigitalInputTerminal4Bit

KL1104: 4x digital input 24 V

-
-
-parameters: dict[str, int] = {'input_bit_width': 4}
-
-
read_input(channel)
@@ -556,16 +1421,512 @@
+
+
+class pyhoff.devices.KL1114(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1114: 4-channel digital input, 24 V DC, 0.2 ms, 2-/3-wire connection +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1124(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1124: 4-channel digital input, 5 V DC, 0.2 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1154(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1154: 4-channel digital input, 24 V DC, 3 ms, positive/ground +switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1164(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1164: 4-channel digital input, 24 V DC, 0.2 ms, positive/ground +switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1184(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1184: 4-channel digital input, 24 V DC, 3 ms, ground switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1194(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1194: 4-channel digital input, 24 V DC, 0.2 ms, ground switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1212(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL1212: 2-channel digital input, 24 V DC, 3 ms, with diagnostics +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1232(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1232: 2-channel digital input, 24 V DC, 0.2 ms, pulse extension +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1302(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1302: 2-channel digital input, 24 V DC, 3 ms, type 2 +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1304(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1304: 4-channel digital input, 24 V DC, 3 ms, type 2 +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1312(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1312: 2-channel digital input, 24 V DC, 0.2 ms, type 2 +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1314(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1314: 4-channel digital input, 24 V DC, 0.2 ms, type 2 +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1352(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1352: 2-channel digital input, NAMUR +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1362(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1362: 2-channel digital input, break-in alarm, 24 V DC, 3 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1382(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1382: 2-channel digital input, thermistor, 24 V DC, 30 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1402(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1402: 2-channel digital input, 24 V DC, 3 ms, 2-wire connection +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1404(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1404: 4-channel digital input, 24 V DC, 3 ms, 2-wire connection +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
class pyhoff.devices.KL1408(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: DigitalInputTerminal8Bit

+

Bases: DigitalInputTerminal8Bit

KL1104: 8x digital input 24 V galvanic isolated

-
-
-parameters: dict[str, int] = {'input_bit_width': 8}
-
-
read_input(channel)
@@ -588,16 +1949,208 @@
+
+
+class pyhoff.devices.KL1412(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1412: 2-channel digital input, 24 V DC, 0.2 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1414(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1414: 4-channel digital input, 24 V DC, 0.2 ms, 2-wire connection +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1418(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1418: 8-channel digital input, 24 V DC, 0.2 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1434(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1434: 4-channel digital input, 24 V DC, 0.2 ms, type 2, 2-wire +connection +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1488(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1488: 8-channel digital input, 24 V DC, 3 ms, ground switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1498(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1498: 8-channel digital input, 24 V DC, 0.2 ms, ground switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1501(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1501: 1-channel digital input, counter, 24 V DC, 100 kHz +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
class pyhoff.devices.KL1512(bus_coupler, o_b_addr, i_b_addr, o_w_addr, i_w_addr, mixed_mapping)

Bases: AnalogInputTerminal

KL1512: 2x 16 bit counter, 24 V DC, 1 kHz

-
-
-parameters: dict[str, int] = {'input_word_width': 2}
-
-
read_channel_word(channel, error_value=-99999)
@@ -671,16 +2224,861 @@
+
+
+class pyhoff.devices.KL1702(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1702: 2-channel digital input, 120…230 V AC, 10 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1704(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1704: 4-channel digital input, 120…230 V AC, 10 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1712(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1712: 2-channel digital input, 120 V AC/DC, 10 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1722(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1722: 2-channel digital input, 120…230 V AC, 10 ms, without power +contacts +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1804(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1804: 4-channel digital input, 24 V DC, 3 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1808(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1808: 8-channel digital input, 24 V DC, 3 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1809(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1809: 16-channel digital input, 24 V DC, 3 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1814(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1814: 4-channel digital input, 24 V DC, 0.2 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1819(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1819: 16-channel digital input, 24 V DC, 0.2 ms +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1859(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL1859: 8-channel digital input + 8-channel digital output, 24 V DC, 3 +ms, 0.5 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1862(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1862: 16-channel digital input, 24 V DC, 3 ms, flat-ribbon cable +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1872(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1872: 16-channel digital input, 24 V DC, 0.2 ms, flat-ribbon cable +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL1889(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL1889: 16-channel digital input, 24 V DC, 3 ms, ground switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2012(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2012: 2-channel digital output, 24 V DC, 0.5 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2022(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2022: 2-channel digital output, 24 V DC, 2 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2032(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2032: 2-channel digital output, 24 V DC, 0.5 A, reverse voltage +protection +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2114(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2114: 4-channel digital output, 24 V DC, 0.5 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2124(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2124: 4-channel digital output, 5 V DC, 20 mA +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2134(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2134: 4-channel digital output, 24 V DC, 0.5 A, reverse voltage +protection +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2184(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2184: 4-channel digital output, 24 V DC, 0.5 A, ground switching +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2212(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2212: 2-channel digital output, 24 V DC, 0.5 A, with diagnostics +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2284(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2284: 4-channel digital output, reverse switching, 24 V DC, 2 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
class pyhoff.devices.KL2404(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: DigitalOutputTerminal4Bit

+

Bases: DigitalOutputTerminal4Bit

KL2404: 4x digital output with 500 mA

-
-
-parameters: dict[str, int] = {'output_bit_width': 4}
-
-
read_coil(channel)
@@ -729,14 +3127,9 @@
class pyhoff.devices.KL2408(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: DigitalOutputTerminal8Bit

+

Bases: DigitalOutputTerminal8Bit

750-530: 8x digital output with 24 V / 500 mA

Contact order for DO1 to DO8 is: 1, 5, 2, 6, 3, 7, 4, 8.

-
-
-parameters: dict[str, int] = {'output_bit_width': 8}
-
-
read_coil(channel)
@@ -785,13 +3178,8 @@
class pyhoff.devices.KL2424(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: DigitalOutputTerminal4Bit

+

Bases: DigitalOutputTerminal4Bit

KL2424: 4x digital output with 2000 mA

-
-
-parameters: dict[str, int] = {'output_bit_width': 4}
-
-
read_coil(channel)
@@ -837,16 +3225,583 @@
+
+
+class pyhoff.devices.KL2442(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2442: 2-channel digital output, 24 V DC, 2 x 4 A/1 x 8 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2488(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2488: 8-channel digital output, 24 V DC, 0.5 A, ground switching +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2502(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL2502: 2-channel PWM output, 24 V DC, 0.1 A +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2512(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL2512: 2-channel PWM output, 24 V DC, 1.5 A, ground switching +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2532(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL2532: 2-channel motion interface, DC motor, 24 V DC, 1 A +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2535(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL2535: 2-channel PWM output, 24 V DC, 1 A, current-controlled +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2541(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL2541: 1-channel motion interface, stepper motor, 48 V DC, 5 A, with +incremental encoder +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2542(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL2542: 2-channel motion interface, DC motor, 48 V DC, 3.5 A +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2545(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL2545: 2-channel PWM output, 8…50 V DC, 3.5 A, current-controlled +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2552(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

KL2552: 2-channel motion interface, DC motor, 48 V DC, 5 A +(Automatic generated stub)

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2602(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2602: 2-channel relay output, 230 V AC, 30 V DC, 5 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2612(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2612: 2-channel relay output, 125 V AC, 30 V DC, 0.5 A AC, 2 A DC +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2622(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2622: 2-channel relay output, 230 V AC, 30 V DC, 5 A, without power +contacts +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2631(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2631: 1-channel relay output, 400 V AC, 300 V DC, 2 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
class pyhoff.devices.KL2634(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: DigitalOutputTerminal4Bit

+

Bases: DigitalOutputTerminal4Bit

KL2634: 4x digital output 250 V AC, 30 V DC, 4 A

-
-
-parameters: dict[str, int] = {'output_bit_width': 4}
-
-
read_coil(channel)
@@ -892,16 +3847,1247 @@
+
+
+class pyhoff.devices.KL2641(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2641: 1-channel relay output, 230 V AC, 16 A, manual operation +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2652(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2652: 2-channel relay output, 230 V AC, 300 V DC, 5 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2701(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2701: 1-channel solid-state relay output, 0…230 V AC/DC, 3 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2712(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2712: 2-channel triac output, 12…230 V AC, 0.5 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2722(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2722: 2-channel triac output, 12…230 V AC, 1 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2732(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2732: 2-channel triac output, 12…230 V AC, 1 A, without power +contacts +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2751(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL2751: 1-channel universal dimmer, 230 V AC, 300 VA +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2761(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL2761: 1-channel universal dimmer, 230 V AC, 600 VA +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2784(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2784: 4-channel solid state relay output, 30 V AC, 48 V DC, 2 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2791(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL2791: 1-channel motion interface, AC motor, 230 V AC, 0.9 A +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2794(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2794: 4-channel solid state relay output, 30 V AC, 48 V DC, 2 A, +potential-free +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2798(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2798: 8-channel solid state relay output, 30 V AC, 48 V DC, 2 A, +potential-free +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2808(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2808: 8-channel digital output, 24 V DC, 0.5 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2809(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2809: 16-channel digital output, 24 V DC, 0.5 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2828(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2828: 8-channel digital output, 24 V DC, 2 A +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2872(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2872: 16-channel digital output, 24 V DC, 0.5 A, flat-ribbon cable +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL2889(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

KL2889: 16-channel digital output, 24 V DC, 0.5 A, ground switching +(Automatic generated stub)

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3001(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3001: 1-channel analog input, voltage, ±10 V, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3002(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3002: 2-channel analog input, voltage, ±10 V, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3011(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3011: 1-channel analog input, current, 0…20 mA, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3012(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3012: 2-channel analog input, current, 0…20 mA, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3021(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3021: 1-channel analog input, current, 4…20 mA, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3022(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3022: 2-channel analog input, current, 4…20 mA, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3041(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3041: 1-channel analog input, current, 0…20 mA, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+
class pyhoff.devices.KL3042(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: AnalogInputTerminal

KL3042: 2x analog input 0…20 mA 12 Bit single-ended

-
-
-parameters: dict[str, int] = {'input_word_width': 2}
-
-
read_channel_word(channel, error_value=-99999)
@@ -934,7 +5120,7 @@

float

Returns:
-

The current value.

+

The current value in mA.

@@ -958,16 +5144,146 @@
+
+
+class pyhoff.devices.KL3044(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3044: 4-channel analog input, current, 0…20 mA, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3051(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3051: 1-channel analog input, current, 4…20 mA, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3052(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3052: 2-channel analog input, current, 4…20 mA, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+
class pyhoff.devices.KL3054(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: AnalogInputTerminal

KL3054: 4x analog input 4…20 mA 12 Bit single-ended

-
-
-parameters: dict[str, int] = {'input_word_width': 4}
-
-
read_channel_word(channel, error_value=-99999)
@@ -1000,7 +5316,7 @@

float

Returns:
-

The current value.

+

The current value in mA.

@@ -1024,16 +5340,603 @@
+
+
+class pyhoff.devices.KL3061(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3061: 1-channel analog input, voltage, 0…10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3062(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3062: 2-channel analog input, voltage, 0…10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3064(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3064: 4-channel analog input, voltage, 0…10 V, 12 bit, single-ended, +with shield connector +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3102(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3102: 2-channel analog input, voltage, ±10 V, 16 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3112(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3112: 2-channel analog input, current, 0…20 mA, 16 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3122(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3122: 2-channel analog input, current, 4…20 mA, 16 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3132(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3132: 2-channel analog input, voltage, ±10 V, 16 bit, differential, +high-precision +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3142(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3142: 2-channel analog input, current, 0…20 mA, 16 bit, +differential, high-precision +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3152(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3152: 2-channel analog input, current, 4…20 mA, 16 bit, +differential, high-precision +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3162(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3162: 2-channel analog input, voltage, 0…10 V, 16 bit, differential, +high-precision +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3172(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3172: 2-channel analog input, voltage, 0…2 V, 16 bit, differential, +high-precision +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3182(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3182: 2-channel analog input, voltage, ±2 V, 16 bit, differential, +high-precision +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3201(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3201: 1-channel analog input, temperature, RTD (Pt100), 16 bit +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+
class pyhoff.devices.KL3202(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: AnalogInputTerminal

KL3202: 2x analog input PT100 16 Bit 3-wire

-
-
-parameters: dict[str, int] = {'input_word_width': 2}
-
-
read_channel_word(channel, error_value=-99999)
@@ -1090,16 +5993,56 @@
+
+
+class pyhoff.devices.KL3204(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3204: 4-channel analog input, temperature, RTD (Pt100), 16 bit +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+
class pyhoff.devices.KL3214(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: AnalogInputTerminal

KL3214: 4x analog input PT100 16 Bit 3-wire

-
-
-parameters: dict[str, int] = {'input_word_width': 4}
-
-
read_channel_word(channel, error_value=-99999)
@@ -1156,16 +6099,964 @@
+
+
+class pyhoff.devices.KL3222(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3222: 2-channel analog input, temperature, RTD (Pt100), 16 bit, +high-precision +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3228(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3228: 8-channel analog input, temperature, RTD (Pt1000, Ni1000), 16 +bit +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3311(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3311: 1-channel analog input, temperature, thermocouple, 16 bit +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3312(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3312: 2-channel analog input, temperature, thermocouple, 16 bit +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3314(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3314: 4-channel analog input, temperature, thermocouple, 16 bit +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3351(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3351: 1-channel analog input, measuring bridge, full bridge, 16 bit +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3356(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3356: 1-channel analog input, measuring bridge, full bridge, 16 bit, +high-precision +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3361(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL3361: 1-channel analog input, voltage, ±20 mV, 15 bit, oscilloscope +function +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3362(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL3362: 2-channel analog input, voltage, ±10 V, 15 bit, oscilloscope +function +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3403(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL3403: 3-channel analog input, power measurement, 500 V AC, 1 A, 16 +bit +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3404(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3404: 4-channel analog input, voltage, ±10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3408(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3408: 8-channel analog input, voltage, ±10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3444(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3444: 4-channel analog input, current, 0…20 mA, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3448(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3448: 8-channel analog input, current, 0…20 mA, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3454(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3454: 4-channel analog input, current, 4…20 mA, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3458(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3458: 8-channel analog input, current, 4…20 mA, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3464(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3464: 4-channel analog input, voltage, 0…10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL3468(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL3468: 8-channel analog input, voltage, 0…10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL4001(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4001: 1-channel analog output, voltage, 0…10 V, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
class pyhoff.devices.KL4002(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: AnalogOutputTerminal

KL4002: 2x analog output 0…10 V 12 Bit differentiell

-
-
-parameters: dict[str, int] = {'output_word_width': 2}
-
-
read_channel_word(channel, error_value=-99999)
@@ -1214,7 +7105,7 @@
Parameters:
  • channel (int) – The channel number to set.

  • -
  • value (float) – The voltage value to set.

  • +
  • value (float) – The voltage value to set in V.

Return type:
@@ -1253,11 +7144,6 @@ class pyhoff.devices.KL4004(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: AnalogOutputTerminal

KL4004: 4x analog output 0…10 V 12 Bit differentiell

-
-
-parameters: dict[str, int] = {'output_word_width': 4}
-
-
read_channel_word(channel, error_value=-99999)
@@ -1306,7 +7192,7 @@
Parameters:
  • channel (int) – The channel number to set.

  • -
  • value (float) – The voltage value to set.

  • +
  • value (float) – The voltage value to set in V.

Return type:
@@ -1340,16 +7226,560 @@
+
+
+class pyhoff.devices.KL4011(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4011: 1-channel analog output, current, 0…20 mA, 12 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL4012(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4012: 2-channel analog output, current, 0…20 mA, 12 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL4021(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4021: 1-channel analog output, current, 4…20 mA, 12 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL4022(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4022: 2-channel analog output, current, 4…20 mA, 12 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL4031(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4031: 1-channel analog output, voltage, ±10 V, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL4032(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4032: 2-channel analog output, voltage, ±10 V, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL4034(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4034: 4-channel analog output, voltage, ±10 V, 12 bit, differential +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.KL4112(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4112: 2-channel analog output, current, 0…20 mA, 16 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
class pyhoff.devices.KL4132(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: AnalogOutputTerminal

KL4002: 2x analog output ±10 V 16 bit differential

-
-
-parameters: dict[str, int] = {'output_word_width': 2}
-
-
read_channel_word(channel, error_value=-99999)
@@ -1398,7 +7828,7 @@
Parameters:
  • channel (int) – The channel number to set.

  • -
  • value (float) – The voltage value to set.

  • +
  • value (float) – The voltage value to set in V.

Return type:
@@ -1433,239 +7863,871 @@
-
-class pyhoff.devices.KL9010(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9010: End terminal -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4404(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4404: 4-channel analog output, voltage, 0…10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9070(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9070: Shield terminal -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4408(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4408: 8-channel analog output, voltage, 0…10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9080(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9080: Separation terminal -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4414(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4414: 4-channel analog output, current, 0…20 mA, 12 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9100(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9100: Potential supply terminal, 24 V DC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4418(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4418: 8-channel analog output, current, 0…20 mA, 12 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9150(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9150: Potential supply terminal, 120…230 V AC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4424(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4424: 4-channel analog output, current, 4…20 mA, 12 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9180(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9180: Potential distribution terminal, 2 x 24 V DC; 2 x 0 V DC, 2 x -PE -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4428(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4428: 8-channel analog output, current, 4…20 mA, 12 bit, +single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9184(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9184: potential distribution terminal, 8 x 24 V DC, 8 x 0 V DC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4434(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4434: 4-channel analog output, voltage, ±10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9185(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9185: potential distribution terminal, 4 x 24 V DC, 4 x 0 V DC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4438(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4438: 8-channel analog output, voltage, ±10 V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9186(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9186: Potential distribution terminal, 8 x 24 V DC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL4494(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL4494: 2-channel analog input + 2-channel analog output, voltage, ±10 +V, 12 bit, single-ended +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9187(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9187: Potential distribution terminal, 8 x 0 V DC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL5051(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL5051: 1-channel encoder interface, SSI, bidirectional +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9188(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9188: Potential distribution terminal, 16 x 24 V DC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL5101(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogInputTerminal

+

KL5101: 1-channel encoder interface, incremental, 5 V DC (DIFF RS422, +TTL), 1 MHz +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+read_normalized(channel)
+

Read a normalized value (0…1) from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number to read from.

+
+
Return type:
+

float

+
+
Returns:
+

The normalized value.

+
+
+
-
-class pyhoff.devices.KL9189(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9189: Potential distribution terminal, 16 x 0 V DC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
+
+class pyhoff.devices.KL5111(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL5111: 1-channel encoder interface, incremental, 24 V DC HTL, 250 kHz +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
+ +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
+
+ +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
+
-
-class pyhoff.devices.KL9190(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9190: Potential supply terminal, any voltage up to 230 V AC -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
- +
+class pyhoff.devices.KL5121(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: AnalogOutputTerminal

+

KL5121: 1-channel encoder interface, incremental, 24 V DC HTL, 250 +kHz, with 4 x digital output 24 V DC, linear path control +(Automatic generated stub)

+
+
+read_channel_word(channel, error_value=-99999)
+

Read a single word from the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to read from.

+
+
Return type:
+

int

+
+
Returns:
+

The read word value or provided error_value if read failed.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
-
-
-class pyhoff.devices.KL9195(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9195: Shield terminal -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
- +
+
+set_normalized(channel, value)
+

Set a normalized value between 0 and 1 to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number to set.

  • +
  • value (float) – The normalized value to set.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
-
-
-class pyhoff.devices.KL9200(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9200: Potential supply terminal, 24 V DC, with fuse -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
- +
+
+write_channel_word(channel, value)
+

Write a word to the terminal.

+
+
Parameters:
+

channel (int) – The channel number (1 based index) to write to.

+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded.

+
+
Raises:
+

Exception – If the word offset or count is out of range.

+
+
-
-
-class pyhoff.devices.KL9250(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9250: Potential supply terminal, 120…230 V AC, with fuse -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
- -
- -
-
-class pyhoff.devices.KL9290(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9290: Potential supply terminal, any voltage up to 230 V AC, with -fuse -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
- -
- -
-
-class pyhoff.devices.KL9380(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: BusTerminal

-

KL9380: Mains filter terminal for dimmers -(no I/O function)

-
-
-parameters: dict[str, int] = {}
-
-
@@ -1674,13 +8736,8 @@ fuse
class pyhoff.devices.WAGO_750_1405(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: DigitalInputTerminal16Bit

+

Bases: DigitalInputTerminal16Bit

750-1405: 16x digital input 24 V

-
-
-parameters: dict[str, int] = {'input_bit_width': 16}
-
-
read_input(channel)
@@ -1703,55 +8760,12 @@ fuse
-
-
-class pyhoff.devices.WAGO_750_352(host, port=502, bus_terminals=[], timeout=5, watchdog=0, debug=False)
-

Bases: BusCoupler

-

Wago 750-352 ModBus TCP bus coupler

-
-
-add_bus_terminals(*new_bus_terminals)
-

Add bus terminals to the bus coupler.

-
-
Parameters:
-

new_bus_terminals (Union[type[BusTerminal], Iterable[type[BusTerminal]]]) – bus terminal classes to add.

-
-
Return type:
-

list[BusTerminal]

-
-
Returns:
-

The corresponding list of bus terminal objects.

-
-
-
- -
-
-get_error()
-

Get the last error message.

-
-
Return type:
-

str

-
-
Returns:
-

The last error message.

-
-
-
- -
-
class pyhoff.devices.WAGO_750_530(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
-

Bases: DigitalOutputTerminal8Bit

+

Bases: DigitalOutputTerminal8Bit

750-530: 8x digital output with 24 V / 500 mA

Contact order for DO1 to DO8 is: 1, 5, 2, 6, 3, 7, 4, 8.

-
-
-parameters: dict[str, int] = {'output_bit_width': 8}
-
-
read_coil(channel)
@@ -1802,11 +8816,6 @@ fuse class pyhoff.devices.WAGO_750_600(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: BusTerminal

End terminal, no I/O function

-
-
-parameters: dict[str, int] = {}
-
-
@@ -1814,10 +8823,239 @@ fuse class pyhoff.devices.WAGO_750_602(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: BusTerminal

Potential supply terminal, no I/O function

-
-
-parameters: dict[str, int] = {}
-
+
+ +
+
+

Generic bus terminals

+
+
+class pyhoff.devices.DigitalInputTerminal16Bit(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

Generic 16 bit input terminal

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.DigitalInputTerminal4Bit(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

Generic 4 bit input terminal

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.DigitalInputTerminal8Bit(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalInputTerminal

+

Generic 8 bit input terminal

+
+
+read_input(channel)
+

Read the input from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The input value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.DigitalOutputTerminal16Bit(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

Generic 16 bit output terminal

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.DigitalOutputTerminal4Bit(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

Generic 4 bit output terminal

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+ +
+
+class pyhoff.devices.DigitalOutputTerminal8Bit(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)
+

Bases: DigitalOutputTerminal

+

Generic 8 bit output terminal

+
+
+read_coil(channel)
+

Read the coil value back from a specific channel.

+
+
Parameters:
+

channel (int) – The channel number (start counting from 1) to read from.

+
+
Return type:
+

bool | None

+
+
Returns:
+

The coil value of the specified channel or None if the read operation failed.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
+ +
+
+write_coil(channel, value)
+

Write a value to a specific channel.

+
+
Parameters:
+
    +
  • channel (int) – The channel number (start counting from 1) to write to.

  • +
  • value (bool) – The value to write.

  • +
+
+
Return type:
+

bool

+
+
Returns:
+

True if the write operation succeeded, otherwise False.

+
+
Raises:
+

Exception – If the channel number is out of range.

+
+
+
@@ -1830,11 +9068,6 @@ fuse class pyhoff.AnalogInputTerminal(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: BusTerminal

Base class for analog input terminals.

-
-
-parameters: dict[str, int] = {}
-
-
read_channel_word(channel, error_value=-99999)
@@ -1902,11 +9135,6 @@ first terminal with 0

class pyhoff.AnalogOutputTerminal(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: BusTerminal

Base class for analog output terminals.

-
-
-parameters: dict[str, int] = {}
-
-
read_channel_word(channel, error_value=-99999)
@@ -2103,11 +9331,6 @@ first terminal with 0

The parameters of the terminal.

-
-
-parameters: dict[str, int] = {}
-
-
classmethod select(bus_coupler, terminal_number=0)
@@ -2138,11 +9361,6 @@ first terminal with 0

class pyhoff.DigitalInputTerminal(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: BusTerminal

Base class for digital input terminals.

-
-
-parameters: dict[str, int] = {}
-
-
read_input(channel)
@@ -2193,11 +9411,6 @@ first terminal with 0

class pyhoff.DigitalOutputTerminal(bus_coupler, output_bit_addresses, input_bit_addresses, output_word_addresses, input_word_addresses, mixed_mapping)

Bases: BusTerminal

Base class for digital output terminals.

-
-
-parameters: dict[str, int] = {}
-
-
read_coil(channel)
diff --git a/objects.inv b/objects.inv index 6220e5b..89f5ec0 100644 Binary files a/objects.inv and b/objects.inv differ diff --git a/readme.html b/readme.html index 43c0bbb..5bb3fa5 100644 --- a/readme.html +++ b/readme.html @@ -19,7 +19,7 @@ - + @@ -57,7 +57,7 @@
  • License