Software / API Bindings / Shell / API Reference and Examples / Bricks / RED Brick

Shell - RED Brick¶

This is the description of the Shell API bindings for the RED Brick. General information and technical specifications for the RED Brick are summarized in its hardware description.

An installation guide for the Shell API bindings is part of their general description.

API¶

Possible exit codes for all tinkerforge commands are:

1: interrupted (ctrl+c)
2: syntax error
21: Python 2.5 or newer is required
22: Python argparse module is missing
23: socket error
24: other exception
25: invalid placeholder in format string
26: authentication error
201: timeout occurred
209: invalid argument value
210: function is not supported
211: unknown error

Note

The API documentation for the RED Brick is currently incomplete.

The RED Brick API is meant to be used by the Brick Viewer to implement the offered functionality (getting status information, managing programs etc.). Normal users will not need to use this API, it may only be interesting for power users.

FIXME: explain sessions

The RED Brick API operates on reference counted objects (strings, lists, files, directories, processes and programs) that are identified by their 16bit object ID. Functions that allocate or return an object ID (e.g. allocate-string and get-next-directory-entry) increase the reference count of the returned object. If the object is no longer needed then release-object has to be called to decrease the reference count of the object again. In contrast to allocation and getter functions, the reference count for an object returned by a callback is not increased and release-object must not be called for such an object in response to a callback.

There are functions (e.g. get-file-info) that only return valid objects under certain conditions. This conditions are documented for the specific functions. For invalid objects release-object must not be called.

There are also function (e.g. set-program-stdio-redirection) that have conditionally unused object parameters. Under which conditions an object parameter is unused is documented for the specific functions. For unused object parameters 0 has to be passed as object ID.

The RED Brick API is more complex then the typical Brick API and requires more elaborate error reporting than the TCP/IP protocol can provide with its 2bit error code. Therefore, almost all functions of the RED Brick API return an 8bit error code. Possible error codes are:

Success = 0
UnknownError = 1
InvalidOperation = 2
OperationAborted = 3
InternalError = 4
UnknownSessionID = 5
NoFreeSessionID = 6
UnknownObjectID = 7
NoFreeObjectID = 8
ObjectIsLocked = 9
NoMoreData = 10
WrongListItemType = 11
ProgramIsPurged = 12
InvalidParameter = 128 (EINVAL)
NoFreeMemory = 129 (ENOMEM)
NoFreeSpace = 130 (ENOSPC)
AccessDenied = 131 (EACCES)
AlreadyExists = 132 (EEXIST)
DoesNotExist = 133 (ENOENT)
Interrupted = 134 (EINTR)
IsDirectory = 135 (EISDIR)
NotADirectory = 136 (ENOTDIR)
WouldBlock = 137 (EWOULDBLOCK)
Overflow = 138 (EOVERFLOW)
BadFileDescriptor = 139 (EBADF)
OutOfRange = 140 (ERANGE)
NameTooLong = 141 (ENAMETOOLONG)
InvalidSeek = 142 (ESPIPE)
NotSupported = 143 (ENOTSUP)
TooManyOpenFiles = 144 (EMFILE)

If a function returns an error code other than Success then its other return values (if any) are invalid and must not be used.

The error code InvalidOperation is returned if the requested operation cannot be performed because the current state of the object does not allow it. For example, trying to append an item to a full list object or trying to undefine an already undefined program.

The error code NotSupported is returned if the requested operation can never be performed. For example, trying to append a list object to itself, trying to get the name of a file object with type Pipe or trying to create a directory non-recursively with more than the last part of the directory name referring to non-existing directories.

String objects store UTF-8 encoded data.

Command Structure¶

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

tinkerforge call red-brick [<option>..] <uid> <function> [<argument>..]¶

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

The call command is used to call a function of the RED Brick. 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 RED Brick and exits

tinkerforge dispatch red-brick [<option>..] <uid> <callback>¶

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

The dispatch command is used to dispatch a callback of the RED Brick. 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 RED Brick and exits

tinkerforge call red-brick <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 red-brick <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)

Advanced Functions¶

tinkerforge call red-brick <uid> create-session <lifetime>¶

