Note
This Bricklet is currently in the prototype stage and the software/hardware as well as the documentation is in an incomplete state.
This is the description of the Shell API bindings for the RS232 Bricklet. General information and technical specifications for the RS232 Bricklet are summarized in its hardware description.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the RS232 Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the RS232 Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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 send and errors are silently ignored, because they cannot be detected.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Parameters: |
|
---|---|
Output: |
|
Writes a string of up to 60 characters to the RS232 interface. The string can be binary data, ASCII or similar is not necessary.
The length of the string has to be given as an additional parameter.
The return value is the number of bytes that could be written.
See SetConfigurations() for configuration possibilities regarding baudrate, parity and so on.
Output: |
|
---|
Returns the currently buffered message. The maximum length of message is 60. If the length is given as 0, there was no new data available.
Instead of polling with this function, you can also use callbacks. See enable-callback and read-callback.
Parameters: |
|
---|---|
Output: | no output |
Sets the configuration for the RS232 communication. Available options:
The default is: 115200 baud, parity none, 1 stop bit, word length 8, hard-/software flow control off.
The following symbols are available for this function:
Output: |
|
---|
Returns the configuration as set by set-configuration.
The following symbols are available for this function:
Output: |
|
---|
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.
Output: | no output |
---|
Enables the read-callback.
By default the callback is disabled.
Output: | no output |
---|
Disables the read-callback.
By default the callback is disabled.
Output: |
|
---|
Returns true if the read-callback is enabled, false otherwise.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch rs232-bricklet <uid> example
The available callbacks 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.
Output: |
|
---|
This callback is called if new data is available. The message has a maximum size of 60 characters. The actual length of the message is given in addition.
To enable this callback, use enable-callback.