Package com.tinkerforge
Class BrickletIndustrialDigitalOut4
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletIndustrialDigitalOut4
-
public class BrickletIndustrialDigitalOut4 extends Device
4 galvanically isolated digital outputs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletIndustrialDigitalOut4.Monoflop
static interface
BrickletIndustrialDigitalOut4.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 BrickletIndustrialDigitalOut4(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(BrickletIndustrialDigitalOut4.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.BrickletIndustrialDigitalOut4.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(BrickletIndustrialDigitalOut4.MonoflopDoneListener listener)
Removes a MonoflopDone listener.void
setGroup(char[] group)
Sets a group of Digital Out 4 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
-
BrickletIndustrialDigitalOut4
public BrickletIndustrialDigitalOut4(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 high and a 0 in the bitmask means low. For example: The value 3 or 0b0011 will turn pins 0-1 high and the other pins low. If no groups are used (seesetGroup(char[])
), the pins correspond to the markings on the Industrial Digital Out 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. 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 high and a 0 in the bitmask means low. 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 get high and pin 3 will get low. In 1.5s pin 0 will get low and pin 3 will get high again. A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Digital Out 4 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 high. Pin 0 will be high all the time. If now the RS485 connection is lost, then pin 0 will turn low in at most two seconds.- Throws:
TinkerforgeException
-
getMonoflop
public BrickletIndustrialDigitalOut4.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 Digital Out 4 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 Digital Out 4 Bricklets connected to port A and port B respectively, you could call with ``['a', 'b', 'n', 'n']``. Now the pins on the Digital Out 4 on port A are assigned to 0-3 and the pins on the Digital Out 4 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 high and *false* refers to low. For example: The values (3, 1) or (0b0011, 0b0001) will turn pin 0 high, pin 1 low the other pins remain untouched. If no groups are used (seesetGroup(char[])
), the pins correspond to the markings on the Industrial Digital Out 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. Running monoflop timers for the selected pins 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(BrickletIndustrialDigitalOut4.MonoflopDoneListener listener)
Adds a MonoflopDone listener.
-
removeMonoflopDoneListener
public void removeMonoflopDoneListener(BrickletIndustrialDigitalOut4.MonoflopDoneListener listener)
Removes a MonoflopDone listener.
-
-