Python - Industrial Digital In 4 Bricklet 2.0

This is the description of the Python API bindings for the Industrial Digital In 4 Bricklet 2.0. General information and technical specifications for the Industrial Digital In 4 Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Python API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_industrial_digital_in_4_v2 import BrickletIndustrialDigitalIn4V2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    idi4 = BrickletIndustrialDigitalIn4V2(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Get current value
    value = idi4.get_value()

    print("Channel 0: " + str(value[0]))
    print("Channel 1: " + str(value[1]))
    print("Channel 2: " + str(value[2]))
    print("Channel 3: " + str(value[3]))

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Callback

Download (example_callback.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_industrial_digital_in_4_v2 import BrickletIndustrialDigitalIn4V2

# Callback function for value callback
def cb_value(channel, changed, value):
    print("Channel: " + str(channel))
    print("Changed: " + str(changed))
    print("Value: " + str(value))
    print("")

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    idi4 = BrickletIndustrialDigitalIn4V2(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Register value callback to function cb_value
    idi4.register_callback(idi4.CALLBACK_VALUE, cb_value)

    # Set period for value (channel 1) callback to 0.1s (100ms)
    idi4.set_value_callback_configuration(1, 100, False)

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

Edge Count

Download (example_edge_count.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

import time

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_industrial_digital_in_4_v2 import BrickletIndustrialDigitalIn4V2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    idi4 = BrickletIndustrialDigitalIn4V2(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Configure rising edge count (channel 3) with 10ms debounce
    idi4.set_edge_count_configuration(3, 0, 10)

    # Get edge count 10 times with 1s delay
    for i in range(10):
        time.sleep(1)

        # Get current edge count
        count = idi4.get_edge_count(3, False)
        print("Count: " + str(count))

    raw_input("Press key to exit\n") # Use input() in Python 3
    ipcon.disconnect()

API

Generally, every method of the Python bindings can throw an tinkerforge.ip_connection.Error exception that has a value and a description property. value can have different values:

  • Error.TIMEOUT = -1
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12

All methods listed below are thread-safe.

Basic Functions

BrickletIndustrialDigitalIn4V2(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

industrial_digital_in_4_v2 = BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

BrickletIndustrialDigitalIn4V2.get_value()
Return type:[bool, bool, bool, bool]

Returns the input value as bools, true refers to high and false refers to low.

BrickletIndustrialDigitalIn4V2.set_channel_led_config(channel, config)
Parameters:
  • channel -- int
  • config -- int
Return type:

None

Each channel has a corresponding LED. You can turn the LED off, on or show a heartbeat. You can also set the LED to "Channel Status". In this mode the LED is on if the channel is high and off otherwise.

By default all channel LEDs are configured as "Channel Status".

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
BrickletIndustrialDigitalIn4V2.get_channel_led_config(channel)
Parameters:channel -- int
Return type:int

Returns the channel LED configuration as set by set_channel_led_config()

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Advanced Functions

BrickletIndustrialDigitalIn4V2.get_edge_count(channel, reset_counter)
Parameters:
  • channel -- int
  • reset_counter -- bool
Return type:

int

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with set_edge_count_configuration().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
BrickletIndustrialDigitalIn4V2.set_edge_count_configuration(channel, edge_type, debounce)
Parameters:
  • channel -- int
  • edge_type -- int
  • debounce -- int
Return type:

None

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

  • 0 = rising (default)
  • 1 = falling
  • 2 = both

The debounce time is given in ms.

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

Default values: 0 (edge type) and 100ms (debounce time)

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2
BrickletIndustrialDigitalIn4V2.get_edge_count_configuration(channel)
Parameters:channel -- int
Return type:(int, int)

Returns the edge type and debounce time for the selected channel as set by set_edge_count_configuration().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2

The returned namedtuple has the variables edge_type and debounce.

BrickletIndustrialDigitalIn4V2.get_api_version()
Return type:[int, int, int]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletIndustrialDigitalIn4V2.get_response_expected(function_id)
Parameters:function_id -- int
Return type:bool

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by set_response_expected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See set_response_expected() for the list of function ID constants available for this function.

BrickletIndustrialDigitalIn4V2.set_response_expected(function_id, response_expected)
Parameters:
  • function_id -- int
  • response_expected -- bool
Return type:

None

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248
BrickletIndustrialDigitalIn4V2.set_response_expected_all(response_expected)
Parameters:response_expected -- bool
Return type:None

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletIndustrialDigitalIn4V2.get_spitfp_error_count()
Return type:(int, int, int, int)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

The returned namedtuple has the variables error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

BrickletIndustrialDigitalIn4V2.set_bootloader_mode(mode)
Parameters:mode -- int
Return type:int

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletIndustrialDigitalIn4V2.get_bootloader_mode()
Return type:int

Returns the current bootloader mode, see set_bootloader_mode().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletIndustrialDigitalIn4V2.set_write_firmware_pointer(pointer)
Parameters:pointer -- int
Return type:None

Sets the firmware pointer for write_firmware(). The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletIndustrialDigitalIn4V2.write_firmware(data)
Parameters:data -- [int, int, ..61x.., int]
Return type:int

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer() before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletIndustrialDigitalIn4V2.set_status_led_config(config)
Parameters:config -- int
Return type:None

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIndustrialDigitalIn4V2.get_status_led_config()
Return type:int

Returns the configuration as set by set_status_led_config()

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletIndustrialDigitalIn4V2.get_chip_temperature()
Return type:int

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletIndustrialDigitalIn4V2.reset()
Return type:None

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletIndustrialDigitalIn4V2.write_uid(uid)
Parameters:uid -- int
Return type:None

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletIndustrialDigitalIn4V2.read_uid()
Return type:int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletIndustrialDigitalIn4V2.get_identity()
Return type:(str, str, chr, [int, int, int], [int, int, int], int)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned namedtuple has the variables uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletIndustrialDigitalIn4V2.register_callback(callback_id, function)
Parameters:
  • callback_id -- int
  • function -- callable
Return type:

None

Registers the given function with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletIndustrialDigitalIn4V2.set_value_callback_configuration(channel, period, value_has_to_change)
Parameters:
  • channel -- int
  • period -- int
  • value_has_to_change -- bool
Return type:

None

This callback can be configured per channel.

The period in ms is the period with which the CALLBACK_VALUE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
BrickletIndustrialDigitalIn4V2.get_value_callback_configuration(channel)
Parameters:channel -- int
Return type:(int, bool)

Returns the callback configuration for the given channel as set by set_value_callback_configuration().

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3

The returned namedtuple has the variables period and value_has_to_change.

BrickletIndustrialDigitalIn4V2.set_all_value_callback_configuration(period, value_has_to_change)
Parameters:
  • period -- int
  • value_has_to_change -- bool
Return type:

None

The period in ms is the period with which the CALLBACK_ALL_VALUE callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

BrickletIndustrialDigitalIn4V2.get_all_value_callback_configuration()
Return type:(int, bool)

Returns the callback configuration as set by set_all_value_callback_configuration().

The returned namedtuple has the variables period and value_has_to_change.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the register_callback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

def my_callback(param):
    print(param)

industrial_digital_in_4_v2.register_callback(BrickletIndustrialDigitalIn4V2.CALLBACK_EXAMPLE, my_callback)

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletIndustrialDigitalIn4V2.CALLBACK_VALUE
Parameters:
  • channel -- int
  • changed -- bool
  • value -- bool

This callback is triggered periodically according to the configuration set by set_value_callback_configuration().

The parameters are the channel, a value-changed indicator and the actual value for the channel. The changed parameter is true if the value has changed since the last callback.

The following constants are available for this function:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
BrickletIndustrialDigitalIn4V2.CALLBACK_ALL_VALUE
Parameters:
  • changed -- [bool, bool, bool, bool]
  • value -- [bool, bool, bool, bool]

This callback is triggered periodically according to the configuration set by set_all_value_callback_configuration().

The parameters are the same as get_value(). Additional the changed parameter is true if the value has changed since the last callback.

Constants

BrickletIndustrialDigitalIn4V2.DEVICE_IDENTIFIER

This constant is used to identify a Industrial Digital In 4 Bricklet 2.0.

The get_identity() function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletIndustrialDigitalIn4V2.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Digital In 4 Bricklet 2.0.