TCP/IP - Industrial Quad Relay Bricklet

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

API

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

Basic Functions

BrickletIndustrialQuadRelay.set_value
Function ID:
  • 1
Request:
  • value_mask – Type: uint16, Range: [0 to 216 - 1]
Response:
  • no response

Sets the output value with a bitmask (16bit). A 1 in the bitmask means relay closed and a 0 means relay open.

For example: The value 3 or 0b0011 will close the relay of pins 0-1 and open the other pins.

If no groups are used (see set_group), the pins correspond to the markings on the Industrial Quad Relay 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.

All running monoflop timers will be aborted if this function is called.

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

Returns the bitmask as set by set_value.

Advanced Functions

BrickletIndustrialQuadRelay.set_monoflop
Function ID:
  • 3
Request:
  • selection_mask – Type: uint16, Range: [0 to 216 - 1]
  • value_mask – Type: uint16, Range: [0 to 216 - 1]
  • time – Type: uint32, Range: [0 to 232 - 1]
Response:
  • no response

Configures a monoflop of the pins specified by the first parameter bitmask.

The second parameter is a bitmask with the desired value of the specified pins. A 1 in the bitmask means relay closed and a 0 means relay open.

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

If this function is called with the parameters (9, 1, 1500) or (0b1001, 0b0001, 1500): Pin 0 will close and pin 3 will open. In 1.5s pin 0 will open and pin 3 will close again.

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Quad Relay 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 closed. Pin 0 will be closed all the time. If now the RS485 connection is lost, then pin 0 will be opened in at most two seconds.

BrickletIndustrialQuadRelay.get_monoflop
Function ID:
  • 4
Request:
  • pin – Type: uint8, Range: [0 to 255]
Response:
  • value – Type: uint16, Range: [0 to 216 - 1]
  • time – Type: uint32, Range: [0 to 232 - 1]
  • time_remaining – Type: uint32, Range: [0 to 232 - 1]

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.

BrickletIndustrialQuadRelay.set_group
Function ID:
  • 5
Request:
  • group – Type: char[4]
Response:
  • no response

Sets a group of Quad Relay 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 Quad Relay Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Quad Relay on port A are assigned to 0-3 and the pins on the Quad Relay on port B are assigned to 4-7. It is now possible to call set_value and control two Bricklets at the same time.

BrickletIndustrialQuadRelay.get_group
Function ID:
  • 6
Request:
  • empty payload
Response:
  • group – Type: char[4]

Returns the group as set by set_group

BrickletIndustrialQuadRelay.get_available_for_group
Function ID:
  • 7
Request:
  • empty payload
Response:
  • available – Type: uint8, Range: [0 to 255]

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.

BrickletIndustrialQuadRelay.set_selected_values
Function ID:
  • 9
Request:
  • selection_mask – Type: uint16, Range: [0 to 216 - 1]
  • value_mask – Type: uint16, Range: [0 to 216 - 1]
Response:
  • no response

Sets the output value with a bitmask, according to the selection mask. The bitmask is 16 bit long, true refers to a closed relay and false refers to an open relay.

For example: The values (3, 1) or (0b0011, 0b0001) will close the relay of pin 0, open the relay of pin 1 and leave the others untouched.

If no groups are used (see set_group), the pins correspond to the markings on the Industrial Quad Relay 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.

Running monoflop timers for the selected relays will be aborted if this function is called.

BrickletIndustrialQuadRelay.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

Callbacks

BrickletIndustrialQuadRelay.CALLBACK_MONOFLOP_DONE
Function ID:
  • 8
Response:
  • selection_mask – Type: uint16, Range: [0 to 216 - 1]
  • value_mask – Type: uint16, Range: [0 to 216 - 1]

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).