NAME

Tinkerforge::BrickletDualRelay - Two relays to switch AC/DC devices

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Dual Relay Bricklet.

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 Dual Relay Bricklet.

CALLBACK_MONOFLOP_DONE

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

FUNCTION_SET_STATE

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

FUNCTION_GET_STATE

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_SET_SELECTED_STATE

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_state()

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 :func:`Get State` or you can use :func:`Set Selected State`.

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

The default value is (*false*, *false*).

get_state()

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

set_monoflop()

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.

get_monoflop()

Returns (for the given relay) the current state and the time as set by :func:`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.

set_selected_state()

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

The other relay remains untouched.

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|