Java - Segment Display 4x7 Bricklet¶

Simple¶

Download (ExampleSimple.java)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletSegmentDisplay4x7;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your Segment Display 4x7 Bricklet
    private static final String UID = "XYZ";
    private static final byte[] DIGITS = {0x3f,0x06,0x5b,0x4f,
                                          0x66,0x6d,0x7d,0x07,
                                          0x7f,0x6f,0x77,0x7c,
                                          0x39,0x5e,0x79,0x71}; // 0~9,A,b,C,d,E,F

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletSegmentDisplay4x7 sd =
          new BrickletSegmentDisplay4x7(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Write "4223" to the display with full brightness without colon
        short[] segments = {DIGITS[4], DIGITS[2], DIGITS[2], DIGITS[3]};
        sd.setSegments(segments, (short)7, false);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Basic Functions¶

class BrickletSegmentDisplay4x7(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	segmentDisplay4x7 – Type: BrickletSegmentDisplay4x7

Creates an object with the unique device ID uid:

BrickletSegmentDisplay4x7 segmentDisplay4x7 = new BrickletSegmentDisplay4x7("YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

void BrickletSegmentDisplay4x7.setSegments(short[] segments, short brightness, boolean colon)¶

Parameters:	segments – Type: short[], Length: 4, Range: [0 to 127] brightness – Type: short, Range: [0 to 7] colon – Type: boolean

The 7-segment display can be set with bitmaps. Every bit controls one segment:

For example to set a "5" you would want to activate segments 0, 2, 3, 5 and 6. This is represented by the number 0b01101101 = 0x6d = 109.

The brightness can be set between 0 (dark) and 7 (bright). The colon parameter turns the colon of the display on or off.

BrickletSegmentDisplay4x7.Segments BrickletSegmentDisplay4x7.getSegments()¶

Return Object:	segments – Type: short[], Length: 4, Range: [0 to 127] brightness – Type: short, Range: [0 to 7] colon – Type: boolean

Returns the segment, brightness and color data as set by setSegments().

Advanced Functions¶

void BrickletSegmentDisplay4x7.startCounter(short valueFrom, short valueTo, short increment, long length)¶

Parameters:	valueFrom – Type: short, Range: [-999 to 9999] valueTo – Type: short, Range: [-999 to 9999] increment – Type: short, Range: [-999 to 9999] length – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

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 calling setSegments().

int BrickletSegmentDisplay4x7.getCounterValue()¶

Returns:	value – Type: int, Range: [-999 to 9999]

Returns the counter value that is currently shown on the display.

If there is no counter running a 0 will be returned.

BrickletSegmentDisplay4x7.Identity BrickletSegmentDisplay4x7.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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 Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Listeners¶

Listeners can be registered to receive time critical or recurring data from the device. The registration is done with add*Listener() functions of the device object.

The parameter is a listener class object, for example:

device.addExampleListener(new BrickletSegmentDisplay4x7.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

The available listener classes with inherent methods to be overwritten are described below. It is possible to add several listeners and to remove them with the corresponding remove*Listener() function.

class BrickletSegmentDisplay4x7.CounterFinishedListener()¶

This listener can be added with the addCounterFinishedListener() function. An added listener can be removed with the removeCounterFinishedListener() function.

void counterFinished()

This listener is triggered when the counter (see startCounter()) is finished.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

short[] BrickletSegmentDisplay4x7.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 0: major – Type: short, Range: [0 to 255] 1: minor – Type: short, Range: [0 to 255] 2: revision – Type: short, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

boolean BrickletSegmentDisplay4x7.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For listener configuration functions it is enabled by default too, but can be disabled by setResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
• BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3

void BrickletSegmentDisplay4x7.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and listener configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
• BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3

void BrickletSegmentDisplay4x7.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

Changes the response expected flag for all setter and listener configuration functions of this device at once.

Constants¶

int BrickletSegmentDisplay4x7.DEVICE_IDENTIFIER¶

This constant is used to identify a Segment Display 4x7 Bricklet.

The getIdentity() function and the IPConnection.EnumerateListener listener of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletSegmentDisplay4x7.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Segment Display 4x7 Bricklet.