Mathematica - LED Strip Bricklet

This is the description of the Mathematica API bindings for the LED Strip Bricklet. General information and technical specifications for the LED Strip Bricklet are summarized in its hardware description.

An installation guide for the Mathematica API bindings is part of their general description.

Examples

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

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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your LED Strip Bricklet*)

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

(*Set first 10 LEDs to green*)
ls@SetRGBValues[0,10,{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0},
                {255,255,255,255,255,255,255,255,255,255,0,0,0,0,0,0},
                {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}]

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

Callback

Download (ExampleCallback.nb)

 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
33
34
35
36
37
38
39
40
41
42
43
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your LED Strip Bricklet*)

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

(*Set frame duration to 50ms (20 frames per second)*)
ls@SetFrameDuration[50]

numLEDs=16
rIndex=1
r={0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}
g={0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}
b={0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}

(*Use frame rendered callback to move the active LED every frame*)
FrameRenderedCB[sender_,length_]:=
 Module[{},
  b[[rIndex]]=0;
  If[rIndex==numLEDs,rIndex=1,rIndex=rIndex+1];
  b[[rIndex]]=255;

  (* Set new data for next render cycle *)
  sender@SetRGBValues[0,numLEDs,r,g,b]
 ]

AddEventHandler[ls@FrameRenderedCallback,FrameRenderedCB]

(* Set initial rgb values to get started *)
ls@SetRGBValues[0,numLEDs,r,g,b]

Input["Click OK to exit"]

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

API

Generally, every method of the Mathematica bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a method. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletLEDStrip[uid, ipcon] → ledStrip
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • ledStrip – Type: NETObject[BrickletLEDStrip]

Creates an object with the unique device ID uid:

ledStrip=NETNew["Tinkerforge.BrickletLEDStrip","YOUR_DEVICE_UID",ipcon]

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

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.

BrickletLEDStrip@SetRGBValues[index, length, {r1, r2, ..., r16}, {g1, g2, ..., g16}, {b1, b2, ..., b16}] → Null
Parameters:
  • index – Type: Integer, Range: [0 to 216 - 1]
  • length – Type: Integer, Range: [0 to 255]
  • ri – Type: Integer, Range: [0 to 255]
  • gi – Type: Integer, Range: [0 to 255]
  • bi – Type: Integer, Range: [0 to 255]

Sets the RGB values for the LEDs with the given length starting from index.

To make the colors show correctly you need to configure the chip type (SetChipType[]) and a 3-channel channel mapping (SetChannelMapping[]) according to the connected LEDs.

The maximum length is 16, the index goes from 0 to 319 and the rgb values have 8 bits each.

