Shell - RS232 Bricklet 2.0¶

Loopback¶

Download (example-loopback.sh)

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

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

# For this example connect the RX1 and TX pin to receive the send message

uid=XYZ # Change XYZ to the UID of your RS232 Bricklet 2.0

# Handle incoming read callbacks
tinkerforge dispatch rs232-v2-bricklet $uid read &

# Enable read callback
tinkerforge call rs232-v2-bricklet $uid enable-read-callback

# Write "test" string
tinkerforge call rs232-v2-bricklet $uid write t,e,s,t

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call rs232-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the RS232 Bricklet 2.0. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the RS232 Bricklet 2.0 and exits

tinkerforge dispatch rs232-v2-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the RS232 Bricklet 2.0. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the RS232 Bricklet 2.0 and exits

tinkerforge call rs232-v2-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch rs232-v2-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call rs232-v2-bricklet <uid> write <message>¶

Parameters:	<message> – Type: Char Array, Length: variable
Output:	message-written – Type: Int, 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 set-configuration for configuration possibilities regarding baud rate, parity and so on.

tinkerforge call rs232-v2-bricklet <uid> read <length>¶

Parameters:	<length> – Type: Int, Range: [0 to 216 - 1]
Output:	message – Type: Char Array, Length: variable

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 enable-read-callback and read callback.

tinkerforge call rs232-v2-bricklet <uid> set-configuration <baudrate> <parity> <stopbits> <wordlength> <flowcontrol>¶

Parameters:	<baudrate> – Type: Int, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200 <parity> – Type: Int, Range: See symbols, Default: 0 <stopbits> – Type: Int, Range: See symbols, Default: 1 <wordlength> – Type: Int, Range: See symbols, Default: 8 <flowcontrol> – Type: Int, Range: See symbols, Default: 0
Output:	no output

Sets the configuration for the RS232 communication.

The following symbols are available for this function:

For <parity>:

• parity-none = 0
• parity-odd = 1
• parity-even = 2

For <stopbits>:

• stopbits-1 = 1
• stopbits-2 = 2

For <wordlength>:

• wordlength-5 = 5
• wordlength-6 = 6
• wordlength-7 = 7
• wordlength-8 = 8

For <flowcontrol>:

• flowcontrol-off = 0
• flowcontrol-software = 1
• flowcontrol-hardware = 2

tinkerforge call rs232-v2-bricklet <uid> get-configuration¶

Output:	baudrate – Type: Int, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200 parity – Type: Int, Range: See symbols, Default: 0 stopbits – Type: Int, Range: See symbols, Default: 1 wordlength – Type: Int, Range: See symbols, Default: 8 flowcontrol – Type: Int, Range: See symbols, Default: 0

Returns the configuration as set by set-configuration.

The following symbols are available for this function:

For parity:

• parity-none = 0
• parity-odd = 1
• parity-even = 2

For stopbits:

• stopbits-1 = 1
• stopbits-2 = 2

For wordlength:

• wordlength-5 = 5
• wordlength-6 = 6
• wordlength-7 = 7
• wordlength-8 = 8

For flowcontrol:

• flowcontrol-off = 0
• flowcontrol-software = 1
• flowcontrol-hardware = 2

Advanced Functions¶

tinkerforge call rs232-v2-bricklet <uid> set-buffer-config <send-buffer-size> <receive-buffer-size>¶

Parameters:	<send-buffer-size> – Type: Int, Unit: 1 B, Range: [210 to 9216], Default: 5120 <receive-buffer-size> – Type: Int, Unit: 1 B, Range: [210 to 9216], Default: 5120
Output:	no output

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

tinkerforge call rs232-v2-bricklet <uid> get-buffer-config¶

Output:	send-buffer-size – Type: Int, Unit: 1 B, Range: [210 to 9216], Default: 5120 receive-buffer-size – Type: Int, Unit: 1 B, Range: [210 to 9216], Default: 5120

Returns the buffer configuration as set by set-buffer-config.

tinkerforge call rs232-v2-bricklet <uid> get-buffer-status¶

Output:	send-buffer-used – Type: Int, Unit: 1 B, Range: [0 to 9216] receive-buffer-used – Type: Int, Unit: 1 B, Range: [0 to 9216]

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

See set-buffer-config for buffer size configuration.

tinkerforge call rs232-v2-bricklet <uid> get-error-count¶

Output:	error-count-overrun – Type: Int, Range: [0 to 232 - 1] error-count-parity – Type: Int, Range: [0 to 232 - 1]

Returns the current number of overrun and parity errors.

tinkerforge call rs232-v2-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, 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.

tinkerforge call rs232-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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 symbols are available for this function:

For <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call rs232-v2-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call rs232-v2-bricklet <uid> get-chip-temperature¶

Output:	temperature – Type: Int, 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.

tinkerforge call rs232-v2-bricklet <uid> reset¶

Output:	no output

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!

tinkerforge call rs232-v2-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – 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. 

Callback Configuration Functions¶

tinkerforge call rs232-v2-bricklet <uid> enable-read-callback¶

Output:	no output

Enables the read callback. This will disable the frame-readable callback.

By default the callback is disabled.

tinkerforge call rs232-v2-bricklet <uid> disable-read-callback¶

Output:	no output

Disables the read callback.

By default the callback is disabled.

tinkerforge call rs232-v2-bricklet <uid> is-read-callback-enabled¶

Output:	enabled – Type: Bool, Default: false

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

tinkerforge call rs232-v2-bricklet <uid> set-frame-readable-callback-configuration <frame-size>¶

Parameters:	<frame-size> – Type: Int, Unit: 1 B, Range: [0 to 9216], Default: 0
Output:	no output

Configures the frame-readable 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 read callback.

By default the callback is disabled.

New in version 2.0.3 (Plugin).

tinkerforge call rs232-v2-bricklet <uid> get-frame-readable-callback-configuration¶

Output:	frame-size – Type: Int, Unit: 1 B, Range: [0 to 9216], Default: 0

Returns the callback configuration as set by set-frame-readable-callback-configuration.

New in version 2.0.3 (Plugin).

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch rs232-v2-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch rs232-v2-bricklet <uid> read

Output:	message – Type: Char Array, Length: variable

This callback is called if new data is available.

To enable this callback, use enable-read-callback.

Note

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

tinkerforge dispatch rs232-v2-bricklet <uid> error-count¶

Output:	error-count-overrun – Type: Int, Range: [0 to 232 - 1] error-count-parity – Type: Int, Range: [0 to 232 - 1]

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

tinkerforge dispatch rs232-v2-bricklet <uid> frame-readable¶

Output:	frame-count – Type: Int, Range: [0 to 216 - 1]

This callback is called if at least one frame of data is readable. The frame size is configured with set-frame-readable-callback-configuration. 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).

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.

tinkerforge call rs232-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

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 symbols are available for this function:

For <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call rs232-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call rs232-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

Sets the firmware pointer for write-firmware. 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.

tinkerforge call rs232-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer 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.

tinkerforge call rs232-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

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.

tinkerforge call rs232-v2-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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