Deutsch
English
Menu
Software / API Bindings / Mathematica / API Reference and Examples / Bricklets / RS232 Bricklet 2.0

Mathematica - RS232 Bricklet 2.0

This is the description of the Mathematica API bindings for the RS232 Bricklet 2.0. General information and technical specifications for the RS232 Bricklet 2.0 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).

Loopback

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

(*For this example connect the RX1 and TX pin to receive the send message*)

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

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

(*Callback function for read callback*)
ReadCB[sender_,message_]:=
 Print["Message: "<>FromCharacterCode[message]]
AddEventHandler[rs232@ReadCallback,ReadCB]

(*Enable read callback*)
rs232@EnableReadCallback[]

(*Write "test" string*)
rs232@Write[ToCharacterCode["test"]]

Input["Click OK to exit"]

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

API

Generally, every function 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 function. 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

BrickletRS232V2[uid, ipcon] → rs232V2
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • rs232V2 – Type: NETObject[BrickletRS232V2]

Creates an object with the unique device ID uid:

rs232V2=NETNew["Tinkerforge.BrickletRS232V2","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.

BrickletRS232V2@Write[{message1, message2, ...}] → messageWritten
Parameters:
  • messagei – Type: Integer
Returns:
  • messageWritten – Type: Integer, Range: [0 to 216 - 1]

Writes characters to the RS232 interface. The characters can be binary data, ASCII or similar is not necessary.

The return value is the number of characters that were written.

See SetConfiguration[] for configuration possibilities regarding baud rate, parity and so on.

BrickletRS232V2@Read[length] → {message1, message2, ...}
Parameters:
  • length – Type: Integer, Range: [0 to 216 - 1]
Returns:
  • messagei – Type: Integer

Returns up to length characters from receive buffer.

Instead of polling with this function, you can also use callbacks. But note that this function will return available data only when the read callback is disabled. See EnableReadCallback[] and ReadCallback callback.

BrickletRS232V2@SetConfiguration[baudrate, parity, stopbits, wordlength, flowcontrol] → Null
Parameters:
  • baudrate – Type: Integer, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200
  • parity – Type: Integer, Range: See constants, Default: 0
  • stopbits – Type: Integer, Range: See constants, Default: 1
  • wordlength – Type: Integer, Range: See constants, Default: 8
  • flowcontrol – Type: Integer, Range: See constants, Default: 0

Sets the configuration for the RS232 communication.

The following constants are available for this function:

For parity:

  • BrickletRS232V2`PARITYUNONE = 0
  • BrickletRS232V2`PARITYUODD = 1
  • BrickletRS232V2`PARITYUEVEN = 2

For stopbits:

  • BrickletRS232V2`STOPBITSU1 = 1
  • BrickletRS232V2`STOPBITSU2 = 2

For wordlength:

  • BrickletRS232V2`WORDLENGTHU5 = 5
  • BrickletRS232V2`WORDLENGTHU6 = 6
  • BrickletRS232V2`WORDLENGTHU7 = 7
  • BrickletRS232V2`WORDLENGTHU8 = 8

For flowcontrol:

  • BrickletRS232V2`FLOWCONTROLUOFF = 0
  • BrickletRS232V2`FLOWCONTROLUSOFTWARE = 1
  • BrickletRS232V2`FLOWCONTROLUHARDWARE = 2
BrickletRS232V2@GetConfiguration[out baudrate, out parity, out stopbits, out wordlength, out flowcontrol] → Null
Output Parameters:
  • baudrate – Type: Integer, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200
  • parity – Type: Integer, Range: See constants, Default: 0
  • stopbits – Type: Integer, Range: See constants, Default: 1
  • wordlength – Type: Integer, Range: See constants, Default: 8
  • flowcontrol – Type: Integer, Range: See constants, Default: 0

Returns the configuration as set by SetConfiguration[].

The following constants are available for this function:

For parity:

  • BrickletRS232V2`PARITYUNONE = 0
  • BrickletRS232V2`PARITYUODD = 1
  • BrickletRS232V2`PARITYUEVEN = 2

For stopbits:

  • BrickletRS232V2`STOPBITSU1 = 1
  • BrickletRS232V2`STOPBITSU2 = 2

For wordlength:

  • BrickletRS232V2`WORDLENGTHU5 = 5
  • BrickletRS232V2`WORDLENGTHU6 = 6
  • BrickletRS232V2`WORDLENGTHU7 = 7
  • BrickletRS232V2`WORDLENGTHU8 = 8

For flowcontrol:

  • BrickletRS232V2`FLOWCONTROLUOFF = 0
  • BrickletRS232V2`FLOWCONTROLUSOFTWARE = 1
  • BrickletRS232V2`FLOWCONTROLUHARDWARE = 2

Advanced Functions

BrickletRS232V2@SetBufferConfig[sendBufferSize, receiveBufferSize] → Null
Parameters:
  • sendBufferSize – Type: Integer, Unit: 1 B, Range: [210 to 9216], Default: 5120
  • receiveBufferSize – Type: Integer, Unit: 1 B, Range: [210 to 9216], Default: 5120

Sets the send and receive buffer size in byte. In total the buffers have to be 10240 byte (10KiB) in size, the minimum buffer size is 1024 byte (1KiB) for each.

The current buffer content is lost if this function is called.

The send buffer holds data that is given by Write[] and can not be written yet. The receive buffer holds data that is received through RS232 but could not yet be send to the user, either by Read[] or through ReadCallback callback.

BrickletRS232V2@GetBufferConfig[out sendBufferSize, out receiveBufferSize] → Null
Output Parameters:
  • sendBufferSize – Type: Integer, Unit: 1 B, Range: [210 to 9216], Default: 5120
  • receiveBufferSize – Type: Integer, Unit: 1 B, Range: [210 to 9216], Default: 5120

Returns the buffer configuration as set by SetBufferConfig[].

BrickletRS232V2@GetBufferStatus[out sendBufferUsed, out receiveBufferUsed] → Null
Output Parameters:
  • sendBufferUsed – Type: Integer, Unit: 1 B, Range: [0 to 9216]
  • receiveBufferUsed – Type: Integer, Unit: 1 B, Range: [0 to 9216]

Returns the currently used bytes for the send and received buffer.

See SetBufferConfig[] for buffer size configuration.

BrickletRS232V2@GetErrorCount[out errorCountOverrun, out errorCountParity] → Null
Output Parameters:
  • errorCountOverrun – Type: Integer, Range: [0 to 232 - 1]
  • errorCountParity – Type: Integer, Range: [0 to 232 - 1]

Returns the current number of overrun and parity errors.

BrickletRS232V2@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Output Parameters:
  • errorCountAckChecksum – Type: Integer, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: Integer, Range: [0 to 232 - 1]
  • errorCountFrame – Type: Integer, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: Integer, Range: [0 to 232 - 1]

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.

BrickletRS232V2@SetStatusLEDConfig[config] → Null
Parameters:
  • config – Type: Integer, Range: See constants, Default: 3

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.

The following constants are available for this function:

For config:

  • BrickletRS232V2`STATUSULEDUCONFIGUOFF = 0
  • BrickletRS232V2`STATUSULEDUCONFIGUON = 1
  • BrickletRS232V2`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletRS232V2`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletRS232V2@GetStatusLEDConfig[] → config
Returns:
  • config – Type: Integer, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig[]

The following constants are available for this function:

For config:

  • BrickletRS232V2`STATUSULEDUCONFIGUOFF = 0
  • BrickletRS232V2`STATUSULEDUCONFIGUON = 1
  • BrickletRS232V2`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletRS232V2`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletRS232V2@GetChipTemperature[] → temperature
Returns:
  • temperature – Type: Integer, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

BrickletRS232V2@Reset[] → Null

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!

BrickletRS232V2@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.

Callback Configuration Functions

BrickletRS232V2@EnableReadCallback[] → Null

Enables the ReadCallback callback. This will disable the FrameReadableCallback callback.

By default the callback is disabled.

BrickletRS232V2@DisableReadCallback[] → Null

Disables the ReadCallback callback.

By default the callback is disabled.

BrickletRS232V2@IsReadCallbackEnabled[] → enabled
Returns:
  • enabled – Type: True/False, Default: False

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

BrickletRS232V2@SetFrameReadableCallbackConfiguration[frameSize] → Null
Parameters:
  • frameSize – Type: Integer, Unit: 1 B, Range: [0 to 9216], Default: 0

Configures the FrameReadableCallback callback. The frame size is the number of bytes, that have to be readable to trigger the callback. A frame size of 0 disables the callback. A frame size greater than 0 enables the callback and disables the ReadCallback callback.

By default the callback is disabled.

New in version 2.0.3 (Plugin).

BrickletRS232V2@GetFrameReadableCallbackConfiguration[] → frameSize
Returns:
  • frameSize – Type: Integer, Unit: 1 B, Range: [0 to 9216], Default: 0

Returns the callback configuration as set by SetFrameReadableCallbackConfiguration[].

New in version 2.0.3 (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[rs232V2@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 BrickletRS232V2@ReadCallback[sender, {message1, message2, ...}]
Callback Parameters:
  • sender – Type: NETObject[BrickletRS232V2]
  • messagei – Type: Integer

This callback is called if new data is available.

To enable this callback, use EnableReadCallback[].

Note

If reconstructing the value fails, the callback is triggered with Null for message.

event BrickletRS232V2@ErrorCountCallback[sender, errorCountOverrun, errorCountParity]
Callback Parameters:
  • sender – Type: NETObject[BrickletRS232V2]
  • errorCountOverrun – Type: Integer, Range: [0 to 232 - 1]
  • errorCountParity – Type: Integer, Range: [0 to 232 - 1]

This callback is called if a new error occurs. It returns the current overrun and parity error count.

event BrickletRS232V2@FrameReadableCallback[sender, frameCount]
Callback Parameters:
  • sender – Type: NETObject[BrickletRS232V2]
  • frameCount – Type: Integer, Range: [0 to 216 - 1]

This callback is called if at least one frame of data is readable. The frame size is configured with SetFrameReadableCallbackConfiguration[]. The frame count parameter is the number of frames that can be read. This callback is triggered only once until Read[] is called. This means, that if you have configured a frame size of X bytes, you can read exactly X bytes using the Read[] function, every time the callback triggers without checking the frame count parameter.

New in version 2.0.3 (Plugin).

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.

BrickletRS232V2@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.

BrickletRS232V2@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:

  • BrickletRS232V2`FUNCTIONUENABLEUREADUCALLBACK = 3
  • BrickletRS232V2`FUNCTIONUDISABLEUREADUCALLBACK = 4
  • BrickletRS232V2`FUNCTIONUSETUCONFIGURATION = 6
  • BrickletRS232V2`FUNCTIONUSETUBUFFERUCONFIG = 8
  • BrickletRS232V2`FUNCTIONUSETUFRAMEUREADABLEUCALLBACKUCONFIGURATION = 14
  • BrickletRS232V2`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletRS232V2`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletRS232V2`FUNCTIONURESET = 243
  • BrickletRS232V2`FUNCTIONUWRITEUUID = 248
BrickletRS232V2@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:

  • BrickletRS232V2`FUNCTIONUENABLEUREADUCALLBACK = 3
  • BrickletRS232V2`FUNCTIONUDISABLEUREADUCALLBACK = 4
  • BrickletRS232V2`FUNCTIONUSETUCONFIGURATION = 6
  • BrickletRS232V2`FUNCTIONUSETUBUFFERUCONFIG = 8
  • BrickletRS232V2`FUNCTIONUSETUFRAMEUREADABLEUCALLBACKUCONFIGURATION = 14
  • BrickletRS232V2`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletRS232V2`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletRS232V2`FUNCTIONURESET = 243
  • BrickletRS232V2`FUNCTIONUWRITEUUID = 248
BrickletRS232V2@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.

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickletRS232V2@SetBootloaderMode[mode] → status
Parameters:
  • mode – Type: Integer, Range: See constants
Returns:
  • status – Type: Integer, Range: See constants

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.

The following constants are available for this function:

For mode:

  • BrickletRS232V2`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletRS232V2`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletRS232V2`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletRS232V2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletRS232V2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4

For status:

  • BrickletRS232V2`BOOTLOADERUSTATUSUOK = 0
  • BrickletRS232V2`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletRS232V2`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletRS232V2`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletRS232V2`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletRS232V2`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletRS232V2@GetBootloaderMode[] → mode
Returns:
  • mode – Type: Integer, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode[].

The following constants are available for this function:

For mode:

  • BrickletRS232V2`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletRS232V2`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletRS232V2`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletRS232V2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletRS232V2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletRS232V2@SetWriteFirmwarePointer[pointer] → Null
Parameters:
  • pointer – Type: Integer, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for WriteFirmware[]. 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.

BrickletRS232V2@WriteFirmware[{data1, data2, ..., data64}] → status
Parameters:
  • datai – Type: Integer, Range: [0 to 255]
Returns:
  • status – Type: Integer, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer[] 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.

BrickletRS232V2@WriteUID[uid] → Null
Parameters:
  • uid – Type: Integer, Range: [0 to 232 - 1]

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.

BrickletRS232V2@ReadUID[] → uid
Returns:
  • uid – Type: Integer, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

Constants

BrickletRS232V2`DEVICEUIDENTIFIER

This constant is used to identify a RS232 Bricklet 2.0.

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.

BrickletRS232V2`DEVICEDISPLAYNAME

This constant represents the human readable name of a RS232 Bricklet 2.0.