Parameters:	<lifetime> – Type: Int, Range: [0 to 2³² - 1]
Output:	error-code – Type: Int, Range: See symbols session-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> expire-session <session-id>¶

Parameters:	<session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> expire-session-unchecked <session-id>¶

Parameters:	<session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	no output

tinkerforge call red-brick <uid> keep-session-alive <session-id> <lifetime>¶

Parameters:	<session-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <lifetime> – Type: Int, Range: [0 to 2³² - 1]
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> release-object <object-id> <session-id>¶

Parameters:	<object-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

Decreases the reference count of an object by one and returns the resulting error code. If the reference count reaches zero the object gets destroyed.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> release-object-unchecked <object-id> <session-id>¶

Parameters:	<object-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	no output

tinkerforge call red-brick <uid> allocate-string <length-to-reserve> <buffer> <session-id>¶

Parameters:	<length-to-reserve> – Type: Int, Unit: 1 B, Range: [0 to 2³² - 1] <buffer> – Type: String, Length: up to 58 <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

Allocates a new string object, reserves length_to_reserve bytes memory for it and sets up to the first 60 bytes. Set length_to_reserve to the length of the string that should be stored in the string object.

Returns the object ID of the new string object and the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> truncate-string <string-id> <length>¶

Parameters:	<string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <length> – Type: Int, Unit: 1 B, Range: [0 to 2³² - 1]
Output:	error-code – Type: Int, Range: See symbols

Truncates a string object to length bytes and returns the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-string-length <string-id>¶

Parameters:	<string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols length – Type: Int, Unit: 1 B, Range: [0 to 2³² - 1]

Returns the length of a string object and the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> set-string-chunk <string-id> <offset> <buffer>¶

Parameters:	<string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <offset> – Type: Int, Unit: 1 B, Range: [0 to 2³² - 1] <buffer> – Type: String, Length: up to 58
Output:	error-code – Type: Int, Range: See symbols

Sets a chunk of up to 58 bytes in a string object beginning at offset.

Returns the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-string-chunk <string-id> <offset>¶

Parameters:	<string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <offset> – Type: Int, Unit: 1 B, Range: [0 to 2³² - 1]
Output:	error-code – Type: Int, Range: See symbols buffer – Type: String, Length: up to 63

Returns a chunk up to 63 bytes from a string object beginning at offset and returns the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> allocate-list <length-to-reserve> <session-id>¶

Parameters:	<length-to-reserve> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols list-id – Type: Int, Range: [0 to 2¹⁶ - 1]

Allocates a new list object and reserves memory for length_to_reserve items. Set length_to_reserve to the number of items that should be stored in the list object.

Returns the object ID of the new list object and the resulting error code.

When a list object gets destroyed then the reference count of each object in the list object is decreased by one.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-list-length <list-id>¶

Parameters:	<list-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols length – Type: Int, Range: [0 to 2¹⁶ - 1]

Returns the length of a list object in items and the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-list-item <list-id> <index> <session-id>¶

Parameters:	<list-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <index> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols item-object-id – Type: Int, Range: [0 to 2¹⁶ - 1] type – Type: Int, Range: See symbols

Returns the object ID and type of the object stored at index in a list object and returns the resulting error code.

Possible object types are:

String = 0
List = 1
File = 2
Directory = 3
Process = 4
Program = 5

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

For type:

object-type-string = 0
object-type-list = 1
object-type-file = 2
object-type-directory = 3
object-type-process = 4
object-type-program = 5

tinkerforge call red-brick <uid> append-to-list <list-id> <item-object-id>¶

Parameters:	<list-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <item-object-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

Appends an object to a list object and increases the reference count of the appended object by one.

Returns the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> remove-from-list <list-id> <index>¶

Parameters:	<list-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <index> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

Removes the object stored at index from a list object and decreases the reference count of the removed object by one.

Returns the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> open-file <name-string-id> <flags> <permissions> <uid> <gid> <session-id>¶

