TCP/IP - IO-4 Bricklet

This is the API description for the TCP/IP protocol of the IO-4 Bricklet. General information on what this device does and the technical specifications can be found here.

A tutorial on how to test the IO-4 Bricklet and get the first examples running can be found here.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

IO4.set_value

Function ID:

1

Request:

• value_mask – uint8

Response:

no response

Sets the output value (high or low) with a bitmask. The bitmask is 4 bit long, true refers to high and false refers to low.

For example: The value 0b0011 will turn the pins 0-1 high and the pins 2-3 low.

Note

This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with set_configuration.

IO4.get_value

Function ID:

2

Request:

empty payload

Response:

• value_mask – uint8

Returns a bitmask of the values that are currently measured. This function works if the pin is configured to input as well as if it is configured to output.

IO4.set_configuration

Function ID:

3

Request:

• selection_mask – uint8
• direction – char
• value – bool

Response:

no response

Configures the value and direction of the specified pins. 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:

• (15, ‘i’, true) will set all pins of as input pull-up.
• (8, ‘i’, false) will set pin 3 of as input default (floating if nothing is connected).
• (3, ‘o’, false) will set pins 0 and 1 as output low.
• (4, ‘o’, true) will set pin 2 of as output high.

IO4.get_configuration

Function ID:

4

Request:

empty payload

Response:

• direction_mask – uint8
• value_mask – uint8

Returns a value bitmask and a direction bitmask.

For example: A return value of 0b0011 and 0b0101 for direction and value means that:

• pin 0 is configured as input pull-up,
• pin 1 is configured as input default,
• pin 2 is configured as output high
• and pin 3 is are configured as output low.

Advanced Functions

IO4.set_monoflop

Function ID:

10

Request:

• selection_mask – uint8
• value_mask – uint8
• time – uint32

Response:

no response

Configures a monoflop of the pins specified by the first parameter as 4 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored.

The second parameter is a bitmask with the desired value of the specified output pins (true means high and false means low).

The third parameter indicates the time (in ms) that the pins should hold the value.

If this function is called with the parameters ((1 << 0) | (1 << 3), (1 << 0), 1500): Pin 0 will get high and pin 3 will get low. In 1.5s pin 0 will get low and pin 3 will get high again.

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and an IO-4 Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and pin 0 set to high. Pin 0 will be high all the time. If now the RS485 connection is lost, then pin 0 will get low in at most two seconds.

New in version 1.1.1 (Plugin).

IO4.get_monoflop

Function ID:

11

Request:

• pin – uint8

Response:

• value – uint8
• time – uint32
• time_remaining – uint32

Returns (for the given pin) the current value and the time as set by 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.

New in version 1.1.1 (Plugin).

IO4.set_selected_values

Function ID:

13

Request:

• selection_mask – uint8
• value_mask – uint8

Response:

no response

Sets the output value (high or low) with a bitmask, according to the selection mask. The bitmask is 4 bit long, true refers to high and false refers to low.

For example: The values 0b0110, 0b0011 will turn pin 2 high and pin 1 low, pin 0 and 3 will remain untouched.

Note

This function does nothing for pins that are configured as input. Pull-up resistors can be switched on with set_configuration.

New in version 2.0.0 (Plugin).

IO4.get_identity

Function ID:

255

Request:

empty payload

Response:

• uid – char[8]
• connected_uid – char[8]
• position – char
• hardware_version – uint8[3]
• firmware_version – uint8[3]
• device_identifier – uint16

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 identifiers can be found here.

New in version 2.0.0 (Plugin).

Callback Configuration Functions

IO4.set_debounce_period

Function ID:

5

Request:

• debounce – uint32

Response:

no response

Sets the debounce period of the CALLBACK_INTERRUPT callback in ms.

For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the IO-4 Bricklet, such as a button.

The default value is 100.

IO4.get_debounce_period

Function ID:

6

Request:

empty payload

Response:

• debounce – uint32

Returns the debounce period as set by set_debounce_period.

IO4.set_interrupt

Function ID:

7

Request:

• interrupt_mask – uint8

Response:

no response

Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.

For example: An interrupt bitmask of 9 will enable the interrupt for pins 0 and 3.

The interrupt is delivered with the callback CALLBACK_INTERRUPT.

IO4.get_interrupt

Function ID:

8

Request:

empty payload

Response:

• interrupt_mask – uint8

Returns the interrupt bitmask as set by set_interrupt.

Callbacks

IO4.CALLBACK_INTERRUPT

Function ID:

9

Response:

• interrupt_mask – uint8
• value_mask – uint8

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with set_interrupt.

The values are a bitmask that specifies which interrupts occurred and the current value bitmask.

For example:

• (1, 1) means that an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-3 are low.
• (9, 14) means that interrupts on pins 0 and 3 occurred and currently pin 0 is low and pins 1-3 are high.

IO4.CALLBACK_MONOFLOP_DONE

Function ID:

12

Response:

• selection_mask – uint8
• value_mask – uint8

This callback is triggered whenever a monoflop timer reaches 0. The response values contain the involved pins and the current value of the pins (the value after the monoflop).

New in version 1.1.1 (Plugin).

Constants

IO4.DEVICE_IDENTIFIER

Value:29

This constant is used to identify a IO4 Bricklet.

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.