TCP/IP - Industrial Digital In 4 Bricklet

This is the description of the TCP/IP protocol for the Industrial Digital In 4 Bricklet. General information and technical specifications for the Industrial Digital In 4 Bricklet are summarized in its hardware description.

API

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

Basic Functions

BrickletIndustrialDigitalIn4.get_value
Function ID:
  • 1
Request:
  • empty payload
Response:
  • value_mask – Type: uint16, Range: [0 to 216 - 1]

Returns the input value with a bitmask. The bitmask is 16bit long, true refers to high and false refers to low.

For example: The value 3 or 0b0011 means that pins 0-1 are high and the other pins are low.

If no groups are used (see set_group), the pins correspond to the markings on the IndustrialDigital In 4 Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

BrickletIndustrialDigitalIn4.get_edge_count
Function ID:
  • 10
Request:
  • pin – Type: uint8, Range: [0 to 3]
  • reset_counter – Type: bool
Response:
  • count – Type: uint32, Range: [0 to 232 - 1]

Returns the current value of the edge counter for the selected pin. You can configure the edges that are counted with set_edge_count_config.

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

The edge counters use the grouping as set by set_group.

New in version 2.0.1 (Plugin).

Advanced Functions

BrickletIndustrialDigitalIn4.set_group
Function ID:
  • 2
Request:
  • group – Type: char[4], Range: ['a' to 'd', 'n']
Response:
  • no response

Sets a group of Digital In 4 Bricklets that should work together. You can find Bricklets that can be grouped together with get_available_for_group.

The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

For example: If you have two Digital In 4 Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Digital In 4 on port A are assigned to 0-3 and the pins on the Digital In 4 on port B are assigned to 4-7. It is now possible to call get_value and read out two Bricklets at the same time.

Changing the group configuration resets all edge counter configurations and values.

BrickletIndustrialDigitalIn4.get_group
Function ID:
  • 3
Request:
  • empty payload
Response:
  • group – Type: char[4], Range: ['a' to 'd', 'n']

Returns the group as set by set_group

BrickletIndustrialDigitalIn4.get_available_for_group
Function ID:
  • 4
Request:
  • empty payload
Response:
  • available – Type: uint8, Range: [0 to 15]

Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

BrickletIndustrialDigitalIn4.set_edge_count_config
Function ID:
  • 11
Request:
  • selection_mask – Type: uint16, Range: [0 to 216 - 1]
  • edge_type – Type: uint8, Range: See meanings, Default: 0
  • debounce – Type: uint8, Unit: 1 ms, Range: [0 to 255], Default: 100
Response:
  • no response

Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will enable the edge counter for pins 0 and 3.

The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are:

  • 0 = rising
  • 1 = falling
  • 2 = both

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.

The edge counters use the grouping as set by set_group.

The following meanings are defined for the elements of this function:

For edge_type:

  • 0 = Rising
  • 1 = Falling
  • 2 = Both

New in version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4.get_edge_count_config
Function ID:
  • 12
Request:
  • pin – Type: uint8, Range: [0 to 255]
Response:
  • edge_type – Type: uint8, Range: See meanings, Default: 0
  • debounce – Type: uint8, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time for the selected pin as set by set_edge_count_config.

The following meanings are defined for the elements of this function:

For edge_type:

  • 0 = Rising
  • 1 = Falling
  • 2 = Both

New in version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char
  • hardware_version – Type: uint8[3], Range: [0 to 255]
  • firmware_version – Type: uint8[3], Range: [0 to 255]
  • device_identifier – Type: uint16, Range: [0 to 216 - 1]

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

Callback Configuration Functions

BrickletIndustrialDigitalIn4.set_debounce_period
Function ID:
  • 5
Request:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:
  • no response

Sets the debounce period of the CALLBACK_INTERRUPT callback.

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 Digital In 4 Bricklet, such as a button.

BrickletIndustrialDigitalIn4.get_debounce_period
Function ID:
  • 6
Request:
  • empty payload
Response:
  • debounce – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by set_debounce_period.

BrickletIndustrialDigitalIn4.set_interrupt
Function ID:
  • 7
Request:
  • interrupt_mask – Type: uint16, Range: [0 to 216 - 1]
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 or 0b1001 will enable the interrupt for pins 0 and 3.

The interrupts use the grouping as set by set_group.

The interrupt is delivered with the CALLBACK_INTERRUPT callback.

BrickletIndustrialDigitalIn4.get_interrupt
Function ID:
  • 8
Request:
  • empty payload
Response:
  • interrupt_mask – Type: uint16, Range: [0 to 216 - 1]

Returns the interrupt bitmask as set by set_interrupt.

Callbacks

BrickletIndustrialDigitalIn4.CALLBACK_INTERRUPT
Function ID:
  • 9
Response:
  • interrupt_mask – Type: uint16, Range: [0 to 216 - 1]
  • value_mask – Type: uint16, Range: [0 to 216 - 1]

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) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-3 are low.
  • (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3 occurred and currently pin 0 is low and pins 1-3 are high.

The interrupts use the grouping as set by set_group.