Software / API Bindings / PHP / API Reference and Examples / Bricklets / RS232 Bricklet 2.0

PHP - RS232 Bricklet 2.0¶

This is the description of the PHP 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 PHP API bindings is part of their general description.

Examples¶

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

Loopback¶

Download (ExampleLoopback.php)

<?php

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

require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletRS232V2.php');

use Tinkerforge\IPConnection;
use Tinkerforge\BrickletRS232V2;

const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your RS232 Bricklet 2.0

// Callback function for read callback
function cb_read($message)
{
    // Assume that the message consists of ASCII characters and convert it
    // from an array of chars to a string
    echo "Message: \"" . implode($message) . "\"\n";
}

$ipcon = new IPConnection(); // Create IP connection
$rs232 = new BrickletRS232V2(UID, $ipcon); // Create device object

$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected

// Register read callback to function cb_read
$rs232->registerCallback(BrickletRS232V2::CALLBACK_READ, 'cb_read');

// Enable read callback
$rs232->enableReadCallback();

// Write "test" string
$rs232->write(str_split('test'));

echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever

?>

API¶

Functions that return multiple values return them in an associative array.

Basic Functions¶

class BrickletRS232V2(string $uid, IPConnection $ipcon)¶

Parameters:	$uid – Type: string $ipcon – Type: IPConnection
Returns:	$rs232_v2 – Type: BrickletRS232V2

Creates an object with the unique device ID $uid:

<?php   $rs232_v2 = new BrickletRS232V2('YOUR_DEVICE_UID', $ipcon);   ?>

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

int BrickletRS232V2::write(array $message)¶