Parameters:	<name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <flags> – Type: Int, Range: See symbols <permissions> – Type: Int, Range: See symbols <uid> – Type: Int, Range: [0 to 2³² - 1] <gid> – Type: Int, Range: [0 to 2³² - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols file-id – Type: Int, Range: [0 to 2¹⁶ - 1]

Opens an existing file or creates a new file and allocates a new file object for it.

FIXME: name has to be absolute

The reference count of the name string object is increased by one. When the file object gets destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the file object holds a reference to it.

The flags parameter takes a ORed combination of the following possible file flags (in hexadecimal notation):

ReadOnly = 0x0001 (O_RDONLY)
WriteOnly = 0x0002 (O_WRONLY)
ReadWrite = 0x0004 (O_RDWR)
Append = 0x0008 (O_APPEND)
Create = 0x0010 (O_CREAT)
Exclusive = 0x0020 (O_EXCL)
NonBlocking = 0x0040 (O_NONBLOCK)
Truncate = 0x0080 (O_TRUNC)
Temporary = 0x0100
Replace = 0x0200

FIXME: explain Temporary and Replace flag

The permissions parameter takes a ORed combination of the following possible file permissions (in octal notation) that match the common UNIX permission bits:

UserRead = 00400
UserWrite = 00200
UserExecute = 00100
GroupRead = 00040
GroupWrite = 00020
GroupExecute = 00010
OthersRead = 00004
OthersWrite = 00002
OthersExecute = 00001

Returns the object ID of the new file object and the resulting error code.

The following symbols are available for this function:

For <flags>:

file-flag-read-only = 1
file-flag-write-only = 2
file-flag-read-write = 4
file-flag-append = 8
file-flag-create = 16
file-flag-exclusive = 32
file-flag-non-blocking = 64
file-flag-truncate = 128
file-flag-temporary = 256
file-flag-replace = 512

For <permissions>:

file-permission-user-all = 448
file-permission-user-read = 256
file-permission-user-write = 128
file-permission-user-execute = 64
file-permission-group-all = 56
file-permission-group-read = 32
file-permission-group-write = 16
file-permission-group-execute = 8
file-permission-others-all = 7
file-permission-others-read = 4
file-permission-others-write = 2
file-permission-others-execute = 1

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> create-pipe <flags> <length> <session-id>¶

Parameters:	<flags> – Type: Int, Range: See symbols <length> – Type: Int, Unit: 1 B, Range: [0 to 2⁶⁴ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols file-id – Type: Int, Range: [0 to 2¹⁶ - 1]

Creates a new pipe and allocates a new file object for it.

The flags parameter takes a ORed combination of the following possible pipe flags (in hexadecimal notation):

NonBlockingRead = 0x0001
NonBlockingWrite = 0x0002

The length of the pipe buffer can be specified with the length parameter in bytes. If length is set to zero, then the default pipe buffer length is used.

Returns the object ID of the new file object and the resulting error code.

The following symbols are available for this function:

For <flags>:

pipe-flag-non-blocking-read = 1
pipe-flag-non-blocking-write = 2

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-file-info <file-id> <session-id>¶

Parameters:

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols type – Type: Int, Range: See symbols name-string-id – Type: Int, Range: [0 to 2¹⁶ - 1] flags – Type: Int, Range: See symbols permissions – Type: Int, Range: See symbols uid – Type: Int, Range: [0 to 2³² - 1] gid – Type: Int, Range: [0 to 2³² - 1] length – Type: Int, Unit: 1 B, Range: [0 to 2⁶⁴ - 1] access-timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1] modification-timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1] status-change-timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1]

<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]

Output:

error-code – Type: Int, Range: See symbols
type – Type: Int, Range: See symbols
name-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]
flags – Type: Int, Range: See symbols
permissions – Type: Int, Range: See symbols
uid – Type: Int, Range: [0 to 2³² - 1]
gid – Type: Int, Range: [0 to 2³² - 1]
length – Type: Int, Unit: 1 B, Range: [0 to 2⁶⁴ - 1]
access-timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1]
modification-timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1]
status-change-timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1]

Returns various information about a file and the resulting error code.

Possible file types are:

Unknown = 0
Regular = 1
Directory = 2
Character = 3
Block = 4
FIFO = 5
Symlink = 6
Socket = 7
Pipe = 8

If the file type is Pipe then the returned name string object is invalid, because a pipe has no name. Otherwise the returned name string object was used to open or create the file object, as passed to open-file.

The returned flags were used to open or create the file object, as passed to open-file or create-pipe. See the respective function for a list of possible file and pipe flags.

