Package com.tinkerforge
Class BrickletMultiTouchV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletMultiTouchV2
-
public class BrickletMultiTouchV2 extends Device
Capacitive touch sensor for 12 electrodes
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletMultiTouchV2.SPITFPErrorCount
class
BrickletMultiTouchV2.TouchStateCallbackConfiguration
static interface
BrickletMultiTouchV2.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
-
Constructor Summary
Constructors Constructor Description BrickletMultiTouchV2(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(BrickletMultiTouchV2.TouchStateListener listener)
Adds a TouchState listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.boolean[]
getElectrodeConfig()
Returns the electrode configuration, as set bysetElectrodeConfig(boolean[])
.int
getElectrodeSensitivity()
Returns the current sensitivity, as set bysetElectrodeSensitivity(int)
.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.BrickletMultiTouchV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
int
getTouchLEDConfig()
Returns the LED configuration as set bysetTouchLEDConfig(int)
boolean[]
getTouchState()
Returns the current touch state.BrickletMultiTouchV2.TouchStateCallbackConfiguration
getTouchStateCallbackConfiguration()
Returns the listener configuration as set bysetTouchStateCallbackConfiguration(long, boolean)
.long
readUID()
Returns the current UID as an integer.void
recalibrate()
Recalibrates the electrodes.void
removeTouchStateListener(BrickletMultiTouchV2.TouchStateListener listener)
Removes a TouchState listener.void
reset()
Calling this function will reset the Bricklet.int
setBootloaderMode(int mode)
Sets the bootloader mode and returns the status after the requested mode change was instigated.void
setElectrodeConfig(boolean[] enabledElectrodes)
Enables/disables electrodes with a bool array (seegetTouchState()
).void
setElectrodeSensitivity(int sensitivity)
Sets the sensitivity of the electrodes.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setTouchLEDConfig(int config)
Configures the touch LED to be either turned off, turned on, blink in heartbeat mode or show the touch state (electrode touched = LED on).void
setTouchStateCallbackConfiguration(long period, boolean valueHasToChange)
The period is the period with which theBrickletMultiTouchV2.TouchStateListener
listener is triggered periodically.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.int
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before.void
writeUID(long uid)
Writes a new UID into flash.-
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_SET_TOUCH_STATE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_TOUCH_STATE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_TOUCH_STATE_CALLBACK_CONFIGURATION
- 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_SET_TOUCH_LED_CONFIG
public static final byte FUNCTION_SET_TOUCH_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_TOUCH_LED_CONFIG
public static final byte FUNCTION_GET_TOUCH_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
- See Also:
- Constant Field Values
-
FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
- See Also:
- Constant Field Values
-
FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_WRITE_FIRMWARE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
- See Also:
- Constant Field Values
-
FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
- See Also:
- Constant Field Values
-
FUNCTION_RESET
public static final byte FUNCTION_RESET
- See Also:
- Constant Field Values
-
FUNCTION_WRITE_UID
public static final byte FUNCTION_WRITE_UID
- See Also:
- Constant Field Values
-
FUNCTION_READ_UID
public static final byte FUNCTION_READ_UID
- See Also:
- Constant Field Values
-
FUNCTION_GET_IDENTITY
public static final byte FUNCTION_GET_IDENTITY
- See Also:
- Constant Field Values
-
TOUCH_LED_CONFIG_OFF
public static final int TOUCH_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
TOUCH_LED_CONFIG_ON
public static final int TOUCH_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
TOUCH_LED_CONFIG_SHOW_HEARTBEAT
public static final int TOUCH_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
TOUCH_LED_CONFIG_SHOW_TOUCH
public static final int TOUCH_LED_CONFIG_SHOW_TOUCH
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_BOOTLOADER
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_FIRMWARE
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_OK
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_INVALID_MODE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_NO_CHANGE
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- See Also:
- Constant Field Values
-
BOOTLOADER_STATUS_CRC_MISMATCH
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_OFF
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_ON
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
- See Also:
- Constant Field Values
-
STATUS_LED_CONFIG_SHOW_STATUS
public static final int STATUS_LED_CONFIG_SHOW_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BrickletMultiTouchV2
public BrickletMultiTouchV2(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 boolean[] getTouchState() throws TinkerforgeException
Returns the current touch state. The state is given as a array of bools. Element 0 to 11 represent the 12 electrodes and element 12 represents the proximity. If an electrode is touched, the corresponding element is *true*. If a hand or similar is in proximity to the electrodes, element 12 is *true*. 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. If you want to get the value periodically, it is recommended to use theBrickletMultiTouchV2.TouchStateListener
listener. You can set the listener configuration withsetTouchStateCallbackConfiguration(long, boolean)
.- Throws:
TinkerforgeException
-
setTouchStateCallbackConfiguration
public void setTouchStateCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
The period is the period with which theBrickletMultiTouchV2.TouchStateListener
listener is triggered periodically. A value of 0 turns the listener off. If the `value has to change`-parameter is set to true, the listener is only triggered after the value has changed. If the value didn't change within the period, the listener is triggered immediately on change. If it is set to false, the listener is continuously triggered with the period, independent of the value.- Throws:
TinkerforgeException
-
getTouchStateCallbackConfiguration
public BrickletMultiTouchV2.TouchStateCallbackConfiguration getTouchStateCallbackConfiguration() throws TinkerforgeException
Returns the listener configuration as set bysetTouchStateCallbackConfiguration(long, boolean)
.- 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(boolean[] enabledElectrodes) throws TinkerforgeException
Enables/disables electrodes with a bool array (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 electrode (element 12) if the proximity feature is not needed. This will reduce the amount of traffic that is produced by theBrickletMultiTouchV2.TouchStateListener
listener. Disabling electrodes will also reduce power consumption.- Throws:
TinkerforgeException
-
getElectrodeConfig
public boolean[] getElectrodeConfig() throws TinkerforgeException
Returns the electrode configuration, as set bysetElectrodeConfig(boolean[])
.- Throws:
TinkerforgeException
-
setElectrodeSensitivity
public void setElectrodeSensitivity(int 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 int getElectrodeSensitivity() throws TinkerforgeException
Returns the current sensitivity, as set bysetElectrodeSensitivity(int)
.- Throws:
TinkerforgeException
-
setTouchLEDConfig
public void setTouchLEDConfig(int config) throws TinkerforgeException
Configures the touch LED to be either turned off, turned on, blink in heartbeat mode or show the touch state (electrode touched = LED on).- Throws:
TinkerforgeException
-
getTouchLEDConfig
public int getTouchLEDConfig() throws TinkerforgeException
Returns the LED configuration as set bysetTouchLEDConfig(int)
- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletMultiTouchV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
Returns the error count for the communication between Brick and Bricklet. The errors are divided into * ACK checksum errors, * message checksum errors, * framing errors and * overflow errors. The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.- Throws:
TinkerforgeException
-
setBootloaderMode
public int setBootloaderMode(int mode) throws TinkerforgeException
Sets the bootloader mode and returns the status after the requested mode change was instigated. You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
getBootloaderMode
public int getBootloaderMode() throws TinkerforgeException
Returns the current bootloader mode, seesetBootloaderMode(int)
.- Throws:
TinkerforgeException
-
setWriteFirmwarePointer
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
Sets the firmware pointer forwriteFirmware(int[])
. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256). This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
writeFirmware
public int writeFirmware(int[] data) throws TinkerforgeException
Writes 64 Bytes of firmware at the position as written bysetWriteFirmwarePointer(long)
before. The firmware is written to flash every 4 chunks. You can only write firmware in bootloader mode. This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.- Throws:
TinkerforgeException
-
setStatusLEDConfig
public void setStatusLEDConfig(int config) throws TinkerforgeException
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.- Throws:
TinkerforgeException
-
getStatusLEDConfig
public int getStatusLEDConfig() throws TinkerforgeException
Returns the configuration as set bysetStatusLEDConfig(int)
- Throws:
TinkerforgeException
-
getChipTemperature
public int getChipTemperature() throws TinkerforgeException
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature! The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.- Throws:
TinkerforgeException
-
reset
public void reset() throws TinkerforgeException
Calling this function will reset the Bricklet. All configurations will be lost. After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!- Throws:
TinkerforgeException
-
writeUID
public void writeUID(long uid) throws TinkerforgeException
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first. We recommend that you use Brick Viewer to change the UID.- Throws:
TinkerforgeException
-
readUID
public long readUID() throws TinkerforgeException
Returns the current UID as an integer. Encode as Base58 to get the usual string version.- 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(BrickletMultiTouchV2.TouchStateListener listener)
Adds a TouchState listener.
-
removeTouchStateListener
public void removeTouchStateListener(BrickletMultiTouchV2.TouchStateListener listener)
Removes a TouchState listener.
-
-