Mathematica - Segment Display 4x7 Bricklet¶

Simple¶

Download (ExampleSimple.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Segment Display 4x7 Bricklet*)

(*0~9,A,b,C,d,E,F*)
digits={63,6,91,79,102,109,125,7,127,111,119,124,57,94,121,113}

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
sd=NETNew["Tinkerforge.BrickletSegmentDisplay4x7",uid,ipcon]
ipcon@Connect[host,port]

(*Write "4223" to the display with full brightness without colon*)
sd@SetSegments[{digits[[4+1]],digits[[2+1]],digits[[2+1]],digits[[3+1]]},7,False]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[sd]
ReleaseNETObject[ipcon]

Basic Functions¶

BrickletSegmentDisplay4x7[uid, ipcon] → segmentDisplay4x7¶

Parameters:	uid – Type: String ipcon – Type: NETObject[IPConnection]
Returns:	segmentDisplay4x7 – Type: NETObject[BrickletSegmentDisplay4x7]

Creates an object with the unique device ID uid:

segmentDisplay4x7=NETNew["Tinkerforge.BrickletSegmentDisplay4x7","YOUR_DEVICE_UID",ipcon]

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

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletSegmentDisplay4x7@SetSegments[{segments1, segments2, segments3, segments4}, brightness, colon] → Null¶

Parameters:	segmentsi – Type: Integer, Range: [0 to 127] brightness – Type: Integer, Range: [0 to 7] colon – Type: True/False

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@GetSegments[out {segments1, segments2, segments3, segments4}, out brightness, out colon] → Null¶

Output Parameters:	segmentsi – Type: Integer, Range: [0 to 127] brightness – Type: Integer, Range: [0 to 7] colon – Type: True/False

Returns the segment, brightness and color data as set by SetSegments[].

Advanced Functions¶

BrickletSegmentDisplay4x7@StartCounter[valueFrom, valueTo, increment, length] → Null¶

Parameters:	valueFrom – Type: Integer, Range: [-999 to 9999] valueTo – Type: Integer, Range: [-999 to 9999] increment – Type: Integer, Range: [-999 to 9999] length – Type: Integer, 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[].

BrickletSegmentDisplay4x7@GetCounterValue[] → value¶

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.

BrickletSegmentDisplay4x7@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶

Output Parameters:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]] hardwareVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, Range: [0 to 255] firmwareVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, 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). 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.

Callbacks¶

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

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[segmentDisplay4x7@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

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

event BrickletSegmentDisplay4x7@CounterFinishedCallback[sender]¶

Callback Parameters:	sender – Type: NETObject[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.

BrickletSegmentDisplay4x7@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}¶

Output Parameters:	apiVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, 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.

BrickletSegmentDisplay4x7@GetResponseExpected[functionId] → responseExpected¶

Parameters:	functionId – Type: Integer, Range: See constants
Returns:	responseExpected – Type: True/False

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletSegmentDisplay4x7`FUNCTIONUSETUSEGMENTS = 1
• BrickletSegmentDisplay4x7`FUNCTIONUSTARTUCOUNTER = 3

BrickletSegmentDisplay4x7@SetResponseExpected[functionId, responseExpected] → Null¶

Parameters:	functionId – Type: Integer, Range: See constants responseExpected – Type: True/False

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletSegmentDisplay4x7`FUNCTIONUSETUSEGMENTS = 1
• BrickletSegmentDisplay4x7`FUNCTIONUSTARTUCOUNTER = 3

BrickletSegmentDisplay4x7@SetResponseExpectedAll[responseExpected] → Null¶

Parameters:	responseExpected – Type: True/False

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

Constants¶

BrickletSegmentDisplay4x7`DEVICEUIDENTIFIER¶

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.

BrickletSegmentDisplay4x7`DEVICEDISPLAYNAME¶

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