Package com.tinkerforge
Class BrickletIO4
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletIO4
-
public class BrickletIO4 extends Device
4-channel digital input/output
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletIO4.Configuration
class
BrickletIO4.EdgeCountConfig
static interface
BrickletIO4.InterruptListener
This listener is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated withsetInterrupt(short)
.class
BrickletIO4.Monoflop
static interface
BrickletIO4.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 char
DIRECTION_IN
static char
DIRECTION_OUT
static short
EDGE_TYPE_BOTH
static short
EDGE_TYPE_FALLING
static short
EDGE_TYPE_RISING
static byte
FUNCTION_GET_CONFIGURATION
static byte
FUNCTION_GET_DEBOUNCE_PERIOD
static byte
FUNCTION_GET_EDGE_COUNT
static byte
FUNCTION_GET_EDGE_COUNT_CONFIG
static byte
FUNCTION_GET_IDENTITY
static byte
FUNCTION_GET_INTERRUPT
static byte
FUNCTION_GET_MONOFLOP
static byte
FUNCTION_GET_VALUE
static byte
FUNCTION_SET_CONFIGURATION
static byte
FUNCTION_SET_DEBOUNCE_PERIOD
static byte
FUNCTION_SET_EDGE_COUNT_CONFIG
static byte
FUNCTION_SET_INTERRUPT
static byte
FUNCTION_SET_MONOFLOP
static byte
FUNCTION_SET_SELECTED_VALUES
static byte
FUNCTION_SET_VALUE
-
Constructor Summary
Constructors Constructor Description BrickletIO4(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
addInterruptListener(BrickletIO4.InterruptListener listener)
Adds a Interrupt listener.void
addMonoflopDoneListener(BrickletIO4.MonoflopDoneListener listener)
Adds a MonoflopDone listener.BrickletIO4.Configuration
getConfiguration()
Returns a value bitmask and a direction bitmask.long
getDebouncePeriod()
Returns the debounce period as set bysetDebouncePeriod(long)
.long
getEdgeCount(short pin, boolean resetCounter)
Returns the current value of the edge counter for the selected pin.BrickletIO4.EdgeCountConfig
getEdgeCountConfig(short pin)
Returns the edge type and debounce time for the selected pin as set bysetEdgeCountConfig(short, short, short)
.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.short
getInterrupt()
Returns the interrupt bitmask as set bysetInterrupt(short)
.BrickletIO4.Monoflop
getMonoflop(short pin)
Returns (for the given pin) the current value and the time as set bysetMonoflop(short, short, long)
as well as the remaining time until the value flips.short
getValue()
Returns a bitmask of the values that are currently measured.void
removeInterruptListener(BrickletIO4.InterruptListener listener)
Removes a Interrupt listener.void
removeMonoflopDoneListener(BrickletIO4.MonoflopDoneListener listener)
Removes a MonoflopDone listener.void
setConfiguration(short selectionMask, char direction, boolean value)
Configures the value and direction of the specified pins.void
setDebouncePeriod(long debounce)
Sets the debounce period of theBrickletIO4.InterruptListener
listener.void
setEdgeCountConfig(short selectionMask, short edgeType, short debounce)
Configures the edge counter for the selected pins.void
setInterrupt(short interruptMask)
Sets the pins on which an interrupt is activated with a bitmask.void
setMonoflop(short selectionMask, short valueMask, long time)
Configures a monoflop of the pins specified by the first parameter as 4 bit long bitmask.void
setSelectedValues(short selectionMask, short valueMask)
Sets the output value (high or low) with a bitmask, according to the selection mask.void
setValue(short valueMask)
Sets the output value (high or low) with a bitmask (4bit).-
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_CONFIGURATION
public static final byte FUNCTION_SET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_CONFIGURATION
public static final byte FUNCTION_GET_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_SET_DEBOUNCE_PERIOD
public static final byte FUNCTION_SET_DEBOUNCE_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_GET_DEBOUNCE_PERIOD
public static final byte FUNCTION_GET_DEBOUNCE_PERIOD
- See Also:
- Constant Field Values
-
FUNCTION_SET_INTERRUPT
public static final byte FUNCTION_SET_INTERRUPT
- See Also:
- Constant Field Values
-
FUNCTION_GET_INTERRUPT
public static final byte FUNCTION_GET_INTERRUPT
- 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_SELECTED_VALUES
public static final byte FUNCTION_SET_SELECTED_VALUES
- See Also:
- Constant Field Values
-
FUNCTION_GET_EDGE_COUNT
public static final byte FUNCTION_GET_EDGE_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_EDGE_COUNT_CONFIG
public static final byte FUNCTION_SET_EDGE_COUNT_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_EDGE_COUNT_CONFIG
public static final byte FUNCTION_GET_EDGE_COUNT_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
DIRECTION_IN
public static final char DIRECTION_IN
- See Also:
- Constant Field Values
-
DIRECTION_OUT
public static final char DIRECTION_OUT
- See Also:
- Constant Field Values
-
EDGE_TYPE_RISING
public static final short EDGE_TYPE_RISING
- See Also:
- Constant Field Values
-
EDGE_TYPE_FALLING
public static final short EDGE_TYPE_FALLING
- See Also:
- Constant Field Values
-
EDGE_TYPE_BOTH
public static final short EDGE_TYPE_BOTH
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletIO4
public BrickletIO4(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(short valueMask) throws TinkerforgeException
Sets the output value (high or low) with a bitmask (4bit). A 1 in the bitmask means high and a 0 in the bitmask means low. For example: The value 3 or 0b0011 will turn the pins 0-1 high and the pins 2-3 low. All running monoflop timers will be aborted if this function is called. \note This function does nothing for pins that are configured as input. Pull-up resistors can be switched on withsetConfiguration(short, char, boolean)
.- Throws:
TinkerforgeException
-
getValue
public short getValue() throws TinkerforgeException
Returns a bitmask of the values that are currently measured. This function works if the pin is configured to input as well as if it is configured to output.- Throws:
TinkerforgeException
-
setConfiguration
public void setConfiguration(short selectionMask, char direction, boolean value) throws TinkerforgeException
Configures the value and direction of the specified pins. Possible directions are 'i' and 'o' for input and output. If the direction is configured as output, the value is either high or low (set as *true* or *false*). If the direction is configured as input, the value is either pull-up or default (set as *true* or *false*). For example: * (15, 'i', true) or (0b1111, 'i', true) will set all pins of as input pull-up. * (8, 'i', false) or (0b1000, 'i', false) will set pin 3 of as input default (floating if nothing is connected). * (3, 'o', false) or (0b0011, 'o', false) will set pins 0 and 1 as output low. * (4, 'o', true) or (0b0100, 'o', true) will set pin 2 of as output high. Running monoflop timers for the specified pins will be aborted if this function is called.- Throws:
TinkerforgeException
-
getConfiguration
public BrickletIO4.Configuration getConfiguration() throws TinkerforgeException
Returns a value bitmask and a direction bitmask. A 1 in the direction bitmask means input and a 0 in the bitmask means output. For example: A return value of (3, 5) or (0b0011, 0b0101) for direction and value means that: * pin 0 is configured as input pull-up, * pin 1 is configured as input default, * pin 2 is configured as output high and * pin 3 is are configured as output low.- Throws:
TinkerforgeException
-
setDebouncePeriod
public void setDebouncePeriod(long debounce) throws TinkerforgeException
Sets the debounce period of theBrickletIO4.InterruptListener
listener. For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the IO-4 Bricklet, such as a button.- Throws:
TinkerforgeException
-
getDebouncePeriod
public long getDebouncePeriod() throws TinkerforgeException
Returns the debounce period as set bysetDebouncePeriod(long)
.- Throws:
TinkerforgeException
-
setInterrupt
public void setInterrupt(short interruptMask) throws TinkerforgeException
Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high. For example: An interrupt bitmask of 10 or 0b1010 will enable the interrupt for pins 1 and 3. The interrupt is delivered with theBrickletIO4.InterruptListener
listener.- Throws:
TinkerforgeException
-
getInterrupt
public short getInterrupt() throws TinkerforgeException
Returns the interrupt bitmask as set bysetInterrupt(short)
.- Throws:
TinkerforgeException
-
setMonoflop
public void setMonoflop(short selectionMask, short valueMask, long time) throws TinkerforgeException
Configures a monoflop of the pins specified by the first parameter as 4 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored. The second parameter is a bitmask with the desired value of the specified output 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 an IO-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 set to high. Pin 0 will be high all the time. If now the RS485 connection is lost, then pin 0 will get low in at most two seconds.- Throws:
TinkerforgeException
-
getMonoflop
public BrickletIO4.Monoflop getMonoflop(short pin) throws TinkerforgeException
Returns (for the given pin) the current value and the time as set bysetMonoflop(short, short, 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
-
setSelectedValues
public void setSelectedValues(short selectionMask, short valueMask) throws TinkerforgeException
Sets the output value (high or low) with a bitmask, according to the selection mask. The bitmask is 4 bit long, *true* refers to high and *false* refers to low. For example: The parameters (9, 4) or (0b0110, 0b0100) will turn pin 1 low and pin 2 high, pin 0 and 3 will remain untouched. Running monoflop timers for the selected pins will be aborted if this function is called. \note This function does nothing for pins that are configured as input. Pull-up resistors can be switched on withsetConfiguration(short, char, boolean)
.- Throws:
TinkerforgeException
-
getEdgeCount
public long getEdgeCount(short pin, boolean resetCounter) throws TinkerforgeException
Returns the current value of the edge counter for the selected pin. You can configure the edges that are counted withsetEdgeCountConfig(short, short, short)
. If you set the reset counter to *true*, the count is set back to 0 directly after it is read. .. versionadded:: 2.0.1$nbsp;(Plugin)- Throws:
TinkerforgeException
-
setEdgeCountConfig
public void setEdgeCountConfig(short selectionMask, short edgeType, short debounce) throws TinkerforgeException
Configures the edge counter for the selected pins. The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are: * 0 = rising (default) * 1 = falling * 2 = both Configuring an edge counter resets its value to 0. If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you. .. versionadded:: 2.0.1$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getEdgeCountConfig
public BrickletIO4.EdgeCountConfig getEdgeCountConfig(short pin) throws TinkerforgeException
Returns the edge type and debounce time for the selected pin as set bysetEdgeCountConfig(short, short, short)
. .. versionadded:: 2.0.1$nbsp;(Plugin)- 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
-
addInterruptListener
public void addInterruptListener(BrickletIO4.InterruptListener listener)
Adds a Interrupt listener.
-
removeInterruptListener
public void removeInterruptListener(BrickletIO4.InterruptListener listener)
Removes a Interrupt listener.
-
addMonoflopDoneListener
public void addMonoflopDoneListener(BrickletIO4.MonoflopDoneListener listener)
Adds a MonoflopDone listener.
-
removeMonoflopDoneListener
public void removeMonoflopDoneListener(BrickletIO4.MonoflopDoneListener listener)
Removes a MonoflopDone listener.
-
-