Example: If you set

  • index to 5,
  • length to 3,
  • r to [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • g to [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] and
  • b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

the LED with index 5 will be red, 6 will be green and 7 will be blue.

Note

Depending on the LED circuitry colors can be permuted.

The colors will be transfered to actual LEDs when the next frame duration ends, see SetFrameDuration[].

Generic approach:

  • Set the frame duration to a value that represents the number of frames per second you want to achieve.
  • Set all of the LED colors for one frame.
  • Wait for the FrameRenderedCallback callback.
  • Set all of the LED colors for next frame.
  • Wait for the FrameRenderedCallback callback.
  • and so on.

This approach ensures that you can change the LED colors with a fixed frame rate.

The actual number of controllable LEDs depends on the number of free Bricklet ports. See here for more information. A call of SetRGBValues[] with index + length above the bounds is ignored completely.

BrickletLEDStrip@GetRGBValues[index, length, out {r1, r2, ..., r16}, out {g1, g2, ..., g16}, out {b1, b2, ..., b16}] → Null
Parameters:
  • index – Type: Integer, Range: [0 to 216 - 1]
  • length – Type: Integer, Range: [0 to 255]
Output Parameters:
  • ri – Type: Integer, Range: [0 to 255]
  • gi – Type: Integer, Range: [0 to 255]
  • bi – Type: Integer, Range: [0 to 255]

Returns RGB value with the given length starting from the given index.

The values are the last values that were set by SetRGBValues[].

BrickletLEDStrip@SetFrameDuration[duration] → Null
Parameters:
  • duration – Type: Integer, Range: [0 to 216 - 1]

Sets the frame duration in ms.

Example: If you want to achieve 20 frames per second, you should set the frame duration to 50ms (50ms * 20 = 1 second).

For an explanation of the general approach see SetRGBValues[].

Default value: 100ms (10 frames per second).

BrickletLEDStrip@GetFrameDuration[] → duration
Returns:
  • duration – Type: Integer, Range: [0 to 216 - 1]

Returns the frame duration in ms as set by SetFrameDuration[].

BrickletLEDStrip@GetSupplyVoltage[] → voltage
Returns:
  • voltage – Type: Integer, Range: [0 to 216 - 1]

Returns the current supply voltage of the LEDs. The voltage is given in mV.

BrickletLEDStrip@SetClockFrequency[frequency] → Null
Parameters:
  • frequency – Type: Integer, Range: [0 to 232 - 1]

Sets the frequency of the clock in Hz. The range is 10000Hz (10kHz) up to 2000000Hz (2MHz).

The Bricklet will choose the nearest achievable frequency, which may be off by a few Hz. You can get the exact frequency that is used by calling GetClockFrequency[].

If you have problems with flickering LEDs, they may be bits flipping. You can fix this by either making the connection between the LEDs and the Bricklet shorter or by reducing the frequency.

With a decreasing frequency your maximum frames per second will decrease too.

The default value is 1.66MHz.

Note

The frequency in firmware version 2.0.0 is fixed at 2MHz.

New in version 2.0.1 (Plugin).

BrickletLEDStrip@GetClockFrequency[] → frequency
Returns:
  • frequency – Type: Integer, Range: [0 to 232 - 1]

Returns the currently used clock frequency as set by SetClockFrequency[].

New in version 2.0.1 (Plugin).

BrickletLEDStrip@SetChipType[chip] → Null
Parameters:
  • chip – Type: Integer, Range: See constants

Sets the type of the LED driver chip. We currently support the chips

  • WS2801,
  • WS2811,
  • WS2812 / SK6812 / NeoPixel RGB,
  • SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
  • LPD8806 and
  • APA102 / DotStar.

The default value is WS2801 (2801).

The following constants are available for this function:

For chip:

  • BrickletLEDStrip`CHIPUTYPEUWS2801 = 2801
  • BrickletLEDStrip`CHIPUTYPEUWS2811 = 2811
  • BrickletLEDStrip`CHIPUTYPEUWS2812 = 2812
  • BrickletLEDStrip`CHIPUTYPEULPD8806 = 8806
  • BrickletLEDStrip`CHIPUTYPEUAPA102 = 102

New in version 2.0.2 (Plugin).

BrickletLEDStrip@GetChipType[] → chip
Returns:
  • chip – Type: Integer, Range: See constants

Returns the currently used chip type as set by SetChipType[].

The following constants are available for this function:

For chip:

  • BrickletLEDStrip`CHIPUTYPEUWS2801 = 2801
  • BrickletLEDStrip`CHIPUTYPEUWS2811 = 2811
  • BrickletLEDStrip`CHIPUTYPEUWS2812 = 2812
  • BrickletLEDStrip`CHIPUTYPEULPD8806 = 8806
  • BrickletLEDStrip`CHIPUTYPEUAPA102 = 102

New in version 2.0.2 (Plugin).

BrickletLEDStrip@SetRGBWValues[index, length, {r1, r2, ..., r12}, {g1, g2, ..., g12}, {b1, b2, ..., b12}, {w1, w2, ..., w12}] → Null
Parameters:
  • index – Type: Integer, Range: [0 to 216 - 1]
  • length – Type: Integer, Range: [0 to 255]
  • ri – Type: Integer, Range: [0 to 255]
  • gi – Type: Integer, Range: [0 to 255]
  • bi – Type: Integer, Range: [0 to 255]
  • wi – Type: Integer, Range: [0 to 255]

Sets the RGBW values for the LEDs with the given length starting from index.

To make the colors show correctly you need to configure the chip type (SetChipType[]) and a 4-channel channel mapping (SetChannelMapping[]) according to the connected LEDs.

The maximum length is 12, the index goes from 0 to 239 and the rgbw values have 8 bits each.

Example: If you set

  • index to 5,
  • length to 4,
  • r to [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • g to [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] and
  • w to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0]

the LED with index 5 will be red, 6 will be green, 7 will be blue and 8 will be white.

Note

Depending on the LED circuitry colors can be permuted.

The colors will be transfered to actual LEDs when the next frame duration ends, see SetFrameDuration[].

Generic approach:

  • Set the frame duration to a value that represents the number of frames per second you want to achieve.
  • Set all of the LED colors for one frame.
  • Wait for the FrameRenderedCallback callback.
  • Set all of the LED colors for next frame.
  • Wait for the FrameRenderedCallback callback.
  • and so on.

This approach ensures that you can change the LED colors with a fixed frame rate.

The actual number of controllable LEDs depends on the number of free Bricklet ports. See here for more information. A call of SetRGBWValues[] with index + length above the bounds is ignored completely.

The LPD8806 LED driver chips have 7-bit channels for RGB. Internally the LED Strip Bricklets divides the 8-bit values set using this function by 2 to make them 7-bit. Therefore, you can just use the normal value range (0-255) for LPD8806 LEDs.

The brightness channel of the APA102 LED driver chips has 5-bit. Internally the LED Strip Bricklets divides the 8-bit values set using this function by 8 to make them 5-bit. Therefore, you can just use the normal value range (0-255) for the brightness channel of APA102 LEDs.

New in version 2.0.6 (Plugin).

BrickletLEDStrip@GetRGBWValues[index, length, out {r1, r2, ..., r12}, out {g1, g2, ..., g12}, out {b1, b2, ..., b12}, out {w1, w2, ..., w12}] → Null
Parameters:
  • index – Type: Integer, Range: [0 to 216 - 1]
  • length – Type: Integer, Range: [0 to 255]
Output Parameters:
  • ri – Type: Integer, Range: [0 to 255]
  • gi – Type: Integer, Range: [0 to 255]
  • bi – Type: Integer, Range: [0 to 255]
  • wi – Type: Integer, Range: [0 to 255]

Returns RGBW values with the given length starting from the given index.

The values are the last values that were set by SetRGBWValues[].

New in version 2.0.6 (Plugin).

BrickletLEDStrip@SetChannelMapping[mapping] → Null
Parameters:
  • mapping – Type: Integer, Range: See constants

Sets the channel mapping for the connected LEDs.

SetRGBValues[] and SetRGBWValues[] take the data in RGB(W) order. But the connected LED driver chips might have their 3 or 4 channels in a different order. For example, the WS2801 chips typically use BGR order, the WS2812 chips typically use GRB order and the APA102 chips typically use WBGR order.

The APA102 chips are special. They have three 8-bit channels for RGB and an additional 5-bit channel for the overall brightness of the RGB LED making them 4-channel chips. Internally the brightness channel is the first channel, therefore one of the Wxyz channel mappings should be used. Then the W channel controls the brightness.

If a 3-channel mapping is selected then SetRGBValues[] has to be used. Calling SetRGBWValues[] with a 3-channel mapping will produce incorrect results. Vice-versa if a 4-channel mapping is selected then SetRGBWValues[] has to be used. Calling SetRGBValues[] with a 4-channel mapping will produce incorrect results.

The default value is BGR (36).

The following constants are available for this function:

For mapping:

  • BrickletLEDStrip`CHANNELUMAPPINGURGB = 6
  • BrickletLEDStrip`CHANNELUMAPPINGURBG = 9
  • BrickletLEDStrip`CHANNELUMAPPINGUBRG = 33
  • BrickletLEDStrip`CHANNELUMAPPINGUBGR = 36
  • BrickletLEDStrip`CHANNELUMAPPINGUGRB = 18
  • BrickletLEDStrip`CHANNELUMAPPINGUGBR = 24
  • BrickletLEDStrip`CHANNELUMAPPINGURGBW = 27
  • BrickletLEDStrip`CHANNELUMAPPINGURGWB = 30
  • BrickletLEDStrip`CHANNELUMAPPINGURBGW = 39
  • BrickletLEDStrip`CHANNELUMAPPINGURBWG = 45
  • BrickletLEDStrip`CHANNELUMAPPINGURWGB = 54
  • BrickletLEDStrip`CHANNELUMAPPINGURWBG = 57
  • BrickletLEDStrip`CHANNELUMAPPINGUGRWB = 78
  • BrickletLEDStrip`CHANNELUMAPPINGUGRBW = 75
  • BrickletLEDStrip`CHANNELUMAPPINGUGBWR = 108
  • BrickletLEDStrip`CHANNELUMAPPINGUGBRW = 99
  • BrickletLEDStrip`CHANNELUMAPPINGUGWBR = 120
  • BrickletLEDStrip`CHANNELUMAPPINGUGWRB = 114
  • BrickletLEDStrip`CHANNELUMAPPINGUBRGW = 135
  • BrickletLEDStrip`CHANNELUMAPPINGUBRWG = 141
  • BrickletLEDStrip`CHANNELUMAPPINGUBGRW = 147
  • BrickletLEDStrip`CHANNELUMAPPINGUBGWR = 156
  • BrickletLEDStrip`CHANNELUMAPPINGUBWRG = 177
  • BrickletLEDStrip`CHANNELUMAPPINGUBWGR = 180
  • BrickletLEDStrip`CHANNELUMAPPINGUWRBG = 201
  • BrickletLEDStrip`CHANNELUMAPPINGUWRGB = 198
  • BrickletLEDStrip`CHANNELUMAPPINGUWGBR = 216
  • BrickletLEDStrip`CHANNELUMAPPINGUWGRB = 210
  • BrickletLEDStrip`CHANNELUMAPPINGUWBGR = 228
  • BrickletLEDStrip`CHANNELUMAPPINGUWBRG = 225

New in version 2.0.6 (Plugin).

BrickletLEDStrip@GetChannelMapping[] → mapping
Returns:
  • mapping – Type: Integer, Range: See constants

Returns the currently used channel mapping as set by SetChannelMapping[].

The following constants are available for this function:

For mapping:

  • BrickletLEDStrip`CHANNELUMAPPINGURGB = 6
  • BrickletLEDStrip`CHANNELUMAPPINGURBG = 9
  • BrickletLEDStrip`CHANNELUMAPPINGUBRG = 33
  • BrickletLEDStrip`CHANNELUMAPPINGUBGR = 36
  • BrickletLEDStrip`CHANNELUMAPPINGUGRB = 18
  • BrickletLEDStrip`CHANNELUMAPPINGUGBR = 24
  • BrickletLEDStrip`CHANNELUMAPPINGURGBW = 27
  • BrickletLEDStrip`CHANNELUMAPPINGURGWB = 30
  • BrickletLEDStrip`CHANNELUMAPPINGURBGW = 39
  • BrickletLEDStrip`CHANNELUMAPPINGURBWG = 45
  • BrickletLEDStrip`CHANNELUMAPPINGURWGB = 54
  • BrickletLEDStrip`CHANNELUMAPPINGURWBG = 57
  • BrickletLEDStrip`CHANNELUMAPPINGUGRWB = 78
  • BrickletLEDStrip`CHANNELUMAPPINGUGRBW = 75
  • BrickletLEDStrip`CHANNELUMAPPINGUGBWR = 108
  • BrickletLEDStrip`CHANNELUMAPPINGUGBRW = 99
  • BrickletLEDStrip`CHANNELUMAPPINGUGWBR = 120
  • BrickletLEDStrip`CHANNELUMAPPINGUGWRB = 114
  • BrickletLEDStrip`CHANNELUMAPPINGUBRGW = 135
  • BrickletLEDStrip`CHANNELUMAPPINGUBRWG = 141
  • BrickletLEDStrip`CHANNELUMAPPINGUBGRW = 147
  • BrickletLEDStrip`CHANNELUMAPPINGUBGWR = 156
  • BrickletLEDStrip`CHANNELUMAPPINGUBWRG = 177
  • BrickletLEDStrip`CHANNELUMAPPINGUBWGR = 180
  • BrickletLEDStrip`CHANNELUMAPPINGUWRBG = 201
  • BrickletLEDStrip`CHANNELUMAPPINGUWRGB = 198
  • BrickletLEDStrip`CHANNELUMAPPINGUWGBR = 216
  • BrickletLEDStrip`CHANNELUMAPPINGUWGRB = 210
  • BrickletLEDStrip`CHANNELUMAPPINGUWBGR = 228
  • BrickletLEDStrip`CHANNELUMAPPINGUWBRG = 225

New in version 2.0.6 (Plugin).

Advanced Functions

BrickletLEDStrip@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni – Type: Integer, Range: [0 to 255]

Returns the version of the API definition (major, minor, revision) 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.

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

The following constants are available for this function:

For functionId:

  • BrickletLEDStrip`FUNCTIONUSETURGBUVALUES = 1
  • BrickletLEDStrip`FUNCTIONUSETUFRAMEUDURATION = 3
  • BrickletLEDStrip`FUNCTIONUSETUCLOCKUFREQUENCY = 7
  • BrickletLEDStrip`FUNCTIONUSETUCHIPUTYPE = 9
  • BrickletLEDStrip`FUNCTIONUSETURGBWUVALUES = 11
  • BrickletLEDStrip`FUNCTIONUSETUCHANNELUMAPPING = 13
  • BrickletLEDStrip`FUNCTIONUENABLEUFRAMEURENDEREDUCALLBACK = 15
  • BrickletLEDStrip`FUNCTIONUDISABLEUFRAMEURENDEREDUCALLBACK = 16
BrickletLEDStrip@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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletLEDStrip`FUNCTIONUSETURGBUVALUES = 1
  • BrickletLEDStrip`FUNCTIONUSETUFRAMEUDURATION = 3
  • BrickletLEDStrip`FUNCTIONUSETUCLOCKUFREQUENCY = 7
  • BrickletLEDStrip`FUNCTIONUSETUCHIPUTYPE = 9
  • BrickletLEDStrip`FUNCTIONUSETURGBWUVALUES = 11
  • BrickletLEDStrip`FUNCTIONUSETUCHANNELUMAPPING = 13
  • BrickletLEDStrip`FUNCTIONUENABLEUFRAMEURENDEREDUCALLBACK = 15
  • BrickletLEDStrip`FUNCTIONUDISABLEUFRAMEURENDEREDUCALLBACK = 16
BrickletLEDStrip@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.

BrickletLEDStrip@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
  • hardwareVersioni – Type: Integer, Range: [0 to 255]
  • firmwareVersioni – 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' or 'd'.

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

Callback Configuration Functions

BrickletLEDStrip@EnableFrameRenderedCallback[] → Null

Enables the FrameRenderedCallback callback.

By default the callback is enabled.

New in version 2.0.6 (Plugin).

BrickletLEDStrip@DisableFrameRenderedCallback[] → Null

Disables the FrameRenderedCallback callback.

By default the callback is enabled.

New in version 2.0.6 (Plugin).

BrickletLEDStrip@IsFrameRenderedCallbackEnabled[] → enabled
Returns:
  • enabled – Type: True/False

Returns true if the FrameRenderedCallback callback is enabled, false otherwise.

New in version 2.0.6 (Plugin).

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[ledStrip@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.

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 BrickletLEDStrip@FrameRenderedCallback[sender, length]
Callback Parameters:
  • sender – Type: NETObject[BrickletLEDStrip]
  • length – Type: Integer, Range: [0 to 216 - 1]

This callback is triggered directly after a new frame is rendered. The parameter is the number of LEDs in that frame.

You should send the data for the next frame directly after this callback was triggered.

For an explanation of the general approach see SetRGBValues[].

Constants

BrickletLEDStrip`DEVICEUIDENTIFIER

This constant is used to identify a LED Strip 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.

BrickletLEDStrip`DEVICEDISPLAYNAME

This constant represents the human readable name of a LED Strip Bricklet.