FIXME: everything except flags and length is invalid if file type is Pipe

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

For type:

file-type-unknown = 0
file-type-regular = 1
file-type-directory = 2
file-type-character = 3
file-type-block = 4
file-type-fifo = 5
file-type-symlink = 6
file-type-socket = 7
file-type-pipe = 8

For flags:

file-flag-read-only = 1
file-flag-write-only = 2
file-flag-read-write = 4
file-flag-append = 8
file-flag-create = 16
file-flag-exclusive = 32
file-flag-non-blocking = 64
file-flag-truncate = 128
file-flag-temporary = 256
file-flag-replace = 512

For permissions:

file-permission-user-all = 448
file-permission-user-read = 256
file-permission-user-write = 128
file-permission-user-execute = 64
file-permission-group-all = 56
file-permission-group-read = 32
file-permission-group-write = 16
file-permission-group-execute = 8
file-permission-others-all = 7
file-permission-others-read = 4
file-permission-others-write = 2
file-permission-others-execute = 1

tinkerforge call red-brick <uid> read-file <file-id> <length-to-read>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <length-to-read> – Type: Int, Unit: 1 B, Range: [0 to 255]
Output:	error-code – Type: Int, Range: See symbols buffer – Type: Int Array, Length: 62, Range: [0 to 255] length-read – Type: Int, Unit: 1 B, Range: [0 to 255]

Reads up to 62 bytes from a file object.

Returns the bytes read, the actual number of bytes read and the resulting error code.

If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are returned.

If the file object was created by open-file without the NonBlocking flag or by create-pipe without the NonBlockingRead flag then the error code NotSupported is returned.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> read-file-async <file-id> <length-to-read>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <length-to-read> – Type: Int, Unit: 1 B, Range: [0 to 2⁶⁴ - 1]
Output:	no output

Reads up to 2⁶³ - 1 bytes from a file object asynchronously.

Reports the bytes read (in 60 byte chunks), the actual number of bytes read and the resulting error code via the async-file-read callback.

If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are reported.

If the file object was created by open-file without the NonBlocking flag or by create-pipe without the NonBlockingRead flag then the error code NotSupported is reported via the async-file-read callback.

tinkerforge call red-brick <uid> abort-async-file-read <file-id>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

Aborts a read-file-async operation in progress.

Returns the resulting error code.

On success the async-file-read callback will report OperationAborted.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> write-file <file-id> <buffer> <length-to-write>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <buffer> – Type: Int Array, Length: 61, Range: [0 to 255] <length-to-write> – Type: Int, Unit: 1 B, Range: [0 to 255]
Output:	error-code – Type: Int, Range: See symbols length-written – Type: Int, Unit: 1 B, Range: [0 to 255]

Writes up to 61 bytes to a file object.

Returns the actual number of bytes written and the resulting error code.

If the file object was created by open-file without the NonBlocking flag or by create-pipe without the NonBlockingWrite flag then the error code NotSupported is returned.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> write-file-unchecked <file-id> <buffer> <length-to-write>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <buffer> – Type: Int Array, Length: 61, Range: [0 to 255] <length-to-write> – Type: Int, Unit: 1 B, Range: [0 to 255]
Output:	no output

Writes up to 61 bytes to a file object.

Does neither report the actual number of bytes written nor the resulting error code.

If the file object was created by open-file without the NonBlocking flag or by create-pipe without the NonBlockingWrite flag then the write operation will fail silently.

tinkerforge call red-brick <uid> write-file-async <file-id> <buffer> <length-to-write>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <buffer> – Type: Int Array, Length: 61, Range: [0 to 255] <length-to-write> – Type: Int, Unit: 1 B, Range: [0 to 255]
Output:	no output

Writes up to 61 bytes to a file object.

Reports the actual number of bytes written and the resulting error code via the async-file-write callback.

If the file object was created by open-file without the NonBlocking flag or by create-pipe without the NonBlockingWrite flag then the error code NotSupported is reported via the async-file-write callback.

