Package com.tinkerforge
Class BrickletDualButtonV2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletDualButtonV2
-
public class BrickletDualButtonV2 extends Device
Two tactile buttons with built-in blue LEDs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
BrickletDualButtonV2.ButtonState
class
BrickletDualButtonV2.LEDState
class
BrickletDualButtonV2.SPITFPErrorCount
static interface
BrickletDualButtonV2.StateChangedListener
This listener is called whenever a button is pressed.-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletDualButtonV2(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
addStateChangedListener(BrickletDualButtonV2.StateChangedListener listener)
Adds a StateChanged listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.BrickletDualButtonV2.ButtonState
getButtonState()
Returns the current state for both buttons.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.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.BrickletDualButtonV2.LEDState
getLEDState()
Returns the current state of the LEDs, as set bysetLEDState(int, int)
.BrickletDualButtonV2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.boolean
getStateChangedCallbackConfiguration()
Returns the configuration as set bysetStateChangedCallbackConfiguration(boolean)
.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
readUID()
Returns the current UID as an integer.void
removeStateChangedListener(BrickletDualButtonV2.StateChangedListener listener)
Removes a StateChanged 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
setLEDState(int ledL, int ledR)
Sets the state of the LEDs.void
setSelectedLEDState(int led, int state)
Sets the state of the selected LED.void
setStateChangedCallbackConfiguration(boolean enabled)
If you enable this listener, theBrickletDualButtonV2.StateChangedListener
listener is triggered every time a button is pressed/releasedvoid
setStatusLEDConfig(int config)
Sets the status LED configuration.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_SET_LED_STATE
public static final byte FUNCTION_SET_LED_STATE
- See Also:
- Constant Field Values
-
FUNCTION_GET_LED_STATE
public static final byte FUNCTION_GET_LED_STATE
- See Also:
- Constant Field Values
-
FUNCTION_GET_BUTTON_STATE
public static final byte FUNCTION_GET_BUTTON_STATE
- See Also:
- Constant Field Values
-
FUNCTION_SET_SELECTED_LED_STATE
public static final byte FUNCTION_SET_SELECTED_LED_STATE
- See Also:
- Constant Field Values
-
FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION
public static final byte FUNCTION_SET_STATE_CHANGED_CALLBACK_CONFIGURATION
- See Also:
- Constant Field Values
-
FUNCTION_GET_STATE_CHANGED_CALLBACK_CONFIGURATION
public static final byte FUNCTION_GET_STATE_CHANGED_CALLBACK_CONFIGURATION
- 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
-
LED_STATE_AUTO_TOGGLE_ON
public static final int LED_STATE_AUTO_TOGGLE_ON
- See Also:
- Constant Field Values
-
LED_STATE_AUTO_TOGGLE_OFF
public static final int LED_STATE_AUTO_TOGGLE_OFF
- See Also:
- Constant Field Values
-
LED_STATE_ON
public static final int LED_STATE_ON
- See Also:
- Constant Field Values
-
LED_STATE_OFF
public static final int LED_STATE_OFF
- See Also:
- Constant Field Values
-
BUTTON_STATE_PRESSED
public static final int BUTTON_STATE_PRESSED
- See Also:
- Constant Field Values
-
BUTTON_STATE_RELEASED
public static final int BUTTON_STATE_RELEASED
- See Also:
- Constant Field Values
-
LED_LEFT
public static final int LED_LEFT
- See Also:
- Constant Field Values
-
LED_RIGHT
public static final int LED_RIGHT
- 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
-
BrickletDualButtonV2
public BrickletDualButtonV2(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
-
setLEDState
public void setLEDState(int ledL, int ledR) throws TinkerforgeException
Sets the state of the LEDs. Possible states are: * 0 = AutoToggleOn: Enables auto toggle with initially enabled LED. * 1 = AutoToggleOff: Activates auto toggle with initially disabled LED. * 2 = On: Enables LED (auto toggle is disabled). * 3 = Off: Disables LED (auto toggle is disabled). In auto toggle mode the LED is toggled automatically at each press of a button. If you just want to set one of the LEDs and don't know the current state of the other LED, you can get the state withgetLEDState()
or you can usesetSelectedLEDState(int, int)
.- Throws:
TinkerforgeException
-
getLEDState
public BrickletDualButtonV2.LEDState getLEDState() throws TinkerforgeException
Returns the current state of the LEDs, as set bysetLEDState(int, int)
.- Throws:
TinkerforgeException
-
getButtonState
public BrickletDualButtonV2.ButtonState getButtonState() throws TinkerforgeException
Returns the current state for both buttons. Possible states are: * 0 = pressed * 1 = released- Throws:
TinkerforgeException
-
setSelectedLEDState
public void setSelectedLEDState(int led, int state) throws TinkerforgeException
Sets the state of the selected LED. The other LED remains untouched.- Throws:
TinkerforgeException
-
setStateChangedCallbackConfiguration
public void setStateChangedCallbackConfiguration(boolean enabled) throws TinkerforgeException
If you enable this listener, theBrickletDualButtonV2.StateChangedListener
listener is triggered every time a button is pressed/released- Throws:
TinkerforgeException
-
getStateChangedCallbackConfiguration
public boolean getStateChangedCallbackConfiguration() throws TinkerforgeException
Returns the configuration as set bysetStateChangedCallbackConfiguration(boolean)
.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletDualButtonV2.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
-
addStateChangedListener
public void addStateChangedListener(BrickletDualButtonV2.StateChangedListener listener)
Adds a StateChanged listener.
-
removeStateChangedListener
public void removeStateChangedListener(BrickletDualButtonV2.StateChangedListener listener)
Removes a StateChanged listener.
-
-