Visual Basic .NET - Segment Display 4x7 Bricklet

This is the description of the Visual Basic .NET API bindings for the Segment Display 4x7 Bricklet. General information and technical specifications for the Segment Display 4x7 Bricklet are summarized in its hardware description.

An installation guide for the Visual Basic .NET API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Segment Display 4x7 Bricklet
    Dim DIGITS() As Byte = {&H3f,&H06,&H5b,&H4f, _
                            &H66,&H6d,&H7d,&H07, _
                            &H7f,&H6f,&H77,&H7c, _
                            &H39,&H5e,&H79,&H71} ' 0~9,A,b,C,d,E,F

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim sd As 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
        Dim segments() As Byte = {DIGITS(4), DIGITS(2), DIGITS(2), DIGITS(3)}
        sd.SetSegments(segments, 7, false)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Since Visual Basic .NET does not support multiple return values directly, we use the ByRef keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

Class BrickletSegmentDisplay4x7(ByVal uid As String, ByVal ipcon As IPConnection)

Creates an object with the unique device ID uid:

Dim segmentDisplay4x7 As New BrickletSegmentDisplay4x7("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected (see examples above).

Sub BrickletSegmentDisplay4x7.SetSegments(ByVal segments() As Byte, ByVal brightness As Byte, ByVal colon As Boolean)
Parameters:
  • segments – Type: Byte Array, Length: 4, Range: [0 to 127]
  • brightness – Type: Byte, Range: [0 to 7]
  • colon – Type: Boolean

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

Bit order of 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.

Sub BrickletSegmentDisplay4x7.GetSegments(ByRef segments() As Byte, ByRef brightness As Byte, ByRef colon As Boolean)
Output Parameters:
  • segments – Type: Byte Array, Length: 4, Range: [0 to 127]
  • brightness – Type: Byte, Range: [0 to 7]
  • colon – Type: Boolean

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

Advanced Functions

Sub BrickletSegmentDisplay4x7.StartCounter(ByVal valueFrom As Short, ByVal valueTo As Short, ByVal increment As Short, ByVal length As Long)
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().

Function BrickletSegmentDisplay4x7.GetCounterValue() As Integer
Returns:
  • value – Type: Integer, 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.

Sub BrickletSegmentDisplay4x7.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)
Output Parameters:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Char, Range: ["a"C to "h"C, "i"C, "z"C]
  • hardwareVersion – Type: Byte Array, Length: 3
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]
  • firmwareVersion – Type: Byte Array, Length: 3
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, Range: [0 to 255]
  • deviceIdentifier – Type: Integer, 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

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

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

Sub MyCallback(ByVal sender As BrickletSegmentDisplay4x7, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler segmentDisplay4x7.ExampleCallback, AddressOf MyCallback

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

Event BrickletSegmentDisplay4x7.CounterFinishedCallback(ByVal sender As BrickletSegmentDisplay4x7)
Callback Parameters:
  • sender – Type: BrickletSegmentDisplay4x7

This callback 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.

Function BrickletSegmentDisplay4x7.GetAPIVersion() As Byte()
Output Parameters:
  • apiVersion – Type: Byte Array, Length: 3
    • 0: major – Type: Byte, Range: [0 to 255]
    • 1: minor – Type: Byte, Range: [0 to 255]
    • 2: revision – Type: Byte, 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.

Function BrickletSegmentDisplay4x7.GetResponseExpected(ByVal functionId As Byte) As Boolean
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 callback 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 send 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
Sub BrickletSegmentDisplay4x7.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As Boolean)
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 callback 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 send 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
Sub BrickletSegmentDisplay4x7.SetResponseExpectedAll(ByVal responseExpected As Boolean)
Parameters:
  • responseExpected – Type: Boolean

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

Constants

Const BrickletSegmentDisplay4x7.DEVICE_IDENTIFIER

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

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

Const BrickletSegmentDisplay4x7.DEVICE_DISPLAY_NAME

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