Package com.tinkerforge
Class BrickletSegmentDisplay4x7V2
- java.lang.Object
-
- com.tinkerforge.DeviceBase
-
- com.tinkerforge.Device
-
- com.tinkerforge.BrickletSegmentDisplay4x7V2
-
public class BrickletSegmentDisplay4x7V2 extends Device
Four 7-segment displays with switchable dots
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BrickletSegmentDisplay4x7V2.CounterFinishedListener
This listener is triggered when the counter (seestartCounter(int, int, int, long)
) is finished.class
BrickletSegmentDisplay4x7V2.Segments
class
BrickletSegmentDisplay4x7V2.SPITFPErrorCount
-
Nested classes/interfaces inherited from class com.tinkerforge.Device
Device.Identity
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description BrickletSegmentDisplay4x7V2(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
addCounterFinishedListener(BrickletSegmentDisplay4x7V2.CounterFinishedListener listener)
Adds a CounterFinished listener.int
getBootloaderMode()
Returns the current bootloader mode, seesetBootloaderMode(int)
.int
getBrightness()
Returns the brightness as set bysetBrightness(int)
.int
getChipTemperature()
Returns the temperature as measured inside the microcontroller.int
getCounterValue()
Returns the counter value that is currently shown on the display.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.BrickletSegmentDisplay4x7V2.Segments
getSegments()
Returns the segment data as set bysetSegments(boolean[], boolean[], boolean[], boolean[], boolean[], boolean)
.boolean
getSelectedSegment(int segment)
Returns the value of a single segment.BrickletSegmentDisplay4x7V2.SPITFPErrorCount
getSPITFPErrorCount()
Returns the error count for the communication between Brick and Bricklet.int
getStatusLEDConfig()
Returns the configuration as set bysetStatusLEDConfig(int)
long
readUID()
Returns the current UID as an integer.void
removeCounterFinishedListener(BrickletSegmentDisplay4x7V2.CounterFinishedListener listener)
Removes a CounterFinished 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
setBrightness(int brightness)
The brightness can be set between 0 (dark) and 7 (bright).void
setNumericValue(int[] value)
Sets a numeric value for each of the digits.void
setSegments(boolean[] digit0, boolean[] digit1, boolean[] digit2, boolean[] digit3, boolean[] colon, boolean tick)
Sets the segments of the Segment Display 4x7 Bricklet 2.0 segment-by-segment.void
setSelectedSegment(int segment, boolean value)
Turns one specified segment on or off.void
setStatusLEDConfig(int config)
Sets the status LED configuration.void
setWriteFirmwarePointer(long pointer)
Sets the firmware pointer forwriteFirmware(int[])
.void
startCounter(int valueFrom, int valueTo, int increment, long length)
Starts a counter with the *from* value that counts to the *to* value with the each step incremented by *increment*.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_SEGMENTS
public static final byte FUNCTION_SET_SEGMENTS
- See Also:
- Constant Field Values
-
FUNCTION_GET_SEGMENTS
public static final byte FUNCTION_GET_SEGMENTS
- See Also:
- Constant Field Values
-
FUNCTION_SET_BRIGHTNESS
public static final byte FUNCTION_SET_BRIGHTNESS
- See Also:
- Constant Field Values
-
FUNCTION_GET_BRIGHTNESS
public static final byte FUNCTION_GET_BRIGHTNESS
- See Also:
- Constant Field Values
-
FUNCTION_SET_NUMERIC_VALUE
public static final byte FUNCTION_SET_NUMERIC_VALUE
- See Also:
- Constant Field Values
-
FUNCTION_SET_SELECTED_SEGMENT
public static final byte FUNCTION_SET_SELECTED_SEGMENT
- See Also:
- Constant Field Values
-
FUNCTION_GET_SELECTED_SEGMENT
public static final byte FUNCTION_GET_SELECTED_SEGMENT
- See Also:
- Constant Field Values
-
FUNCTION_START_COUNTER
public static final byte FUNCTION_START_COUNTER
- See Also:
- Constant Field Values
-
FUNCTION_GET_COUNTER_VALUE
public static final byte FUNCTION_GET_COUNTER_VALUE
- 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
-
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
-
BrickletSegmentDisplay4x7V2
public BrickletSegmentDisplay4x7V2(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
-
setSegments
public void setSegments(boolean[] digit0, boolean[] digit1, boolean[] digit2, boolean[] digit3, boolean[] colon, boolean tick) throws TinkerforgeException
Sets the segments of the Segment Display 4x7 Bricklet 2.0 segment-by-segment. The data is split into the four digits, two colon dots and the tick mark. The indices of the segments in the digit and colon parameters are as follows: .. image:: /Images/Bricklets/bricklet_segment_display_4x7_v2_segment_index.png :scale: 100 % :alt: Indices of segments :align: center- Throws:
TinkerforgeException
-
getSegments
public BrickletSegmentDisplay4x7V2.Segments getSegments() throws TinkerforgeException
Returns the segment data as set bysetSegments(boolean[], boolean[], boolean[], boolean[], boolean[], boolean)
.- Throws:
TinkerforgeException
-
setBrightness
public void setBrightness(int brightness) throws TinkerforgeException
The brightness can be set between 0 (dark) and 7 (bright).- Throws:
TinkerforgeException
-
getBrightness
public int getBrightness() throws TinkerforgeException
Returns the brightness as set bysetBrightness(int)
.- Throws:
TinkerforgeException
-
setNumericValue
public void setNumericValue(int[] value) throws TinkerforgeException
Sets a numeric value for each of the digits. They represent: * -2: minus sign * -1: blank * 0-9: 0-9 * 10: A * 11: b * 12: C * 13: d * 14: E * 15: F Example: A call with [-2, -1, 4, 2] will result in a display of "- 42".- Throws:
TinkerforgeException
-
setSelectedSegment
public void setSelectedSegment(int segment, boolean value) throws TinkerforgeException
Turns one specified segment on or off. The indices of the segments are as follows: .. image:: /Images/Bricklets/bricklet_segment_display_4x7_v2_selected_segment_index.png :scale: 100 % :alt: Indices of selected segments :align: center- Throws:
TinkerforgeException
-
getSelectedSegment
public boolean getSelectedSegment(int segment) throws TinkerforgeException
Returns the value of a single segment.- Throws:
TinkerforgeException
-
startCounter
public void startCounter(int valueFrom, int valueTo, int increment, long length) throws TinkerforgeException
Starts a counter with the *from* value that counts to the *to* value with the each step incremented by *increment*. *length* is the pause between each increment. Example: If you set *from* to 0, *to* to 100, *increment* to 1 and *length* to 1000, a counter that goes from 0 to 100 with one second pause between each increment will be started. Using a negative *increment* allows to count backwards. You can stop the counter at every time by callingsetSegments(boolean[], boolean[], boolean[], boolean[], boolean[], boolean)
orsetNumericValue(int[])
.- Throws:
TinkerforgeException
-
getCounterValue
public int getCounterValue() throws TinkerforgeException
Returns the counter value that is currently shown on the display. If there is no counter running a 0 will be returned.- Throws:
TinkerforgeException
-
getSPITFPErrorCount
public BrickletSegmentDisplay4x7V2.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
-
addCounterFinishedListener
public void addCounterFinishedListener(BrickletSegmentDisplay4x7V2.CounterFinishedListener listener)
Adds a CounterFinished listener.
-
removeCounterFinishedListener
public void removeCounterFinishedListener(BrickletSegmentDisplay4x7V2.CounterFinishedListener listener)
Removes a CounterFinished listener.
-
-