Package com.tinkerforge
Class BrickletIO16
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletIO16
-
public class BrickletIO16 extends Device
16-channel digital input/output
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletIO16.EdgeCountConfig
static interface
BrickletIO16.InterruptListener
This listener is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated withsetPortInterrupt(char, short)
.static interface
BrickletIO16.MonoflopDoneListener
This listener is triggered whenever a monoflop timer reaches 0.class
BrickletIO16.PortConfiguration
class
BrickletIO16.PortMonoflop
-
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_DEBOUNCE_PERIOD
static byte
FUNCTION_GET_EDGE_COUNT
static byte
FUNCTION_GET_EDGE_COUNT_CONFIG
static byte
FUNCTION_GET_IDENTITY
static byte
FUNCTION_GET_PORT
static byte
FUNCTION_GET_PORT_CONFIGURATION
static byte
FUNCTION_GET_PORT_INTERRUPT
static byte
FUNCTION_GET_PORT_MONOFLOP
static byte
FUNCTION_SET_DEBOUNCE_PERIOD
static byte
FUNCTION_SET_EDGE_COUNT_CONFIG
static byte
FUNCTION_SET_PORT
static byte
FUNCTION_SET_PORT_CONFIGURATION
static byte
FUNCTION_SET_PORT_INTERRUPT
static byte
FUNCTION_SET_PORT_MONOFLOP
static byte
FUNCTION_SET_SELECTED_VALUES
-
Constructor Summary
Constructors Constructor Description BrickletIO16(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(BrickletIO16.InterruptListener listener)
Adds a Interrupt listener.void
addMonoflopDoneListener(BrickletIO16.MonoflopDoneListener listener)
Adds a MonoflopDone listener.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 on port A.BrickletIO16.EdgeCountConfig
getEdgeCountConfig(short pin)
Returns the edge type and debounce time for the selected pin of port A 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
getPort(char port)
Returns a bitmask of the values that are currently measured on the specified port.BrickletIO16.PortConfiguration
getPortConfiguration(char port)
Returns a direction bitmask and a value bitmask for the specified port.short
getPortInterrupt(char port)
Returns the interrupt bitmask for the specified port as set bysetPortInterrupt(char, short)
.BrickletIO16.PortMonoflop
getPortMonoflop(char port, short pin)
Returns (for the given pin) the current value and the time as set bysetPortMonoflop(char, short, short, long)
as well as the remaining time until the value flips.void
removeInterruptListener(BrickletIO16.InterruptListener listener)
Removes a Interrupt listener.void
removeMonoflopDoneListener(BrickletIO16.MonoflopDoneListener listener)
Removes a MonoflopDone listener.void
setDebouncePeriod(long debounce)
Sets the debounce period of theBrickletIO16.InterruptListener
listener.void
setEdgeCountConfig(short pin, short edgeType, short debounce)
Configures the edge counter for the selected pin of port A.void
setPort(char port, short valueMask)
Sets the output value (high or low) for a port ("a" or "b") with a bitmask (8bit).void
setPortConfiguration(char port, short selectionMask, char direction, boolean value)
Configures the value and direction of a specified port.void
setPortInterrupt(char port, short interruptMask)
Sets the pins on which an interrupt is activated with a bitmask.void
setPortMonoflop(char port, short selectionMask, short valueMask, long time)
Configures a monoflop of the pins specified by the second parameter as 8 bit long bitmask.void
setSelectedValues(char port, short selectionMask, short valueMask)
Sets the output value (high or low) for a port ("a" or "b" with a bitmask, according to the selection mask.-
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_PORT
public static final byte FUNCTION_SET_PORT
- See Also:
- Constant Field Values
-
FUNCTION_GET_PORT
public static final byte FUNCTION_GET_PORT
- See Also:
- Constant Field Values
-
FUNCTION_SET_PORT_CONFIGURATION
public static final byte FUNCTION_SET_PORT_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_PORT_CONFIGURATION
public static final byte FUNCTION_GET_PORT_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_PORT_INTERRUPT
public static final byte FUNCTION_SET_PORT_INTERRUPT
- See Also:
- Constant Field Values
-
FUNCTION_GET_PORT_INTERRUPT
public static final byte FUNCTION_GET_PORT_INTERRUPT
- See Also:
- Constant Field Values
-
FUNCTION_SET_PORT_MONOFLOP
public static final byte FUNCTION_SET_PORT_MONOFLOP
- See Also:
- Constant Field Values
-
FUNCTION_GET_PORT_MONOFLOP
public static final byte FUNCTION_GET_PORT_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
-
BrickletIO16
public BrickletIO16(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
-
setPort
public void setPort(char port, short valueMask) throws TinkerforgeException
Sets the output value (high or low) for a port ("a" or "b") with a bitmask (8bit). A 1 in the bitmask means high and a 0 in the bitmask means low. For example: The value 15 or 0b00001111 will turn the pins 0-3 high and the pins 4-7 low for the specified port. All running monoflop timers of the given port 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 withsetPortConfiguration(char, short, char, boolean)
.- Throws:
TinkerforgeException
-
getPort
public short getPort(char port) throws TinkerforgeException
Returns a bitmask of the values that are currently measured on the specified port. This function works if the pin is configured to input as well as if it is configured to output.- Throws:
TinkerforgeException
-
setPortConfiguration
public void setPortConfiguration(char port, short selectionMask, char direction, boolean value) throws TinkerforgeException
Configures the value and direction of a specified port. 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: * ('a', 255, 'i', true) or ('a', 0b11111111, 'i', true) will set all pins of port A as input pull-up. * ('a', 128, 'i', false) or ('a', 0b10000000, 'i', false) will set pin 7 of port A as input default (floating if nothing is connected). * ('b', 3, 'o', false) or ('b', 0b00000011, 'o', false) will set pins 0 and 1 of port B as output low. * ('b', 4, 'o', true) or ('b', 0b00000100, 'o', true) will set pin 2 of port B as output high. Running monoflop timers for the selected pins will be aborted if this function is called.- Throws:
TinkerforgeException
-
getPortConfiguration
public BrickletIO16.PortConfiguration getPortConfiguration(char port) throws TinkerforgeException
Returns a direction bitmask and a value bitmask for the specified port. A 1 in the direction bitmask means input and a 0 in the bitmask means output. For example: A return value of (15, 51) or (0b00001111, 0b00110011) for direction and value means that: * pins 0 and 1 are configured as input pull-up, * pins 2 and 3 are configured as input default, * pins 4 and 5 are configured as output high * and pins 6 and 7 are configured as output low.- Throws:
TinkerforgeException
-
setDebouncePeriod
public void setDebouncePeriod(long debounce) throws TinkerforgeException
Sets the debounce period of theBrickletIO16.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-16 Bricklet, such as a button.- Throws:
TinkerforgeException
-
getDebouncePeriod
public long getDebouncePeriod() throws TinkerforgeException
Returns the debounce period as set bysetDebouncePeriod(long)
.- Throws:
TinkerforgeException
-
setPortInterrupt
public void setPortInterrupt(char port, 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: ('a', 129) or ('a', 0b10000001) will enable the interrupt for pins 0 and 7 of port a. The interrupt is delivered with theBrickletIO16.InterruptListener
listener.- Throws:
TinkerforgeException
-
getPortInterrupt
public short getPortInterrupt(char port) throws TinkerforgeException
Returns the interrupt bitmask for the specified port as set bysetPortInterrupt(char, short)
.- Throws:
TinkerforgeException
-
setPortMonoflop
public void setPortMonoflop(char port, short selectionMask, short valueMask, long time) throws TinkerforgeException
Configures a monoflop of the pins specified by the second parameter as 8 bit long bitmask. The specified pins must be configured for output. Non-output pins will be ignored. The third 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 forth parameter indicates the time that the pins should hold the value. If this function is called with the parameters ('a', 9, 1, 1500) or ('a', 0b00001001, 0b00000001, 1500): Pin 0 will get high and pin 3 will get low on port 'a'. 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-16 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
-
getPortMonoflop
public BrickletIO16.PortMonoflop getPortMonoflop(char port, short pin) throws TinkerforgeException
Returns (for the given pin) the current value and the time as set bysetPortMonoflop(char, 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(char port, short selectionMask, short valueMask) throws TinkerforgeException
Sets the output value (high or low) for a port ("a" or "b" with a bitmask, according to the selection mask. The bitmask is 8 bit long and a 1 in the bitmask means high and a 0 in the bitmask means low. For example: The parameters ('a', 192, 128) or ('a', 0b11000000, 0b10000000) will turn pin 7 high and pin 6 low on port A, pins 0-6 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 withsetPortConfiguration(char, 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 on port A. 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.3$nbsp;(Plugin)- Throws:
TinkerforgeException
-
setEdgeCountConfig
public void setEdgeCountConfig(short pin, short edgeType, short debounce) throws TinkerforgeException
Configures the edge counter for the selected pin of port A. Pins 0 and 1 are available for edge counting. 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 * 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.3$nbsp;(Plugin)- Throws:
TinkerforgeException
-
getEdgeCountConfig
public BrickletIO16.EdgeCountConfig getEdgeCountConfig(short pin) throws TinkerforgeException
Returns the edge type and debounce time for the selected pin of port A as set bysetEdgeCountConfig(short, short, short)
. .. versionadded:: 2.0.3$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(BrickletIO16.InterruptListener listener)
Adds a Interrupt listener.
-
removeInterruptListener
public void removeInterruptListener(BrickletIO16.InterruptListener listener)
Removes a Interrupt listener.
-
addMonoflopDoneListener
public void addMonoflopDoneListener(BrickletIO16.MonoflopDoneListener listener)
Adds a MonoflopDone listener.
-
removeMonoflopDoneListener
public void removeMonoflopDoneListener(BrickletIO16.MonoflopDoneListener listener)
Removes a MonoflopDone listener.
-
-