tinkerforge call red-brick <uid> set-file-position <file-id> <offset> <origin>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <offset> – Type: Int, Unit: 1 B, Range: [-2⁶³ to 2⁶³ - 1] <origin> – Type: Int, Range: See symbols
Output:	error-code – Type: Int, Range: See symbols position – Type: Int, Unit: 1 B, Range: [0 to 2⁶⁴ - 1]

Set the current seek position of a file object relative to origin.

Possible file origins are:

Beginning = 0
Current = 1
End = 2

Returns the resulting absolute seek position and error code.

If the file object was created by create-pipe then it has no seek position and the error code InvalidSeek is returned.

The following symbols are available for this function:

For <origin>:

file-origin-beginning = 0
file-origin-current = 1
file-origin-end = 2

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-file-position <file-id>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols position – Type: Int, Unit: 1 B, Range: [0 to 2⁶⁴ - 1]

Returns the current seek position of a file object and returns the resulting error code.

If the file object was created by create-pipe then it has no seek position and the error code InvalidSeek is returned.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> set-file-events <file-id> <events>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <events> – Type: Int, Range: See symbols
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For <events>:

file-event-readable = 1
file-event-writable = 2

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-file-events <file-id>¶

Parameters:	<file-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols events – Type: Int, Range: See symbols

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

For events:

file-event-readable = 1
file-event-writable = 2

tinkerforge call red-brick <uid> open-directory <name-string-id> <session-id>¶

Parameters:	<name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols directory-id – Type: Int, Range: [0 to 2¹⁶ - 1]

Opens an existing directory and allocates a new directory object for it.

FIXME: name has to be absolute

The reference count of the name string object is increased by one. When the directory object is destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the directory object holds a reference to it.

Returns the object ID of the new directory object and the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-directory-name <directory-id> <session-id>¶

Parameters:	<directory-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols name-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

Returns the name of a directory object, as passed to open-directory, and the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-next-directory-entry <directory-id> <session-id>¶

Parameters:	<directory-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols name-string-id – Type: Int, Range: [0 to 2¹⁶ - 1] type – Type: Int, Range: See symbols

Returns the next entry in a directory object and the resulting error code.

If there is not next entry then error code NoMoreData is returned. To rewind a directory object call rewind-directory.

Possible directory entry types are:

Unknown = 0
Regular = 1
Directory = 2
Character = 3
Block = 4
FIFO = 5
Symlink = 6
Socket = 7

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

For type:

directory-entry-type-unknown = 0
directory-entry-type-regular = 1
directory-entry-type-directory = 2
directory-entry-type-character = 3
directory-entry-type-block = 4
directory-entry-type-fifo = 5
directory-entry-type-symlink = 6
directory-entry-type-socket = 7

tinkerforge call red-brick <uid> rewind-directory <directory-id>¶

Parameters:	<directory-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

Rewinds a directory object and returns the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> create-directory <name-string-id> <flags> <permissions> <uid> <gid>¶

Parameters:	<name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <flags> – Type: Int, Range: See symbols <permissions> – Type: Int, Range: See symbols <uid> – Type: Int, Range: [0 to 2³² - 1] <gid> – Type: Int, Range: [0 to 2³² - 1]
Output:	error-code – Type: Int, Range: See symbols

FIXME: name has to be absolute

The following symbols are available for this function:

For <flags>:

directory-flag-recursive = 1
directory-flag-exclusive = 2

For <permissions>:

file-permission-user-all = 448
file-permission-user-read = 256
file-permission-user-write = 128
file-permission-user-execute = 64
file-permission-group-all = 56
file-permission-group-read = 32
file-permission-group-write = 16
file-permission-group-execute = 8
file-permission-others-all = 7
file-permission-others-read = 4
file-permission-others-write = 2
file-permission-others-execute = 1

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-processes <session-id>¶

Parameters:	<session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols processes-list-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> spawn-process <executable-string-id> <arguments-list-id> <environment-list-id> <working-directory-string-id> <uid> <gid> <stdin-file-id> <stdout-file-id> <stderr-file-id> <session-id>¶

Parameters:

Parameters:	<executable-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <arguments-list-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <environment-list-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <working-directory-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <uid> – Type: Int, Range: [0 to 2³² - 1] <gid> – Type: Int, Range: [0 to 2³² - 1] <stdin-file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <stdout-file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <stderr-file-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols process-id – Type: Int, Range: [0 to 2¹⁶ - 1]

