..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-shell">Software</a> / Shell - RED Brick

.. |device_identifier_constant| unicode:: 0xA0
   :trim:

.. _red_brick_shell:

Shell - RED Brick
=================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` for the :ref:`RED Brick <red_brick>`. General information and technical
specifications for the RED Brick are summarized in its :ref:`hardware description
<red_brick_description>`.

An :ref:`installation guide <api_bindings_shell_install>` for the Shell API
bindings is part of their general description.

.. _red_brick_shell_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

.. _red_brick_shell_api:

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


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. :sh:func:`allocate-string <red-brick allocate-string>`
and :sh:func:`get-next-directory-entry <red-brick get-next-directory-entry>`) increase the reference count of the returned
object. If the object is no longer needed then :sh:func:`release-object <red-brick 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 :sh:func:`release-object <red-brick release-object>` must not be called for
such an object in response to a callback.

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

There are also function (e.g. :sh:func:`set-program-stdio-redirection <red-brick 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 :ref:`TCP/IP protocol <llproto_tcpip>`
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
:ref:`here <ipcon_shell_api>`. The specific command structure is shown below.

.. sh:function:: X Stinkerforge Pcall Nred-brick A[<option>..] L<uid> L<function> L[<argument>..]

 :param <uid>: string
 :param <function>: 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


.. sh:function:: X Stinkerforge Pdispatch Nred-brick A[<option>..] L<uid> L<callback>

 :param <uid>: string
 :param <callback>: 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


.. sh:function:: X Stinkerforge Scall Pred-brick L<uid> N<function> A[<option>..] L[<argument>..]

 :param <uid>: string
 :param <function>: 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 :ref:`output formatting <ipcon_shell_output>`
   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 send and errors are silently ignored,
 because they cannot be detected.


.. sh:function:: X Stinkerforge Sdispatch Pred-brick L<uid> N<callback> A[<option>..]

 :param <uid>: string
 :param <callback>: 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 :ref:`output formatting <ipcon_shell_output>`
   for details)



Advanced Functions
^^^^^^^^^^^^^^^^^^

.. sh:function:: tinkerforge call red-brick <uid> create-session <lifetime> 

 :param <lifetime>: int

 :returns error-code: int
 :returns session-id: int

 
.. sh:function:: tinkerforge call red-brick <uid> expire-session <session-id> 

 :param <session-id>: int

 :returns error-code: int

 
.. sh:function:: tinkerforge call red-brick <uid> expire-session-unchecked <session-id> 

 :param <session-id>: int

 :noreturn: no output

 
.. sh:function:: tinkerforge call red-brick <uid> keep-session-alive <session-id> <lifetime> 

 :param <session-id>: int
 :param <lifetime>: int

 :returns error-code: int

 
.. sh:function:: tinkerforge call red-brick <uid> release-object <object-id> <session-id> 

 :param <object-id>: int
 :param <session-id>: int

 :returns error-code: int

 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.
 
.. sh:function:: tinkerforge call red-brick <uid> release-object-unchecked <object-id> <session-id> 

 :param <object-id>: int
 :param <session-id>: int

 :noreturn: no output

 
.. sh:function:: tinkerforge call red-brick <uid> allocate-string <length-to-reserve> <buffer> <session-id> 

 :param <length-to-reserve>: int
 :param <buffer>: string
 :param <session-id>: int

 :returns error-code: int
 :returns string-id: int

 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.
 
.. sh:function:: tinkerforge call red-brick <uid> truncate-string <string-id> <length> 

 :param <string-id>: int
 :param <length>: int

 :returns error-code: int

 Truncates a string object to ``length`` bytes and returns the resulting
 error code.
 
.. sh:function:: tinkerforge call red-brick <uid> get-string-length <string-id> 

 :param <string-id>: int

 :returns error-code: int
 :returns length: int

 Returns the length of a string object in bytes and the resulting error code.
 
.. sh:function:: tinkerforge call red-brick <uid> set-string-chunk <string-id> <offset> <buffer> 

 :param <string-id>: int
 :param <offset>: int
 :param <buffer>: string

 :returns error-code: int

 Sets a chunk of up to 58 bytes in a string object beginning at ``offset``.
 
 Returns the resulting error code.
 
.. sh:function:: tinkerforge call red-brick <uid> get-string-chunk <string-id> <offset> 

 :param <string-id>: int
 :param <offset>: int

 :returns error-code: int
 :returns buffer: string

 Returns a chunk up to 63 bytes from a string object beginning at ``offset`` and
 returns the resulting error code.
 
.. sh:function:: tinkerforge call red-brick <uid> allocate-list <length-to-reserve> <session-id> 

 :param <length-to-reserve>: int
 :param <session-id>: int

 :returns error-code: int
 :returns list-id: int

 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.
 
.. sh:function:: tinkerforge call red-brick <uid> get-list-length <list-id> 

 :param <list-id>: int

 :returns error-code: int
 :returns length: int

 Returns the length of a list object in items and the resulting error code.
 
.. sh:function:: tinkerforge call red-brick <uid> get-list-item <list-id> <index> <session-id> 

 :param <list-id>: int
 :param <index>: int
 :param <session-id>: int

 :returns error-code: int
 :returns item-object-id: int
 :returns type: int (has 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:
 
 * ``string`` = 0, for type
 * ``list`` = 1, for type
 * ``file`` = 2, for type
 * ``directory`` = 3, for type
 * ``process`` = 4, for type
 * ``program`` = 5, for type
 
.. sh:function:: tinkerforge call red-brick <uid> append-to-list <list-id> <item-object-id> 

 :param <list-id>: int
 :param <item-object-id>: int

 :returns error-code: int

 Appends an object to a list object and increases the reference count of the
 appended object by one.
 
 Returns the resulting error code.
 
.. sh:function:: tinkerforge call red-brick <uid> remove-from-list <list-id> <index> 

 :param <list-id>: int
 :param <index>: int

 :returns error-code: int

 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.
 
.. sh:function:: tinkerforge call red-brick <uid> open-file <name-string-id> <flags> <permissions> <uid> <gid> <session-id> 

 :param <name-string-id>: int
 :param <flags>: int (has symbols)
 :param <permissions>: int (has symbols)
 :param <uid>: int
 :param <gid>: int
 :param <session-id>: int

 :returns error-code: int
 :returns file-id: int

 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:
 
 * ``read-only`` = 1, for <flags>
 * ``write-only`` = 2, for <flags>
 * ``read-write`` = 4, for <flags>
 * ``append`` = 8, for <flags>
 * ``create`` = 16, for <flags>
 * ``exclusive`` = 32, for <flags>
 * ``non-blocking`` = 64, for <flags>
 * ``truncate`` = 128, for <flags>
 * ``temporary`` = 256, for <flags>
 * ``replace`` = 512, for <flags>
 * ``user-all`` = 448, for <permissions>
 * ``user-read`` = 256, for <permissions>
 * ``user-write`` = 128, for <permissions>
 * ``user-execute`` = 64, for <permissions>
 * ``group-all`` = 56, for <permissions>
 * ``group-read`` = 32, for <permissions>
 * ``group-write`` = 16, for <permissions>
 * ``group-execute`` = 8, for <permissions>
 * ``others-all`` = 7, for <permissions>
 * ``others-read`` = 4, for <permissions>
 * ``others-write`` = 2, for <permissions>
 * ``others-execute`` = 1, for <permissions>
 
.. sh:function:: tinkerforge call red-brick <uid> create-pipe <flags> <length> <session-id> 

 :param <flags>: int (has symbols)
 :param <length>: int
 :param <session-id>: int

 :returns error-code: int
 :returns file-id: int

 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:
 
 * ``non-blocking-read`` = 1, for <flags>
 * ``non-blocking-write`` = 2, for <flags>
 
.. sh:function:: tinkerforge call red-brick <uid> get-file-info <file-id> <session-id> 

 :param <file-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns type: int (has symbols)
 :returns name-string-id: int
 :returns flags: int
 :returns permissions: int (has symbols)
 :returns uid: int
 :returns gid: int
 :returns length: int
 :returns access-timestamp: int
 :returns modification-timestamp: int
 :returns status-change-timestamp: int

 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 :sh:func:`open-file <red-brick open-file>`.
 
 The returned flags were used to open or create the file object, as passed to
 :sh:func:`open-file <red-brick open-file>` or :sh:func:`create-pipe <red-brick 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:
 
 * ``unknown`` = 0, for type
 * ``regular`` = 1, for type
 * ``directory`` = 2, for type
 * ``character`` = 3, for type
 * ``block`` = 4, for type
 * ``fifo`` = 5, for type
 * ``symlink`` = 6, for type
 * ``socket`` = 7, for type
 * ``pipe`` = 8, for type
 * ``user-all`` = 448, for permissions
 * ``user-read`` = 256, for permissions
 * ``user-write`` = 128, for permissions
 * ``user-execute`` = 64, for permissions
 * ``group-all`` = 56, for permissions
 * ``group-read`` = 32, for permissions
 * ``group-write`` = 16, for permissions
 * ``group-execute`` = 8, for permissions
 * ``others-all`` = 7, for permissions
 * ``others-read`` = 4, for permissions
 * ``others-write`` = 2, for permissions
 * ``others-execute`` = 1, for permissions
 
.. sh:function:: tinkerforge call red-brick <uid> read-file <file-id> <length-to-read> 

 :param <file-id>: int
 :param <length-to-read>: int

 :returns error-code: int
 :returns buffer: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :returns length-read: int

 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 :sh:func:`open-file <red-brick open-file>` without the *NonBlocking*
 flag or by :sh:func:`create-pipe <red-brick create-pipe>` without the *NonBlockingRead* flag then the
 error code *NotSupported* is returned.
 
.. sh:function:: tinkerforge call red-brick <uid> read-file-async <file-id> <length-to-read> 

 :param <file-id>: int
 :param <length-to-read>: int

 :noreturn: no output

 Reads up to 2\ :sup:`63`\  - 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 :sh:func:`async-file-read <red-brick 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 :sh:func:`open-file <red-brick open-file>` without the *NonBlocking*
 flag or by :sh:func:`create-pipe <red-brick create-pipe>` without the *NonBlockingRead* flag then the error
 code *NotSupported* is reported via the :sh:func:`async-file-read <red-brick async-file-read>` callback.
 
.. sh:function:: tinkerforge call red-brick <uid> abort-async-file-read <file-id> 

 :param <file-id>: int

 :returns error-code: int

 Aborts a :sh:func:`read-file-async <red-brick read-file-async>` operation in progress.
 
 Returns the resulting error code.
 
 On success the :sh:func:`async-file-read <red-brick async-file-read>` callback will report *OperationAborted*.
 
.. sh:function:: tinkerforge call red-brick <uid> write-file <file-id> <buffer> <length-to-write> 

 :param <file-id>: int
 :param <buffer>: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :param <length-to-write>: int

 :returns error-code: int
 :returns length-written: int

 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 :sh:func:`open-file <red-brick open-file>` without the *NonBlocking*
 flag or by :sh:func:`create-pipe <red-brick create-pipe>` without the *NonBlockingWrite* flag then the
 error code *NotSupported* is returned.
 
.. sh:function:: tinkerforge call red-brick <uid> write-file-unchecked <file-id> <buffer> <length-to-write> 

 :param <file-id>: int
 :param <buffer>: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :param <length-to-write>: int

 :noreturn: 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 :sh:func:`open-file <red-brick open-file>` without the *NonBlocking*
 flag or by :sh:func:`create-pipe <red-brick create-pipe>` without the *NonBlockingWrite* flag then the
 write operation will fail silently.
 
.. sh:function:: tinkerforge call red-brick <uid> write-file-async <file-id> <buffer> <length-to-write> 

 :param <file-id>: int
 :param <buffer>: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :param <length-to-write>: int

 :noreturn: 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
 :sh:func:`async-file-write <red-brick async-file-write>` callback.
 
 If the file object was created by :sh:func:`open-file <red-brick open-file>` without the *NonBlocking*
 flag or by :sh:func:`create-pipe <red-brick create-pipe>` without the *NonBlockingWrite* flag then the
 error code *NotSupported* is reported via the :sh:func:`async-file-write <red-brick async-file-write>` callback.
 
.. sh:function:: tinkerforge call red-brick <uid> set-file-position <file-id> <offset> <origin> 

 :param <file-id>: int
 :param <offset>: int
 :param <origin>: int (has symbols)

 :returns error-code: int
 :returns position: int

 Set the current seek position of a file object in bytes 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 :sh:func:`create-pipe <red-brick create-pipe>` then it has no seek
 position and the error code *InvalidSeek* is returned.
 
 The following symbols are available for this function:
 
 * ``beginning`` = 0, for <origin>
 * ``current`` = 1, for <origin>
 * ``end`` = 2, for <origin>
 
.. sh:function:: tinkerforge call red-brick <uid> get-file-position <file-id> 

 :param <file-id>: int

 :returns error-code: int
 :returns position: int

 Returns the current seek position of a file object in bytes and returns the
 resulting error code.
 
 If the file object was created by :sh:func:`create-pipe <red-brick create-pipe>` then it has no seek
 position and the error code *InvalidSeek* is returned.
 
.. sh:function:: tinkerforge call red-brick <uid> set-file-events <file-id> <events> 

 :param <file-id>: int
 :param <events>: int (has symbols)

 :returns error-code: int

 
 The following symbols are available for this function:
 
 * ``readable`` = 1, for <events>
 * ``writable`` = 2, for <events>
 
.. sh:function:: tinkerforge call red-brick <uid> get-file-events <file-id> 

 :param <file-id>: int

 :returns error-code: int
 :returns events: int (has symbols)

 
 The following symbols are available for this function:
 
 * ``readable`` = 1, for events
 * ``writable`` = 2, for events
 
.. sh:function:: tinkerforge call red-brick <uid> open-directory <name-string-id> <session-id> 

 :param <name-string-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns directory-id: int

 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.
 
.. sh:function:: tinkerforge call red-brick <uid> get-directory-name <directory-id> <session-id> 

 :param <directory-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns name-string-id: int

 Returns the name of a directory object, as passed to :sh:func:`open-directory <red-brick open-directory>`, and
 the resulting error code.
 
.. sh:function:: tinkerforge call red-brick <uid> get-next-directory-entry <directory-id> <session-id> 

 :param <directory-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns name-string-id: int
 :returns type: int (has 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 :sh:func:`rewind-directory <red-brick 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:
 
 * ``unknown`` = 0, for type
 * ``regular`` = 1, for type
 * ``directory`` = 2, for type
 * ``character`` = 3, for type
 * ``block`` = 4, for type
 * ``fifo`` = 5, for type
 * ``symlink`` = 6, for type
 * ``socket`` = 7, for type
 
.. sh:function:: tinkerforge call red-brick <uid> rewind-directory <directory-id> 

 :param <directory-id>: int

 :returns error-code: int

 Rewinds a directory object and returns the resulting error code.
 
.. sh:function:: tinkerforge call red-brick <uid> create-directory <name-string-id> <flags> <permissions> <uid> <gid> 

 :param <name-string-id>: int
 :param <flags>: int (has symbols)
 :param <permissions>: int (has symbols)
 :param <uid>: int
 :param <gid>: int

 :returns error-code: int

 FIXME: name has to be absolute
 
 The following symbols are available for this function:
 
 * ``recursive`` = 1, for <flags>
 * ``exclusive`` = 2, for <flags>
 * ``user-all`` = 448, for <permissions>
 * ``user-read`` = 256, for <permissions>
 * ``user-write`` = 128, for <permissions>
 * ``user-execute`` = 64, for <permissions>
 * ``group-all`` = 56, for <permissions>
 * ``group-read`` = 32, for <permissions>
 * ``group-write`` = 16, for <permissions>
 * ``group-execute`` = 8, for <permissions>
 * ``others-all`` = 7, for <permissions>
 * ``others-read`` = 4, for <permissions>
 * ``others-write`` = 2, for <permissions>
 * ``others-execute`` = 1, for <permissions>
 
.. sh:function:: tinkerforge call red-brick <uid> get-processes <session-id> 

 :param <session-id>: int

 :returns error-code: int
 :returns processes-list-id: int

 
.. sh:function:: 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> 

 :param <executable-string-id>: int
 :param <arguments-list-id>: int
 :param <environment-list-id>: int
 :param <working-directory-string-id>: int
 :param <uid>: int
 :param <gid>: int
 :param <stdin-file-id>: int
 :param <stdout-file-id>: int
 :param <stderr-file-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns process-id: int

 
.. sh:function:: tinkerforge call red-brick <uid> kill-process <process-id> <signal> 

 :param <process-id>: int
 :param <signal>: int (has symbols)

 :returns error-code: int

 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:
 
 * ``interrupt`` = 2, for <signal>
 * ``quit`` = 3, for <signal>
 * ``abort`` = 6, for <signal>
 * ``kill`` = 9, for <signal>
 * ``user1`` = 10, for <signal>
 * ``user2`` = 12, for <signal>
 * ``terminate`` = 15, for <signal>
 * ``continue`` = 18, for <signal>
 * ``stop`` = 19, for <signal>
 
.. sh:function:: tinkerforge call red-brick <uid> get-process-command <process-id> <session-id> 

 :param <process-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns executable-string-id: int
 :returns arguments-list-id: int
 :returns environment-list-id: int
 :returns working-directory-string-id: int

 Returns the executable, arguments, environment and working directory used to
 spawn a process object, as passed to :sh:func:`spawn-process <red-brick spawn-process>`, and the resulting
 error code.
 
.. sh:function:: tinkerforge call red-brick <uid> get-process-identity <process-id> 

 :param <process-id>: int

 :returns error-code: int
 :returns pid: int
 :returns uid: int
 :returns gid: int

 Returns the process ID and the user and group ID used to spawn a process object,
 as passed to :sh:func:`spawn-process <red-brick spawn-process>`, and the resulting error code.
 
 The process ID is only valid if the state is *Running* or *Stopped*, see
 :sh:func:`get-process-state <red-brick get-process-state>`.
 
.. sh:function:: tinkerforge call red-brick <uid> get-process-stdio <process-id> <session-id> 

 :param <process-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns stdin-file-id: int
 :returns stdout-file-id: int
 :returns stderr-file-id: int

 Returns the stdin, stdout and stderr files used to spawn a process object, as
 passed to :sh:func:`spawn-process <red-brick spawn-process>`, and the resulting error code.
 
.. sh:function:: tinkerforge call red-brick <uid> get-process-state <process-id> 

 :param <process-id>: int

 :returns error-code: int
 :returns state: int (has symbols)
 :returns timestamp: int
 :returns exit-code: int

 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:
 
 * ``unknown`` = 0, for state
 * ``running`` = 1, for state
 * ``error`` = 2, for state
 * ``exited`` = 3, for state
 * ``killed`` = 4, for state
 * ``stopped`` = 5, for state
 
.. sh:function:: tinkerforge call red-brick <uid> get-programs <session-id> 

 :param <session-id>: int

 :returns error-code: int
 :returns programs-list-id: int

 
.. sh:function:: tinkerforge call red-brick <uid> define-program <identifier-string-id> <session-id> 

 :param <identifier-string-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns program-id: int

 
.. sh:function:: tinkerforge call red-brick <uid> purge-program <program-id> <cookie> 

 :param <program-id>: int
 :param <cookie>: int

 :returns error-code: int

 
.. sh:function:: tinkerforge call red-brick <uid> get-program-identifier <program-id> <session-id> 

 :param <program-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns identifier-string-id: int

 
.. sh:function:: tinkerforge call red-brick <uid> get-program-root-directory <program-id> <session-id> 

 :param <program-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns root-directory-string-id: int

 FIXME: root directory is absolute: <home>/programs/<identifier>
 
.. sh:function:: tinkerforge call red-brick <uid> set-program-command <program-id> <executable-string-id> <arguments-list-id> <environment-list-id> <working-directory-string-id> 

 :param <program-id>: int
 :param <executable-string-id>: int
 :param <arguments-list-id>: int
 :param <environment-list-id>: int
 :param <working-directory-string-id>: int

 :returns error-code: int

 FIXME: working directory is relative to <home>/programs/<identifier>/bin
 
.. sh:function:: tinkerforge call red-brick <uid> get-program-command <program-id> <session-id> 

 :param <program-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns executable-string-id: int
 :returns arguments-list-id: int
 :returns environment-list-id: int
 :returns working-directory-string-id: int

 FIXME: working directory is relative to <home>/programs/<identifier>/bin
 
.. sh:function:: 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> 

 :param <program-id>: int
 :param <stdin-redirection>: int (has symbols)
 :param <stdin-file-name-string-id>: int
 :param <stdout-redirection>: int (has symbols)
 :param <stdout-file-name-string-id>: int
 :param <stderr-redirection>: int (has symbols)
 :param <stderr-file-name-string-id>: int

 :returns error-code: int

 FIXME: stdio file names are relative to <home>/programs/<identifier>/bin
 
 The following symbols are available for this function:
 
 * ``dev-null`` = 0, for <stdin-redirection>, <stdout-redirection> and <stderr-redirection>
 * ``pipe`` = 1, for <stdin-redirection>, <stdout-redirection> and <stderr-redirection>
 * ``file`` = 2, for <stdin-redirection>, <stdout-redirection> and <stderr-redirection>
 * ``individual-log`` = 3, for <stdin-redirection>, <stdout-redirection> and <stderr-redirection>
 * ``continuous-log`` = 4, for <stdin-redirection>, <stdout-redirection> and <stderr-redirection>
 * ``stdout`` = 5, for <stdin-redirection>, <stdout-redirection> and <stderr-redirection>
 
.. sh:function:: tinkerforge call red-brick <uid> get-program-stdio-redirection <program-id> <session-id> 

 :param <program-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns stdin-redirection: int (has symbols)
 :returns stdin-file-name-string-id: int
 :returns stdout-redirection: int (has symbols)
 :returns stdout-file-name-string-id: int
 :returns stderr-redirection: int (has symbols)
 :returns stderr-file-name-string-id: int

 FIXME: stdio file names are relative to <home>/programs/<identifier>/bin
 
 The following symbols are available for this function:
 
 * ``dev-null`` = 0, for stdin-redirection, stdout-redirection and stderr-redirection
 * ``pipe`` = 1, for stdin-redirection, stdout-redirection and stderr-redirection
 * ``file`` = 2, for stdin-redirection, stdout-redirection and stderr-redirection
 * ``individual-log`` = 3, for stdin-redirection, stdout-redirection and stderr-redirection
 * ``continuous-log`` = 4, for stdin-redirection, stdout-redirection and stderr-redirection
 * ``stdout`` = 5, for stdin-redirection, stdout-redirection and stderr-redirection
 
.. sh:function:: tinkerforge call red-brick <uid> set-program-schedule <program-id> <start-mode> <continue-after-error> <start-interval> <start-fields-string-id> 

 :param <program-id>: int
 :param <start-mode>: int (has symbols)
 :param <continue-after-error>: bool
 :param <start-interval>: int
 :param <start-fields-string-id>: int

 :returns error-code: int

 
 The following symbols are available for this function:
 
 * ``never`` = 0, for <start-mode>
 * ``always`` = 1, for <start-mode>
 * ``interval`` = 2, for <start-mode>
 * ``cron`` = 3, for <start-mode>
 
.. sh:function:: tinkerforge call red-brick <uid> get-program-schedule <program-id> <session-id> 

 :param <program-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns start-mode: int (has symbols)
 :returns continue-after-error: bool
 :returns start-interval: int
 :returns start-fields-string-id: int

 
 The following symbols are available for this function:
 
 * ``never`` = 0, for start-mode
 * ``always`` = 1, for start-mode
 * ``interval`` = 2, for start-mode
 * ``cron`` = 3, for start-mode
 
.. sh:function:: tinkerforge call red-brick <uid> get-program-scheduler-state <program-id> <session-id> 

 :param <program-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns state: int (has symbols)
 :returns timestamp: int
 :returns message-string-id: int

 FIXME: message is currently valid in error-occurred state only
 
 The following symbols are available for this function:
 
 * ``stopped`` = 0, for state
 * ``running`` = 1, for state
 
.. sh:function:: tinkerforge call red-brick <uid> continue-program-schedule <program-id> 

 :param <program-id>: int

 :returns error-code: int

 
.. sh:function:: tinkerforge call red-brick <uid> start-program <program-id> 

 :param <program-id>: int

 :returns error-code: int

 
.. sh:function:: tinkerforge call red-brick <uid> get-last-spawned-program-process <program-id> <session-id> 

 :param <program-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns process-id: int
 :returns timestamp: int

 
.. sh:function:: tinkerforge call red-brick <uid> get-custom-program-option-names <program-id> <session-id> 

 :param <program-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns names-list-id: int

 
.. sh:function:: tinkerforge call red-brick <uid> set-custom-program-option-value <program-id> <name-string-id> <value-string-id> 

 :param <program-id>: int
 :param <name-string-id>: int
 :param <value-string-id>: int

 :returns error-code: int

 
.. sh:function:: tinkerforge call red-brick <uid> get-custom-program-option-value <program-id> <name-string-id> <session-id> 

 :param <program-id>: int
 :param <name-string-id>: int
 :param <session-id>: int

 :returns error-code: int
 :returns value-string-id: int

 
.. sh:function:: tinkerforge call red-brick <uid> remove-custom-program-option <program-id> <name-string-id> 

 :param <program-id>: int
 :param <name-string-id>: int

 :returns error-code: int

 
.. sh:function:: tinkerforge call red-brick <uid> get-identity  


 :returns uid: string
 :returns connected-uid: string
 :returns position: char
 :returns hardware-version: int,int,int
 :returns firmware-version: int,int,int
 :returns device-identifier: int (has symbols)

 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 can be '0'-'8' (stack position).
 
 The device identifier numbers can be found :ref:`here <device_identifier>`.
 |device_identifier_constant|
 


.. _red_brick_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    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.

.. sh:function::  tinkerforge dispatch red-brick <uid> async-file-read

 :returns file-id: int
 :returns error-code: int
 :returns buffer: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :returns length-read: int


 This callback reports the result of a call to the :sh:func:`read-file-async <red-brick read-file-async>`
 function.
 
.. sh:function::  tinkerforge dispatch red-brick <uid> async-file-write

 :returns file-id: int
 :returns error-code: int
 :returns length-written: int


 This callback reports the result of a call to the :sh:func:`write-file-async <red-brick write-file-async>`
 function.
 
.. sh:function::  tinkerforge dispatch red-brick <uid> file-events-occurred

 :returns file-id: int
 :returns events: int (has symbols)


 
 The following symbols are available for this function:
 
 * ``readable`` = 1, for events
 * ``writable`` = 2, for events
 
.. sh:function::  tinkerforge dispatch red-brick <uid> process-state-changed

 :returns process-id: int
 :returns state: int (has symbols)
 :returns timestamp: int
 :returns exit-code: int


 
 The following symbols are available for this function:
 
 * ``unknown`` = 0, for state
 * ``running`` = 1, for state
 * ``error`` = 2, for state
 * ``exited`` = 3, for state
 * ``killed`` = 4, for state
 * ``stopped`` = 5, for state
 
.. sh:function::  tinkerforge dispatch red-brick <uid> program-scheduler-state-changed

 :returns program-id: int


 
.. sh:function::  tinkerforge dispatch red-brick <uid> program-process-spawned

 :returns program-id: int


 


