NAME

Tinkerforge::BrickletIO4V2 - 4-channel digital input/output

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a IO-4 Bricklet 2.0.

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

DEVICE_DISPLAY_NAME

This constant represents the display name of a IO-4 Bricklet 2.0.

CALLBACK_INPUT_VALUE

This constant is used with the register_callback() subroutine to specify the CALLBACK_INPUT_VALUE callback.

CALLBACK_ALL_INPUT_VALUE

This constant is used with the register_callback() subroutine to specify the CALLBACK_ALL_INPUT_VALUE callback.

CALLBACK_MONOFLOP_DONE

This constant is used with the register_callback() subroutine to specify the CALLBACK_MONOFLOP_DONE callback.

FUNCTION_SET_VALUE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_VALUE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_SELECTED_VALUE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_INPUT_VALUE_CALLBACK_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_MONOFLOP

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_MONOFLOP

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_EDGE_COUNT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_EDGE_COUNT_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_EDGE_COUNT_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_PWM_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_PWM_CONFIGURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_SPITFP_ERROR_COUNT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_BOOTLOADER_MODE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_BOOTLOADER_MODE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_WRITE_FIRMWARE_POINTER

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_WRITE_FIRMWARE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_STATUS_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_STATUS_LED_CONFIG

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CHIP_TEMPERATURE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_RESET

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_WRITE_UID

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_READ_UID

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

set_value()

Sets the output value of all four channels. A value of *true* or *false* outputs logic 1 or logic 0 respectively on the corresponding channel.

Use :func:`Set Selected Value` to change only one output channel state.

For example: (True, True, False, False) will turn the channels 0-1 high and the channels 2-3 low.

.. note:: This function does nothing for channels that are configured as input. Pull-up resistors can be switched on with :func:`Set Configuration`.

get_value()

Returns the logic levels that are currently measured on the channels. This function works if the channel is configured as input as well as if it is configured as output.

set_selected_value()

Sets the output value of a specific channel without affecting the other channels.

.. note:: This function does nothing for channels that are configured as input. Pull-up resistors can be switched on with :func:`Set Configuration`.

set_configuration()

Configures the value and direction of a specific channel. Possible directions are 'i' and 'o' for input and output.

If the direction is configured as output, the value is either high or low (set as *true* or *false*).

If the direction is configured as input, the value is either pull-up or default (set as *true* or *false*).

For example:

* (0, 'i', true) will set channel 0 as input pull-up. * (1, 'i', false) will set channel 1 as input default (floating if nothing is connected). * (2, 'o', true) will set channel 2 as output high. * (3, 'o', false) will set channel 3 as output low.

The default configuration is input with pull-up.

get_configuration()

Returns the channel configuration as set by :func:`Set Configuration`.

set_input_value_callback_configuration()

This callback can be configured per channel.

The period in ms is the period with which the :cb:`Input 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).

get_input_value_callback_configuration()

Returns the callback configuration for the given channel as set by :func:`Set Input Value Callback Configuration`.

set_all_input_value_callback_configuration()

The period in ms is the period with which the :cb:`All Input 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).

get_all_input_value_callback_configuration()

Returns the callback configuration as set by :func:`Set All Input Value Callback Configuration`.

set_monoflop()

The first parameter is the desired state of the channel (*true* means output *high* and *false* means output *low*). The second parameter indicates the time (in ms) that the channel should hold the state.

If this function is called with the parameters (true, 1500): The channel will turn on and in 1.5s it will turn off again.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a IO-4 Bricklet 2.0 is connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The channel will be *high* all the time. If now the RS485 connection is lost, the channel will turn *low* in at most two seconds.

get_monoflop()

Returns (for the given channel) the current value and the time as set by :func:`Set Monoflop` as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

get_edge_count()

Returns the current value of the edge counter for the selected channel. You can configure the edges that are counted with :func:`Set Edge Count Configuration`.

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

set_edge_count_configuration()

Configures the edge counter for a specific channel.

The edge type parameter configures if rising edges, falling edges or both are counted if the channel is configured for input. 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)

get_edge_count_configuration()

Returns the edge type and debounce time for the selected channel as set by :func:`Set Edge Count Configuration`.

set_pwm_configuration()

Activates a PWM for the given channel with the frequency given in 1/10Hz and the duty cycle given in 1/100%.

You need to set the channel to output before you call this function, otherwise it will be ignored. To turn the PWM off again, you can set the frequency to 0 or any other function that changes a value of the channel (e.g. :func:`Set Selected Value`).

The maximum frequency value is 320000000 (32MHz). The maximum duty cycle value is 10000 (100%).

The default values are 0, 0.

get_pwm_configuration()

Returns the PWM configuration as set by :func:`Set PWM Configuration`.

get_spitfp_error_count()

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.

set_bootloader_mode()

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.

get_bootloader_mode()

Returns the current bootloader mode, see :func:`Set Bootloader Mode`.

set_write_firmware_pointer()

Sets the firmware pointer for :func:`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.

write_firmware()

Writes 64 Bytes of firmware at the position as written by :func:`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.

set_status_led_config()

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.

get_status_led_config()

Returns the configuration as set by :func:`Set Status LED Config`

get_chip_temperature()

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.

reset()

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!

write_uid()

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.

read_uid()

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

get_identity()

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 :ref:`here <device_identifier>`. |device_identifier_constant|