<executable-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<arguments-list-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<environment-list-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<working-directory-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<uid> – Type: Int, Range: [0 to 2³² - 1]
<gid> – Type: Int, Range: [0 to 2³² - 1]
<stdin-file-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<stdout-file-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<stderr-file-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]

Output:

error-code – Type: Int, Range: See symbols
process-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> kill-process <process-id> <signal>¶

Parameters:	<process-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <signal> – Type: Int, Range: See symbols
Output:	error-code – Type: Int, Range: See symbols

Sends a UNIX signal to a process object and returns the resulting error code.

Possible UNIX signals are:

Interrupt = 2
Quit = 3
Abort = 6
Kill = 9
User1 = 10
User2 = 12
Terminate = 15
Continue = 18
Stop = 19

The following symbols are available for this function:

For <signal>:

process-signal-interrupt = 2
process-signal-quit = 3
process-signal-abort = 6
process-signal-kill = 9
process-signal-user1 = 10
process-signal-user2 = 12
process-signal-terminate = 15
process-signal-continue = 18
process-signal-stop = 19

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-process-command <process-id> <session-id>¶

Parameters:	<process-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols executable-string-id – Type: Int, Range: [0 to 2¹⁶ - 1] arguments-list-id – Type: Int, Range: [0 to 2¹⁶ - 1] environment-list-id – Type: Int, Range: [0 to 2¹⁶ - 1] working-directory-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

Returns the executable, arguments, environment and working directory used to spawn a process object, as passed to spawn-process, and the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-process-identity <process-id>¶

Parameters:	<process-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols pid – Type: Int, Range: [0 to 2³² - 1] uid – Type: Int, Range: [0 to 2³² - 1] gid – Type: Int, Range: [0 to 2³² - 1]

Returns the process ID and the user and group ID used to spawn a process object, as passed to spawn-process, and the resulting error code.

The process ID is only valid if the state is Running or Stopped, see get-process-state.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-process-stdio <process-id> <session-id>¶

Parameters:	<process-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols stdin-file-id – Type: Int, Range: [0 to 2¹⁶ - 1] stdout-file-id – Type: Int, Range: [0 to 2¹⁶ - 1] stderr-file-id – Type: Int, Range: [0 to 2¹⁶ - 1]

Returns the stdin, stdout and stderr files used to spawn a process object, as passed to spawn-process, and the resulting error code.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-process-state <process-id>¶

Parameters:	<process-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols state – Type: Int, Range: See symbols timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1] exit-code – Type: Int, Range: [0 to 255]

Returns the current state, timestamp and exit code of a process object, and the resulting error code.

Possible process states are:

Unknown = 0
Running = 1
Error = 2
Exited = 3
Killed = 4
Stopped = 5

The timestamp represents the UNIX time since when the process is in its current state.

The exit code is only valid if the state is Error, Exited, Killed or Stopped and has different meanings depending on the state:

Error: error code for error occurred while spawning the process (see below)
Exited: exit status of the process
Killed: UNIX signal number used to kill the process
Stopped: UNIX signal number used to stop the process

Possible exit/error codes in Error state are:

InternalError = 125
CannotExecute = 126
DoesNotExist = 127

The CannotExecute error can be caused by the executable being opened for writing.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

For state:

process-state-unknown = 0
process-state-running = 1
process-state-error = 2
process-state-exited = 3
process-state-killed = 4
process-state-stopped = 5

tinkerforge call red-brick <uid> get-programs <session-id>¶

Parameters:	<session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols programs-list-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> define-program <identifier-string-id> <session-id>¶

Parameters:	<identifier-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols program-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> purge-program <program-id> <cookie>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <cookie> – Type: Int, Range: [0 to 2³² - 1]
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-program-identifier <program-id> <session-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols identifier-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-program-root-directory <program-id> <session-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols root-directory-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

FIXME: root directory is absolute: <home>/programs/<identifier>

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> set-program-command <program-id> <executable-string-id> <arguments-list-id> <environment-list-id> <working-directory-string-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <executable-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <arguments-list-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <environment-list-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <working-directory-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

