Tinkerforge::BrickletRS232V2 - Communicates with RS232 devices
This constant is used to identify a RS232 Bricklet 2.0.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a RS232 Bricklet 2.0.
This constant is used with the register_callback() subroutine to specify the CALLBACK_READ_LOW_LEVEL callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ERROR_COUNT callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_READ callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
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 :func:`Set Configuration` for configuration possibilities regarding baud rate, parity and so on.
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 :func:`Enable Read Callback` and :cb:`Read` callback.
Enables the :cb:`Read` callback.
By default the callback is disabled.
Disables the :cb:`Read` callback.
Returns *true* if the :cb:`Read` callback is enabled, *false* otherwise.
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.
Returns the configuration as set by :func:`Set Configuration`.
Sets the send and receive buffer size in byte. In sum there is 10240 byte (10kb) buffer available and the minimum buffer size is 1024 byte (1kb) for both.
The current buffer content is lost if this function is called.
The send buffer holds data that is given by :func:`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 :func:`Read` or through :cb:`Read` callback.
The default configuration is 5120 byte (5kb) per buffer.
Returns the buffer configuration as set by :func:`Set Buffer Config`.
Returns the currently used bytes for the send and received buffer.
See :func:`Set Buffer Config` for buffer size configuration.
Returns the current number of overrun and parity errors.
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
* ack checksum errors, * message checksum errors, * frameing 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.
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 und 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.
Returns the current bootloader mode, see :func:`Set Bootloader Mode`.
Sets the firmware pointer for :func:`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).
Writes 64 Bytes of firmware at the position as written by :func:`Set Write Firmware Pointer` before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
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.
Returns the configuration as set by :func:`Set Status LED Config`
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.
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!
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.
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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 :ref:`here <device_identifier>`. |device_identifier_constant|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.