TCP/IP - RS232 Bricklet 2.0

This is the description of the TCP/IP protocol for the RS232 Bricklet 2.0. General information and technical specifications for the RS232 Bricklet 2.0 are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletRS232V2.write_low_level
Function ID:

1

Request:
  • message_length -- uint16
  • message_chunk_offset -- uint16
  • message_chunk_data -- char[60]
Response:
  • message_chunk_written -- uint8

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.

BrickletRS232V2.read_low_level
Function ID:

2

Request:
  • length -- uint16
Response:
  • message_length -- uint16
  • message_chunk_offset -- uint16
  • message_chunk_data -- char[60]

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

BrickletRS232V2.set_configuration
Function ID:

6

Request:
  • baudrate -- uint32
  • parity -- uint8
  • stopbits -- uint8
  • wordlength -- uint8
  • flowcontrol -- uint8
Response:

no response

Sets the configuration for the RS232 communication. Available options:

  • Baud rate between 100 and 2000000 baud.
  • Parity of none, odd or even.
  • Stop bits can be 1 or 2.
  • Word length of 5 to 8.
  • Flow control can be off, software or hardware.

The default is: 115200 baud, parity none, 1 stop bit, word length 8.

The following meanings are defined for the parameters of this function:

  • 0: none, for parity
  • 1: odd, for parity
  • 2: even, for parity
  • 1: 1, for stopbits
  • 2: 2, for stopbits
  • 5: 5, for wordlength
  • 6: 6, for wordlength
  • 7: 7, for wordlength
  • 8: 8, for wordlength
  • 0: off, for flowcontrol
  • 1: software, for flowcontrol
  • 2: hardware, for flowcontrol
BrickletRS232V2.get_configuration
Function ID:

7

Request:

empty payload

Response:
  • baudrate -- uint32
  • parity -- uint8
  • stopbits -- uint8
  • wordlength -- uint8
  • flowcontrol -- uint8

Returns the configuration as set by set_configuration.

The following meanings are defined for the parameters of this function:

  • 0: none, for parity
  • 1: odd, for parity
  • 2: even, for parity
  • 1: 1, for stopbits
  • 2: 2, for stopbits
  • 5: 5, for wordlength
  • 6: 6, for wordlength
  • 7: 7, for wordlength
  • 8: 8, for wordlength
  • 0: off, for flowcontrol
  • 1: software, for flowcontrol
  • 2: hardware, for flowcontrol

Advanced Functions

BrickletRS232V2.set_buffer_config
Function ID:

8

Request:
  • send_buffer_size -- uint16
  • receive_buffer_size -- uint16
Response:

no response

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

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

The send buffer holds data that is given by write_low_level 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_low_level or through CALLBACK_READ_LOW_LEVEL callback.

The default configuration is 5120 byte (5kb) per buffer.

BrickletRS232V2.get_buffer_config
Function ID:

9

Request:

empty payload

Response:
  • send_buffer_size -- uint16
  • receive_buffer_size -- uint16

Returns the buffer configuration as set by set_buffer_config.

BrickletRS232V2.get_buffer_status
Function ID:

10

Request:

empty payload

Response:
  • send_buffer_used -- uint16
  • receive_buffer_used -- uint16

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

See set_buffer_config for buffer size configuration.

BrickletRS232V2.get_error_count
Function ID:

11

Request:

empty payload

Response:
  • error_count_overrun -- uint32
  • error_count_parity -- uint32

Returns the current number of overrun and parity errors.

BrickletRS232V2.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

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 meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletRS232V2.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletRS232V2.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

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.

BrickletRS232V2.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

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.

BrickletRS232V2.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
Response:

no response

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 meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletRS232V2.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletRS232V2.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

Returns the temperature in °C 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
Function ID:243
Request:empty payload
Response:no response

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.write_uid
Function ID:

248

Request:
  • uid -- uint32
Response:

no response

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.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

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

BrickletRS232V2.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

Callback Configuration Functions

BrickletRS232V2.enable_read_callback
Function ID:3
Request:empty payload
Response:no response

Enables the CALLBACK_READ_LOW_LEVEL callback.

By default the callback is disabled.

BrickletRS232V2.disable_read_callback
Function ID:4
Request:empty payload
Response:no response

Disables the CALLBACK_READ_LOW_LEVEL callback.

By default the callback is disabled.

BrickletRS232V2.is_read_callback_enabled
Function ID:

5

Request:

empty payload

Response:
  • enabled -- bool

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

Callbacks

BrickletRS232V2.CALLBACK_READ_LOW_LEVEL
Function ID:

12

Response:
  • message_length -- uint16
  • message_chunk_offset -- uint16
  • message_chunk_data -- char[60]

This callback is called if new data is available.

To enable this callback, use enable_read_callback.

BrickletRS232V2.CALLBACK_ERROR_COUNT
Function ID:

13

Response:
  • error_count_overrun -- uint32
  • error_count_parity -- uint32

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