FIXME: working directory is relative to <home>/programs/<identifier>/bin

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-program-command <program-id> <session-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols executable-string-id – Type: Int, Range: [0 to 2¹⁶ - 1] arguments-list-id – Type: Int, Range: [0 to 2¹⁶ - 1] environment-list-id – Type: Int, Range: [0 to 2¹⁶ - 1] working-directory-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

FIXME: working directory is relative to <home>/programs/<identifier>/bin

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> set-program-stdio-redirection <program-id> <stdin-redirection> <stdin-file-name-string-id> <stdout-redirection> <stdout-file-name-string-id> <stderr-redirection> <stderr-file-name-string-id>¶

Parameters:

<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<stdin-redirection> – Type: Int, Range: See symbols
<stdin-file-name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<stdout-redirection> – Type: Int, Range: See symbols
<stdout-file-name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<stderr-redirection> – Type: Int, Range: See symbols
<stderr-file-name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]

Output:

error-code – Type: Int, Range: See symbols

FIXME: stdio file names are relative to <home>/programs/<identifier>/bin

The following symbols are available for this function:

For <stdin-redirection>:

program-stdio-redirection-dev-null = 0
program-stdio-redirection-pipe = 1
program-stdio-redirection-file = 2
program-stdio-redirection-individual-log = 3
program-stdio-redirection-continuous-log = 4
program-stdio-redirection-stdout = 5

For <stdout-redirection>:

program-stdio-redirection-dev-null = 0
program-stdio-redirection-pipe = 1
program-stdio-redirection-file = 2
program-stdio-redirection-individual-log = 3
program-stdio-redirection-continuous-log = 4
program-stdio-redirection-stdout = 5

For <stderr-redirection>:

program-stdio-redirection-dev-null = 0
program-stdio-redirection-pipe = 1
program-stdio-redirection-file = 2
program-stdio-redirection-individual-log = 3
program-stdio-redirection-continuous-log = 4
program-stdio-redirection-stdout = 5

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-program-stdio-redirection <program-id> <session-id>¶

Parameters:

<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
<session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]

Output:

error-code – Type: Int, Range: See symbols
stdin-redirection – Type: Int, Range: See symbols
stdin-file-name-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]
stdout-redirection – Type: Int, Range: See symbols
stdout-file-name-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]
stderr-redirection – Type: Int, Range: See symbols
stderr-file-name-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

FIXME: stdio file names are relative to <home>/programs/<identifier>/bin

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

For stdin-redirection:

program-stdio-redirection-dev-null = 0
program-stdio-redirection-pipe = 1
program-stdio-redirection-file = 2
program-stdio-redirection-individual-log = 3
program-stdio-redirection-continuous-log = 4
program-stdio-redirection-stdout = 5

For stdout-redirection:

program-stdio-redirection-dev-null = 0
program-stdio-redirection-pipe = 1
program-stdio-redirection-file = 2
program-stdio-redirection-individual-log = 3
program-stdio-redirection-continuous-log = 4
program-stdio-redirection-stdout = 5

For stderr-redirection:

program-stdio-redirection-dev-null = 0
program-stdio-redirection-pipe = 1
program-stdio-redirection-file = 2
program-stdio-redirection-individual-log = 3
program-stdio-redirection-continuous-log = 4
program-stdio-redirection-stdout = 5

tinkerforge call red-brick <uid> set-program-schedule <program-id> <start-mode> <continue-after-error> <start-interval> <start-fields-string-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <start-mode> – Type: Int, Range: See symbols <continue-after-error> – Type: Bool <start-interval> – Type: Int, Range: [0 to 2³² - 1] <start-fields-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For <start-mode>:

program-start-mode-never = 0
program-start-mode-always = 1
program-start-mode-interval = 2
program-start-mode-cron = 3

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-program-schedule <program-id> <session-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols start-mode – Type: Int, Range: See symbols continue-after-error – Type: Bool start-interval – Type: Int, Range: [0 to 2³² - 1] start-fields-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

For start-mode:

program-start-mode-never = 0
program-start-mode-always = 1
program-start-mode-interval = 2
program-start-mode-cron = 3

tinkerforge call red-brick <uid> get-program-scheduler-state <program-id> <session-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols state – Type: Int, Range: See symbols timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1] message-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

