Package com.tinkerforge
Class BrickletMultiTouch
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletMultiTouch
-
public class BrickletMultiTouch extends Device
Capacitive touch sensor for 12 electrodes
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BrickletMultiTouch.TouchStateListener
Returns the current touch state, seegetTouchState()
for information about the state.-
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_ELECTRODE_CONFIG
static byte
FUNCTION_GET_ELECTRODE_SENSITIVITY
static byte
FUNCTION_GET_IDENTITY
static byte
FUNCTION_GET_TOUCH_STATE
static byte
FUNCTION_RECALIBRATE
static byte
FUNCTION_SET_ELECTRODE_CONFIG
static byte
FUNCTION_SET_ELECTRODE_SENSITIVITY
-
Constructor Summary
Constructors Constructor Description BrickletMultiTouch(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
addTouchStateListener(BrickletMultiTouch.TouchStateListener listener)
Adds a TouchState listener.int
getElectrodeConfig()
Returns the electrode configuration, as set bysetElectrodeConfig(int)
.short
getElectrodeSensitivity()
Returns the current sensitivity, as set bysetElectrodeSensitivity(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.int
getTouchState()
Returns the current touch state.void
recalibrate()
Recalibrates the electrodes.void
removeTouchStateListener(BrickletMultiTouch.TouchStateListener listener)
Removes a TouchState listener.void
setElectrodeConfig(int enabledElectrodes)
Enables/disables electrodes with a bitfield (seegetTouchState()
).void
setElectrodeSensitivity(short sensitivity)
Sets the sensitivity of the electrodes.-
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_GET_TOUCH_STATE
public static final byte FUNCTION_GET_TOUCH_STATE
- See Also:
- Constant Field Values
-
FUNCTION_RECALIBRATE
public static final byte FUNCTION_RECALIBRATE
- See Also:
- Constant Field Values
-
FUNCTION_SET_ELECTRODE_CONFIG
public static final byte FUNCTION_SET_ELECTRODE_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_ELECTRODE_CONFIG
public static final byte FUNCTION_GET_ELECTRODE_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_SET_ELECTRODE_SENSITIVITY
public static final byte FUNCTION_SET_ELECTRODE_SENSITIVITY
- See Also:
- Constant Field Values
-
FUNCTION_GET_ELECTRODE_SENSITIVITY
public static final byte FUNCTION_GET_ELECTRODE_SENSITIVITY
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletMultiTouch
public BrickletMultiTouch(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
-
getTouchState
public int getTouchState() throws TinkerforgeException
Returns the current touch state. The state is given as a bitfield. Bits 0 to 11 represent the 12 electrodes and bit 12 represents the proximity. If an electrode is touched, the corresponding bit is *true*. If a hand or similar is in proximity to the electrodes, bit 12 is *true*. Example: The state 4103 = 0x1007 = 0b1000000000111 means that electrodes 0, 1 and 2 are touched and that something is in the proximity of the electrodes. The proximity is activated with a distance of 1-2cm. An electrode is already counted as touched if a finger is nearly touching the electrode. This means that you can put a piece of paper or foil or similar on top of a electrode to build a touch panel with a professional look.- Throws:
TinkerforgeException
-
recalibrate
public void recalibrate() throws TinkerforgeException
Recalibrates the electrodes. Call this function whenever you changed or moved you electrodes.- Throws:
TinkerforgeException
-
setElectrodeConfig
public void setElectrodeConfig(int enabledElectrodes) throws TinkerforgeException
Enables/disables electrodes with a bitfield (seegetTouchState()
). *True* enables the electrode, *false* disables the electrode. A disabled electrode will always return *false* as its state. If you don't need all electrodes you can disable the electrodes that are not needed. It is recommended that you disable the proximity bit (bit 12) if the proximity feature is not needed. This will reduce the amount of traffic that is produced by theBrickletMultiTouch.TouchStateListener
listener. Disabling electrodes will also reduce power consumption. Default: 8191 = 0x1FFF = 0b1111111111111 (all electrodes and proximity feature enabled)- Throws:
TinkerforgeException
-
getElectrodeConfig
public int getElectrodeConfig() throws TinkerforgeException
Returns the electrode configuration, as set bysetElectrodeConfig(int)
.- Throws:
TinkerforgeException
-
setElectrodeSensitivity
public void setElectrodeSensitivity(short sensitivity) throws TinkerforgeException
Sets the sensitivity of the electrodes. An electrode with a high sensitivity will register a touch earlier then an electrode with a low sensitivity. If you build a big electrode you might need to decrease the sensitivity, since the area that can be charged will get bigger. If you want to be able to activate an electrode from further away you need to increase the sensitivity. After a new sensitivity is set, you likely want to callrecalibrate()
to calibrate the electrodes with the newly defined sensitivity.- Throws:
TinkerforgeException
-
getElectrodeSensitivity
public short getElectrodeSensitivity() throws TinkerforgeException
Returns the current sensitivity, as set bysetElectrodeSensitivity(short)
.- 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
-
addTouchStateListener
public void addTouchStateListener(BrickletMultiTouch.TouchStateListener listener)
Adds a TouchState listener.
-
removeTouchStateListener
public void removeTouchStateListener(BrickletMultiTouch.TouchStateListener listener)
Removes a TouchState listener.
-
-