Parameters:	$message – Type: array(string, ...), Length: variable
Returns:	$message_written – Type: int, Range: [0 to 2¹⁶ - 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.

array BrickletRS232V2::read(int $length)¶

Parameters:	$length – Type: int, Range: [0 to 2¹⁶ - 1]
Returns:	$message – Type: array(string, ...), 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 enableReadCallback() and CALLBACK_READ callback.

void BrickletRS232V2::setConfiguration(int $baudrate, int $parity, int $stopbits, int $wordlength, int $flowcontrol)¶

Parameters:	$baudrate – Type: int, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200 $parity – Type: int, Range: See constants, Default: 0 $stopbits – Type: int, Range: See constants, Default: 1 $wordlength – Type: int, Range: See constants, Default: 8 $flowcontrol – Type: int, Range: See constants, Default: 0

Sets the configuration for the RS232 communication.

The following constants are available for this function:

For $parity:

BrickletRS232V2::PARITY_NONE = 0
BrickletRS232V2::PARITY_ODD = 1
BrickletRS232V2::PARITY_EVEN = 2

For $stopbits:

BrickletRS232V2::STOPBITS_1 = 1
BrickletRS232V2::STOPBITS_2 = 2

For $wordlength:

BrickletRS232V2::WORDLENGTH_5 = 5
BrickletRS232V2::WORDLENGTH_6 = 6
BrickletRS232V2::WORDLENGTH_7 = 7
BrickletRS232V2::WORDLENGTH_8 = 8

For $flowcontrol:

BrickletRS232V2::FLOWCONTROL_OFF = 0
BrickletRS232V2::FLOWCONTROL_SOFTWARE = 1
BrickletRS232V2::FLOWCONTROL_HARDWARE = 2

array BrickletRS232V2::getConfiguration()¶

Return Array:	'baudrate' – Type: int, Unit: 1 Bd, Range: [100 to 2000000], Default: 115200 'parity' – Type: int, Range: See constants, Default: 0 'stopbits' – Type: int, Range: See constants, Default: 1 'wordlength' – Type: int, Range: See constants, Default: 8 'flowcontrol' – Type: int, Range: See constants, Default: 0

Returns the configuration as set by setConfiguration().

The following constants are available for this function:

For $parity:

BrickletRS232V2::PARITY_NONE = 0
BrickletRS232V2::PARITY_ODD = 1
BrickletRS232V2::PARITY_EVEN = 2

For $stopbits:

BrickletRS232V2::STOPBITS_1 = 1
BrickletRS232V2::STOPBITS_2 = 2

For $wordlength:

BrickletRS232V2::WORDLENGTH_5 = 5
BrickletRS232V2::WORDLENGTH_6 = 6
BrickletRS232V2::WORDLENGTH_7 = 7
BrickletRS232V2::WORDLENGTH_8 = 8

For $flowcontrol:

BrickletRS232V2::FLOWCONTROL_OFF = 0
BrickletRS232V2::FLOWCONTROL_SOFTWARE = 1
BrickletRS232V2::FLOWCONTROL_HARDWARE = 2

Advanced Functions¶

void BrickletRS232V2::setBufferConfig(int $send_buffer_size, int $receive_buffer_size)¶

Parameters:	$send_buffer_size – Type: int, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120 $receive_buffer_size – Type: int, Unit: 1 B, Range: [2¹⁰ 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 CALLBACK_READ callback.

array BrickletRS232V2::getBufferConfig()¶

Return Array:	'send_buffer_size' – Type: int, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120 'receive_buffer_size' – Type: int, Unit: 1 B, Range: [2¹⁰ to 9216], Default: 5120

Returns the buffer configuration as set by setBufferConfig().

array BrickletRS232V2::getBufferStatus()¶

Return Array:	'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 setBufferConfig() for buffer size configuration.

array BrickletRS232V2::getErrorCount()¶

Return Array:	'error_count_overrun' – Type: int, Range: [0 to 2³² - 1] 'error_count_parity' – Type: int, Range: [0 to 2³² - 1]

Returns the current number of overrun and parity errors.

array BrickletRS232V2::getSPITFPErrorCount()¶

Return Array:	'error_count_ack_checksum' – Type: int, Range: [0 to 2³² - 1] 'error_count_message_checksum' – Type: int, Range: [0 to 2³² - 1] 'error_count_frame' – Type: int, Range: [0 to 2³² - 1] 'error_count_overflow' – Type: int, Range: [0 to 2³² - 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.

void BrickletRS232V2::setStatusLEDConfig(int $config)¶

Parameters:	$config – Type: int, 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::STATUS_LED_CONFIG_OFF = 0
BrickletRS232V2::STATUS_LED_CONFIG_ON = 1
BrickletRS232V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRS232V2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletRS232V2::getStatusLEDConfig()¶

Returns:	$config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For $config:

BrickletRS232V2::STATUS_LED_CONFIG_OFF = 0
BrickletRS232V2::STATUS_LED_CONFIG_ON = 1
BrickletRS232V2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletRS232V2::STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletRS232V2::getChipTemperature()¶

Returns:	$temperature – Type: int, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

void BrickletRS232V2::reset()¶

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!

array BrickletRS232V2::getIdentity()¶

Return Array:

Return Array:	'uid' – Type: string, Length: up to 8 'connected_uid' – Type: string, Length: up to 8 'position' – Type: string, Range: ['a' to 'h', 'z'] 'hardware_version' – Type: array(int, ...), 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: array(int, ...), 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 2¹⁶ - 1]

'uid' – Type: string, Length: up to 8
'connected_uid' – Type: string, Length: up to 8
'position' – Type: string, Range: ['a' to 'h', 'z']
'hardware_version' – Type: array(int, ...), 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: array(int, ...), 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 2¹⁶ - 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¶

void BrickletRS232V2::registerCallback(int $callback_id, callable $callback, mixed $user_data=NULL)¶

Parameters:	$callback_id – Type: int $callback – Type: callable $user_data – Type: mixed

Registers the given $function with the given $callback_id. The optional $user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

void BrickletRS232V2::enableReadCallback()¶

Enables the CALLBACK_READ callback. This will disable the CALLBACK_FRAME_READABLE callback.

By default the callback is disabled.

void BrickletRS232V2::disableReadCallback()¶

Disables the CALLBACK_READ callback.

By default the callback is disabled.

bool BrickletRS232V2::isReadCallbackEnabled()¶

Returns:	$enabled – Type: bool, Default: FALSE

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

void BrickletRS232V2::setFrameReadableCallbackConfiguration(int $frame_size)¶

Parameters:	$frame_size – Type: int, Unit: 1 B, Range: [0 to 9216], Default: 0

Configures the CALLBACK_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 CALLBACK_READ callback.

By default the callback is disabled.

New in version 2.0.3 (Plugin).

int BrickletRS232V2::getFrameReadableCallbackConfiguration()¶

Returns:	$frame_size – Type: int, 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 with the registerCallback() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

<?php

function myCallback($param)
{
    echo $param . "\n";
}

$rs232_v2->registerCallback(BrickletRS232V2::CALLBACK_EXAMPLE, 'myCallback');

?>

The available constants with corresponding function signatures 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.

int BrickletRS232V2::CALLBACK_READ¶

<?php   void callback(array $message [, mixed $user_data])   ?>

Callback Parameters:	$message – Type: array(string, ...), Length: variable $user_data – Type: mixed

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.

int BrickletRS232V2::CALLBACK_ERROR_COUNT¶

<?php   void callback(int $error_count_overrun, int $error_count_parity [, mixed $user_data])   ?>

Callback Parameters:	$error_count_overrun – Type: int, Range: [0 to 2³² - 1] $error_count_parity – Type: int, Range: [0 to 2³² - 1] $user_data – Type: mixed

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

int BrickletRS232V2::CALLBACK_FRAME_READABLE¶

<?php   void callback(int $frame_count [, mixed $user_data])   ?>

Callback Parameters:	$frame_count – Type: int, Range: [0 to 2¹⁶ - 1] $user_data – Type: mixed

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.

array BrickletRS232V2::getAPIVersion()¶

Return Array:	$api_version – Type: array(int, ...), 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]

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.

bool BrickletRS232V2::getResponseExpected(int $function_id)¶

Parameters:	$function_id – Type: int, Range: See constants
Returns:	$response_expected – Type: bool

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 $function_id:

BrickletRS232V2::FUNCTION_ENABLE_READ_CALLBACK = 3
BrickletRS232V2::FUNCTION_DISABLE_READ_CALLBACK = 4
BrickletRS232V2::FUNCTION_SET_CONFIGURATION = 6
BrickletRS232V2::FUNCTION_SET_BUFFER_CONFIG = 8
BrickletRS232V2::FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
BrickletRS232V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRS232V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRS232V2::FUNCTION_RESET = 243
BrickletRS232V2::FUNCTION_WRITE_UID = 248

void BrickletRS232V2::setResponseExpected(int $function_id, bool $response_expected)¶

Parameters:	$function_id – Type: int, Range: See constants $response_expected – Type: bool

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.

The following constants are available for this function:

For $function_id:

BrickletRS232V2::FUNCTION_ENABLE_READ_CALLBACK = 3
BrickletRS232V2::FUNCTION_DISABLE_READ_CALLBACK = 4
BrickletRS232V2::FUNCTION_SET_CONFIGURATION = 6
BrickletRS232V2::FUNCTION_SET_BUFFER_CONFIG = 8
BrickletRS232V2::FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 14
BrickletRS232V2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletRS232V2::FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletRS232V2::FUNCTION_RESET = 243
BrickletRS232V2::FUNCTION_WRITE_UID = 248

void BrickletRS232V2::setResponseExpectedAll(bool $response_expected)¶

Parameters:	$response_expected – Type: bool

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.

int BrickletRS232V2::setBootloaderMode(int $mode)¶

Parameters:	$mode – Type: int, Range: See constants
Returns:	$status – Type: int, 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::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletRS232V2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletRS232V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletRS232V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletRS232V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For $status:

BrickletRS232V2::BOOTLOADER_STATUS_OK = 0
BrickletRS232V2::BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletRS232V2::BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletRS232V2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletRS232V2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletRS232V2::BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletRS232V2::getBootloaderMode()¶

Returns:	$mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For $mode:

BrickletRS232V2::BOOTLOADER_MODE_BOOTLOADER = 0
BrickletRS232V2::BOOTLOADER_MODE_FIRMWARE = 1
BrickletRS232V2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletRS232V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletRS232V2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletRS232V2::setWriteFirmwarePointer(int $pointer)¶

Parameters:	$pointer – Type: int, Unit: 1 B, Range: [0 to 2³² - 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.

int BrickletRS232V2::writeFirmware(array $data)¶

Parameters:	$data – Type: array(int, ...), Length: 64, Range: [0 to 255]
Returns:	$status – Type: int, 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.

void BrickletRS232V2::writeUID(int $uid)¶

Parameters:	$uid – Type: int, Range: [0 to 2³² - 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.

int BrickletRS232V2::readUID()¶

Returns:	$uid – Type: int, Range: [0 to 2³² - 1]

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

Constants¶

int BrickletRS232V2::DEVICE_IDENTIFIER¶

This constant is used to identify a RS232 Bricklet 2.0.

The getIdentity() function and the IPConnection::CALLBACK_ENUMERATE callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

string BrickletRS232V2::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a RS232 Bricklet 2.0.