FIXME: message is currently valid in error-occurred state only

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

For state:

program-scheduler-state-stopped = 0
program-scheduler-state-running = 1

tinkerforge call red-brick <uid> continue-program-schedule <program-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> start-program <program-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-last-spawned-program-process <program-id> <session-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols process-id – Type: Int, Range: [0 to 2¹⁶ - 1] timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-custom-program-option-names <program-id> <session-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols names-list-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> set-custom-program-option-value <program-id> <name-string-id> <value-string-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <value-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-custom-program-option-value <program-id> <name-string-id> <session-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <session-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols value-string-id – Type: Int, Range: [0 to 2¹⁶ - 1]

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> remove-custom-program-option <program-id> <name-string-id>¶

Parameters:	<program-id> – Type: Int, Range: [0 to 2¹⁶ - 1] <name-string-id> – Type: Int, Range: [0 to 2¹⁶ - 1]
Output:	error-code – Type: Int, Range: See symbols

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge call red-brick <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8
connected-uid – Type: String, Length: up to 8
position – Type: Char, Range: [0 to 8]
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 2¹⁶ - 1]

Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position is the position in the stack from '0' (bottom) to '8' (top).

The device identifier numbers can be found here.

Callbacks¶

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

tinkerforge dispatch red-brick <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.

tinkerforge dispatch red-brick <uid> async-file-read¶

Output:	file-id – Type: Int, Range: [0 to 2¹⁶ - 1] error-code – Type: Int, Range: See symbols buffer – Type: Int Array, Length: 60, Range: [0 to 255] length-read – Type: Int, Unit: 1 B, Range: [0 to 255]

This callback reports the result of a call to the read-file-async function.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge dispatch red-brick <uid> async-file-write¶

Output:	file-id – Type: Int, Range: [0 to 2¹⁶ - 1] error-code – Type: Int, Range: See symbols length-written – Type: Int, Unit: 1 B, Range: [0 to 255]

This callback reports the result of a call to the write-file-async function.

The following symbols are available for this function:

For error-code:

error-code-success = 0
error-code-unknown-error = 1
error-code-invalid-operation = 2
error-code-operation-aborted = 3
error-code-internal-error = 4
error-code-unknown-session-id = 5
error-code-no-free-session-id = 6
error-code-unknown-object-id = 7
error-code-no-free-object-id = 8
error-code-object-is-locked = 9
error-code-no-more-data = 10
error-code-wrong-list-item-type = 11
error-code-program-is-purged = 12
error-code-invalid-parameter = 128
error-code-no-free-memory = 129
error-code-no-free-space = 130
error-code-access-denied = 121
error-code-already-exists = 132
error-code-does-not-exist = 133
error-code-interrupted = 134
error-code-is-directory = 135
error-code-not-a-directory = 136
error-code-would-block = 137
error-code-overflow = 138
error-code-bad-file-descriptor = 139
error-code-out-of-range = 140
error-code-name-too-long = 141
error-code-invalid-seek = 142
error-code-not-supported = 143
error-code-too-many-open-files = 144

tinkerforge dispatch red-brick <uid> file-events-occurred¶

Output:	file-id – Type: Int, Range: [0 to 2¹⁶ - 1] events – Type: Int, Range: See symbols

The following symbols are available for this function:

For events:

file-event-readable = 1
file-event-writable = 2

tinkerforge dispatch red-brick <uid> process-state-changed¶

Output:	process-id – Type: Int, Range: [0 to 2¹⁶ - 1] state – Type: Int, Range: See symbols timestamp – Type: Int, Range: [0 to 2⁶⁴ - 1] exit-code – Type: Int, Range: [0 to 255]

The following symbols are available for this function:

For state:

process-state-unknown = 0
process-state-running = 1
process-state-error = 2
process-state-exited = 3
process-state-killed = 4
process-state-stopped = 5

tinkerforge dispatch red-brick <uid> program-scheduler-state-changed¶

Output:	program-id – Type: Int, Range: [0 to 2¹⁶ - 1]

tinkerforge dispatch red-brick <uid> program-process-spawned¶

Output:	program-id – Type: Int, Range: [0 to 2¹⁶ - 1]