TCP/IP - Dual Relay Bricklet

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

A tutorial on how to test the Dual Relay 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

DualRelay.set_state

Function ID:

1

Request:

• relay1 – bool
• relay2 – bool

Response:

no response

Sets the state of the relays, true means on and false means off. For example: (true, false) turns relay 1 on and relay 2 off.

If you just want to set one of the relays and don’t know the current state of the other relay, you can get the state with get_state or you can use set_selected_state.

Running monoflop timers will be overwritten if this function is called.

The default value is (false, false).

DualRelay.get_state

Function ID:

2

Request:

empty payload

Response:

• relay1 – bool
• relay2 – bool

Returns the state of the relays, true means on and false means off.

Advanced Functions

DualRelay.set_monoflop

Function ID:

3

Request:

• relay – uint8
• state – bool
• time – uint32

Response:

no response

The first parameter can be 1 or 2 (relay 1 or relay 2). The second parameter is the desired state of the relay (true means on and false means off). The third parameter indicates the time (in ms) that the relay should hold the state.

If this function is called with the parameters (1, true, 1500): Relay 1 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 Dual Relay Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The relay will be on all the time. If now the RS485 connection is lost, the relay will turn off in at most two seconds.

New in version 1.1.1 (Plugin).

DualRelay.get_monoflop

Function ID:

4

Request:

• relay – uint8

Response:

• state – bool
• time – uint32
• time_remaining – uint32

Returns (for the given relay) the current state and the time as set by set_monoflop as well as the remaining time until the state flips.

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

New in version 1.1.1 (Plugin).

DualRelay.set_selected_state

Function ID:

6

Request:

• relay – uint8
• state – bool

Response:

no response

Sets the state of the selected relay (1 or 2), true means on and false means off.

The other relay remains untouched.

New in version 2.0.0 (Plugin).

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

Callbacks

DualRelay.CALLBACK_MONOFLOP_DONE

Function ID:

5

Response:

• relay – uint8
• state – bool

This callback is triggered whenever a monoflop timer reaches 0. The parameter contain the relay (1 or 2) and the current state of the relay (the state after the monoflop).

New in version 1.1.1 (Plugin).

Constants

DualRelay.DEVICE_IDENTIFIER

Value:26

This constant is used to identify a DualRelay 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.