public class BrickletMultiTouchV2 extends Device
Modifier and Type | Class and Description |
---|---|
class |
BrickletMultiTouchV2.SPITFPErrorCount |
class |
BrickletMultiTouchV2.TouchStateCallbackConfiguration |
static interface |
BrickletMultiTouchV2.TouchStateListener
Returns the current touch state, see
getTouchState() for
information about the state. |
Device.Identity
Constructor and Description |
---|
BrickletMultiTouchV2(String uid,
IPConnection ipcon)
Creates an object with the unique device ID \c uid.
|
Modifier and Type | Method and Description |
---|---|
void |
addTouchStateListener(BrickletMultiTouchV2.TouchStateListener listener)
Adds a TouchState listener.
|
int |
getBootloaderMode()
Returns the current bootloader mode, see
setBootloaderMode(int) . |
int |
getChipTemperature()
Returns the temperature as measured inside the microcontroller.
|
boolean[] |
getElectrodeConfig()
Returns the electrode configuration, as set by
setElectrodeConfig(boolean[]) . |
int |
getElectrodeSensitivity()
Returns the current sensitivity, as set by
setElectrodeSensitivity(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 by
setStatusLEDConfig(int) |
int |
getTouchLEDConfig()
Returns the LED configuration as set by
setTouchLEDConfig(int) |
boolean[] |
getTouchState()
Returns the current touch state.
|
BrickletMultiTouchV2.TouchStateCallbackConfiguration |
getTouchStateCallbackConfiguration()
Returns the listener configuration as set by
setTouchStateCallbackConfiguration(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 (see
getTouchState() ). |
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 the
BrickletMultiTouchV2.TouchStateListener listener
is triggered periodically. |
void |
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer for
writeFirmware(int[]) . |
int |
writeFirmware(int[] data)
Writes 64 Bytes of firmware at the position as written by
setWriteFirmwarePointer(long) before. |
void |
writeUID(long uid)
Writes a new UID into flash.
|
getAPIVersion, getResponseExpected, setResponseExpected, setResponseExpectedAll
public static final int DEVICE_IDENTIFIER
public static final String DEVICE_DISPLAY_NAME
public static final byte FUNCTION_GET_TOUCH_STATE
public static final byte FUNCTION_SET_TOUCH_STATE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_TOUCH_STATE_CALLBACK_CONFIGURATION
public static final byte FUNCTION_RECALIBRATE
public static final byte FUNCTION_SET_ELECTRODE_CONFIG
public static final byte FUNCTION_GET_ELECTRODE_CONFIG
public static final byte FUNCTION_SET_ELECTRODE_SENSITIVITY
public static final byte FUNCTION_GET_ELECTRODE_SENSITIVITY
public static final byte FUNCTION_SET_TOUCH_LED_CONFIG
public static final byte FUNCTION_GET_TOUCH_LED_CONFIG
public static final byte FUNCTION_GET_SPITFP_ERROR_COUNT
public static final byte FUNCTION_SET_BOOTLOADER_MODE
public static final byte FUNCTION_GET_BOOTLOADER_MODE
public static final byte FUNCTION_SET_WRITE_FIRMWARE_POINTER
public static final byte FUNCTION_WRITE_FIRMWARE
public static final byte FUNCTION_SET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_STATUS_LED_CONFIG
public static final byte FUNCTION_GET_CHIP_TEMPERATURE
public static final byte FUNCTION_RESET
public static final byte FUNCTION_WRITE_UID
public static final byte FUNCTION_READ_UID
public static final byte FUNCTION_GET_IDENTITY
public static final int TOUCH_LED_CONFIG_OFF
public static final int TOUCH_LED_CONFIG_ON
public static final int TOUCH_LED_CONFIG_SHOW_HEARTBEAT
public static final int TOUCH_LED_CONFIG_SHOW_TOUCH
public static final int BOOTLOADER_MODE_BOOTLOADER
public static final int BOOTLOADER_MODE_FIRMWARE
public static final int BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
public static final int BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
public static final int BOOTLOADER_STATUS_OK
public static final int BOOTLOADER_STATUS_INVALID_MODE
public static final int BOOTLOADER_STATUS_NO_CHANGE
public static final int BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
public static final int BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
public static final int BOOTLOADER_STATUS_CRC_MISMATCH
public static final int STATUS_LED_CONFIG_OFF
public static final int STATUS_LED_CONFIG_ON
public static final int STATUS_LED_CONFIG_SHOW_HEARTBEAT
public static final int STATUS_LED_CONFIG_SHOW_STATUS
public BrickletMultiTouchV2(String uid, IPConnection ipcon)
public boolean[] getTouchState() throws TinkerforgeException
BrickletMultiTouchV2.TouchStateListener
listener. You can set the listener configuration
with setTouchStateCallbackConfiguration(long, boolean)
.TinkerforgeException
public void setTouchStateCallbackConfiguration(long period, boolean valueHasToChange) throws TinkerforgeException
BrickletMultiTouchV2.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.TinkerforgeException
public BrickletMultiTouchV2.TouchStateCallbackConfiguration getTouchStateCallbackConfiguration() throws TinkerforgeException
setTouchStateCallbackConfiguration(long, boolean)
.TinkerforgeException
public void recalibrate() throws TinkerforgeException
TinkerforgeException
public void setElectrodeConfig(boolean[] enabledElectrodes) throws TinkerforgeException
getTouchState()
).
*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 the BrickletMultiTouchV2.TouchStateListener
listener.
Disabling electrodes will also reduce power consumption.TinkerforgeException
public boolean[] getElectrodeConfig() throws TinkerforgeException
setElectrodeConfig(boolean[])
.TinkerforgeException
public void setElectrodeSensitivity(int sensitivity) throws TinkerforgeException
recalibrate()
to calibrate the electrodes with the newly defined sensitivity.TinkerforgeException
public int getElectrodeSensitivity() throws TinkerforgeException
setElectrodeSensitivity(int)
.TinkerforgeException
public void setTouchLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getTouchLEDConfig() throws TinkerforgeException
setTouchLEDConfig(int)
TinkerforgeException
public BrickletMultiTouchV2.SPITFPErrorCount getSPITFPErrorCount() throws TinkerforgeException
TinkerforgeException
public int setBootloaderMode(int mode) throws TinkerforgeException
TinkerforgeException
public int getBootloaderMode() throws TinkerforgeException
setBootloaderMode(int)
.TinkerforgeException
public void setWriteFirmwarePointer(long pointer) throws TinkerforgeException
writeFirmware(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.TinkerforgeException
public int writeFirmware(int[] data) throws TinkerforgeException
setWriteFirmwarePointer(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.TinkerforgeException
public void setStatusLEDConfig(int config) throws TinkerforgeException
TinkerforgeException
public int getStatusLEDConfig() throws TinkerforgeException
setStatusLEDConfig(int)
TinkerforgeException
public int getChipTemperature() throws TinkerforgeException
TinkerforgeException
public void reset() throws TinkerforgeException
TinkerforgeException
public void writeUID(long uid) throws TinkerforgeException
TinkerforgeException
public long readUID() throws TinkerforgeException
TinkerforgeException
public Device.Identity getIdentity() throws TinkerforgeException
getIdentity
in class Device
TinkerforgeException
public void addTouchStateListener(BrickletMultiTouchV2.TouchStateListener listener)
public void removeTouchStateListener(BrickletMultiTouchV2.TouchStateListener listener)
Copyright © 2021 Tinkerforge GmbH. All rights reserved.