Package com.tinkerforge
Class BrickletIndustrialQuadRelay
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletIndustrialQuadRelay
-
public class BrickletIndustrialQuadRelay extends Device
4 galvanically isolated solid state relays
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletIndustrialQuadRelay.Monoflop
static interface
BrickletIndustrialQuadRelay.MonoflopDoneListener
This listener is triggered whenever a monoflop timer reaches 0.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEVICE_DISPLAY_NAME
static int
DEVICE_IDENTIFIER
static byte
FUNCTION_GET_AVAILABLE_FOR_GROUP
static byte
FUNCTION_GET_GROUP
static byte
FUNCTION_GET_IDENTITY
static byte
FUNCTION_GET_MONOFLOP
static byte
FUNCTION_GET_VALUE
static byte
FUNCTION_SET_GROUP
static byte
FUNCTION_SET_MONOFLOP
static byte
FUNCTION_SET_SELECTED_VALUES
static byte
FUNCTION_SET_VALUE
-
Constructor Summary
Constructors Constructor Description BrickletIndustrialQuadRelay(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addMonoflopDoneListener(BrickletIndustrialQuadRelay.MonoflopDoneListener listener)
Adds a MonoflopDone listener.short
getAvailableForGroup()
Returns a bitmask of ports that are available for grouping.char[]
getGroup()
Returns the group as set bysetGroup(char[])
Device.Identity
getIdentity()
Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.BrickletIndustrialQuadRelay.Monoflop
getMonoflop(short pin)
Returns (for the given pin) the current value and the time as set bysetMonoflop(int, int, long)
as well as the remaining time until the value flips.int
getValue()
Returns the bitmask as set bysetValue(int)
.void
removeMonoflopDoneListener(BrickletIndustrialQuadRelay.MonoflopDoneListener listener)
Removes a MonoflopDone listener.void
setGroup(char[] group)
Sets a group of Quad Relay Bricklets that should work together.void
setMonoflop(int selectionMask, int valueMask, long time)
Configures a monoflop of the pins specified by the first parameter bitmask.void
setSelectedValues(int selectionMask, int valueMask)
Sets the output value with a bitmask, according to the selection mask.void
setValue(int valueMask)
Sets the output value with a bitmask (16bit).-
Methods inherited from class com.tinkerforge.DeviceBase
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
-
-
-
-
Field Detail
-
DEVICE_IDENTIFIER
public static final int DEVICE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEVICE_DISPLAY_NAME
public static final java.lang.String DEVICE_DISPLAY_NAME
- See Also:
- Constant Field Values
-
FUNCTION_SET_VALUE
public static final byte FUNCTION_SET_VALUE
- See Also:
- Constant Field Values
-
FUNCTION_GET_VALUE
public static final byte FUNCTION_GET_VALUE
- See Also:
- Constant Field Values
-
FUNCTION_SET_MONOFLOP
public static final byte FUNCTION_SET_MONOFLOP
- See Also:
- Constant Field Values
-
FUNCTION_GET_MONOFLOP
public static final byte FUNCTION_GET_MONOFLOP
- See Also:
- Constant Field Values
-
FUNCTION_SET_GROUP
public static final byte FUNCTION_SET_GROUP
- See Also:
- Constant Field Values
-
FUNCTION_GET_GROUP
public static final byte FUNCTION_GET_GROUP
- See Also:
- Constant Field Values
-
FUNCTION_GET_AVAILABLE_FOR_GROUP
public static final byte FUNCTION_GET_AVAILABLE_FOR_GROUP
- See Also:
- Constant Field Values
-
FUNCTION_SET_SELECTED_VALUES
public static final byte FUNCTION_SET_SELECTED_VALUES
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletIndustrialQuadRelay
public BrickletIndustrialQuadRelay(java.lang.String uid, IPConnection ipcon)
Creates an object with the unique device ID \c uid. and adds it to the IP Connection \c ipcon.
-
-
Method Detail
-
setValue
public void setValue(int valueMask) throws TinkerforgeException
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 (seesetGroup(char[])
), 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.- Throws:
TinkerforgeException
-
getValue
public int getValue() throws TinkerforgeException
Returns the bitmask as set bysetValue(int)
.- Throws:
TinkerforgeException
-
setMonoflop
public void setMonoflop(int selectionMask, int valueMask, long time) throws TinkerforgeException
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 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.- Throws:
TinkerforgeException
-
getMonoflop
public BrickletIndustrialQuadRelay.Monoflop getMonoflop(short pin) throws TinkerforgeException
Returns (for the given pin) the current value and the time as set bysetMonoflop(int, int, long)
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.- Throws:
TinkerforgeException
-
setGroup
public void setGroup(char[] group) throws TinkerforgeException
Sets a group of Quad Relay Bricklets that should work together. You can find Bricklets that can be grouped together withgetAvailableForGroup()
. 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 callsetValue(int)
and control two Bricklets at the same time.- Throws:
TinkerforgeException
-
getGroup
public char[] getGroup() throws TinkerforgeException
Returns the group as set bysetGroup(char[])
- Throws:
TinkerforgeException
-
getAvailableForGroup
public short getAvailableForGroup() throws TinkerforgeException
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.- Throws:
TinkerforgeException
-
setSelectedValues
public void setSelectedValues(int selectionMask, int valueMask) throws TinkerforgeException
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 (seesetGroup(char[])
), 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.- Throws:
TinkerforgeException
-
getIdentity
public Device.Identity getIdentity() throws TinkerforgeException
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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'. The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|- Specified by:
getIdentity
in classDevice
- Throws:
TinkerforgeException
-
addMonoflopDoneListener
public void addMonoflopDoneListener(BrickletIndustrialQuadRelay.MonoflopDoneListener listener)
Adds a MonoflopDone listener.
-
removeMonoflopDoneListener
public void removeMonoflopDoneListener(BrickletIndustrialQuadRelay.MonoflopDoneListener listener)
Removes a MonoflopDone listener.
-
-