..
 #############################################################
 # 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-modbus">Software</a> / Modbus - RED Brick

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

.. _red_brick_modbus:

Modbus - RED Brick
==================

This is the description of the :ref:`Modbus protocol <llproto_modbus>` 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>`.

.. _red_brick_modbus_api:

API
---

A general description of the Modbus protocol structure can be found
:ref:`here <llproto_modbus>`.


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. :modbus:func:`allocate_string <BrickRED.allocate_string>`
and :modbus:func:`get_next_directory_entry <BrickRED.get_next_directory_entry>`) increase the reference count of the returned
object. If the object is no longer needed then :modbus:func:`release_object <BrickRED.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 :modbus:func:`release_object <BrickRED.release_object>` must not be called for
such an object in response to a callback.

There are functions (e.g. :modbus:func:`get_file_info <BrickRED.get_file_info>`) that only return valid objects
under certain conditions. This conditions are documented for the specific
functions. For invalid objects :modbus:func:`release_object <BrickRED.release_object>` must not be called.

There are also function (e.g. :modbus:func:`set_program_stdio_redirection <BrickRED.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.



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

.. modbus:function:: BrickRED.create_session

 :functionid: 1
 :request lifetime: uint32

 :response error_code: uint8
 :response session_id: uint16

 
.. modbus:function:: BrickRED.expire_session

 :functionid: 2
 :request session_id: uint16

 :response error_code: uint8

 
.. modbus:function:: BrickRED.expire_session_unchecked

 :functionid: 3
 :request session_id: uint16

 :noresponse: no response

 
.. modbus:function:: BrickRED.keep_session_alive

 :functionid: 4
 :request session_id: uint16
 :request lifetime: uint32

 :response error_code: uint8

 
.. modbus:function:: BrickRED.release_object

 :functionid: 5
 :request object_id: uint16
 :request session_id: uint16

 :response error_code: uint8

 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.
 
.. modbus:function:: BrickRED.release_object_unchecked

 :functionid: 6
 :request object_id: uint16
 :request session_id: uint16

 :noresponse: no response

 
.. modbus:function:: BrickRED.allocate_string

 :functionid: 7
 :request length_to_reserve: uint32
 :request buffer: char[58]
 :request session_id: uint16

 :response error_code: uint8
 :response string_id: uint16

 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.
 
.. modbus:function:: BrickRED.truncate_string

 :functionid: 8
 :request string_id: uint16
 :request length: uint32

 :response error_code: uint8

 Truncates a string object to ``length`` bytes and returns the resulting
 error code.
 
.. modbus:function:: BrickRED.get_string_length

 :functionid: 9
 :request string_id: uint16

 :response error_code: uint8
 :response length: uint32

 Returns the length of a string object in bytes and the resulting error code.
 
.. modbus:function:: BrickRED.set_string_chunk

 :functionid: 10
 :request string_id: uint16
 :request offset: uint32
 :request buffer: char[58]

 :response error_code: uint8

 Sets a chunk of up to 58 bytes in a string object beginning at ``offset``.
 
 Returns the resulting error code.
 
.. modbus:function:: BrickRED.get_string_chunk

 :functionid: 11
 :request string_id: uint16
 :request offset: uint32

 :response error_code: uint8
 :response buffer: char[63]

 Returns a chunk up to 63 bytes from a string object beginning at ``offset`` and
 returns the resulting error code.
 
.. modbus:function:: BrickRED.allocate_list

 :functionid: 12
 :request length_to_reserve: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response list_id: uint16

 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.
 
.. modbus:function:: BrickRED.get_list_length

 :functionid: 13
 :request list_id: uint16

 :response error_code: uint8
 :response length: uint16

 Returns the length of a list object in items and the resulting error code.
 
.. modbus:function:: BrickRED.get_list_item

 :functionid: 14
 :request list_id: uint16
 :request index: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response item_object_id: uint16
 :response type: uint8

 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
 
.. modbus:function:: BrickRED.append_to_list

 :functionid: 15
 :request list_id: uint16
 :request item_object_id: uint16

 :response error_code: uint8

 Appends an object to a list object and increases the reference count of the
 appended object by one.
 
 Returns the resulting error code.
 
.. modbus:function:: BrickRED.remove_from_list

 :functionid: 16
 :request list_id: uint16
 :request index: uint16

 :response error_code: uint8

 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.
 
.. modbus:function:: BrickRED.open_file

 :functionid: 17
 :request name_string_id: uint16
 :request flags: uint32
 :request permissions: uint16
 :request uid: uint32
 :request gid: uint32
 :request session_id: uint16

 :response error_code: uint8
 :response file_id: uint16

 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.
 
.. modbus:function:: BrickRED.create_pipe

 :functionid: 18
 :request flags: uint32
 :request length: uint64
 :request session_id: uint16

 :response error_code: uint8
 :response file_id: uint16

 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.
 
.. modbus:function:: BrickRED.get_file_info

 :functionid: 19
 :request file_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response type: uint8
 :response name_string_id: uint16
 :response flags: uint32
 :response permissions: uint16
 :response uid: uint32
 :response gid: uint32
 :response length: uint64
 :response access_timestamp: uint64
 :response modification_timestamp: uint64
 :response status_change_timestamp: uint64

 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 :modbus:func:`open_file <BrickRED.open_file>`.
 
 The returned flags were used to open or create the file object, as passed to
 :modbus:func:`open_file <BrickRED.open_file>` or :modbus:func:`create_pipe <BrickRED.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*
 
.. modbus:function:: BrickRED.read_file

 :functionid: 20
 :request file_id: uint16
 :request length_to_read: uint8

 :response error_code: uint8
 :response buffer: uint8[62]
 :response length_read: uint8

 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 :modbus:func:`open_file <BrickRED.open_file>` without the *NonBlocking*
 flag or by :modbus:func:`create_pipe <BrickRED.create_pipe>` without the *NonBlockingRead* flag then the
 error code *NotSupported* is returned.
 
.. modbus:function:: BrickRED.read_file_async

 :functionid: 21
 :request file_id: uint16
 :request length_to_read: uint64

 :noresponse: no response

 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 :modbus:func:`CALLBACK_ASYNC_FILE_READ <BrickRED.CALLBACK_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 :modbus:func:`open_file <BrickRED.open_file>` without the *NonBlocking*
 flag or by :modbus:func:`create_pipe <BrickRED.create_pipe>` without the *NonBlockingRead* flag then the error
 code *NotSupported* is reported via the :modbus:func:`CALLBACK_ASYNC_FILE_READ <BrickRED.CALLBACK_ASYNC_FILE_READ>` callback.
 
.. modbus:function:: BrickRED.abort_async_file_read

 :functionid: 22
 :request file_id: uint16

 :response error_code: uint8

 Aborts a :modbus:func:`read_file_async <BrickRED.read_file_async>` operation in progress.
 
 Returns the resulting error code.
 
 On success the :modbus:func:`CALLBACK_ASYNC_FILE_READ <BrickRED.CALLBACK_ASYNC_FILE_READ>` callback will report *OperationAborted*.
 
.. modbus:function:: BrickRED.write_file

 :functionid: 23
 :request file_id: uint16
 :request buffer: uint8[61]
 :request length_to_write: uint8

 :response error_code: uint8
 :response length_written: uint8

 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 :modbus:func:`open_file <BrickRED.open_file>` without the *NonBlocking*
 flag or by :modbus:func:`create_pipe <BrickRED.create_pipe>` without the *NonBlockingWrite* flag then the
 error code *NotSupported* is returned.
 
.. modbus:function:: BrickRED.write_file_unchecked

 :functionid: 24
 :request file_id: uint16
 :request buffer: uint8[61]
 :request length_to_write: uint8

 :noresponse: no response

 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 :modbus:func:`open_file <BrickRED.open_file>` without the *NonBlocking*
 flag or by :modbus:func:`create_pipe <BrickRED.create_pipe>` without the *NonBlockingWrite* flag then the
 write operation will fail silently.
 
.. modbus:function:: BrickRED.write_file_async

 :functionid: 25
 :request file_id: uint16
 :request buffer: uint8[61]
 :request length_to_write: uint8

 :noresponse: no response

 Writes up to 61 bytes to a file object.
 
 Reports the actual number of bytes written and the resulting error code via the
 :modbus:func:`CALLBACK_ASYNC_FILE_WRITE <BrickRED.CALLBACK_ASYNC_FILE_WRITE>` callback.
 
 If the file object was created by :modbus:func:`open_file <BrickRED.open_file>` without the *NonBlocking*
 flag or by :modbus:func:`create_pipe <BrickRED.create_pipe>` without the *NonBlockingWrite* flag then the
 error code *NotSupported* is reported via the :modbus:func:`CALLBACK_ASYNC_FILE_WRITE <BrickRED.CALLBACK_ASYNC_FILE_WRITE>` callback.
 
.. modbus:function:: BrickRED.set_file_position

 :functionid: 26
 :request file_id: uint16
 :request offset: int64
 :request origin: uint8

 :response error_code: uint8
 :response position: uint64

 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 :modbus:func:`create_pipe <BrickRED.create_pipe>` then it has no seek
 position and the error code *InvalidSeek* is returned.
 
.. modbus:function:: BrickRED.get_file_position

 :functionid: 27
 :request file_id: uint16

 :response error_code: uint8
 :response position: uint64

 Returns the current seek position of a file object in bytes and returns the
 resulting error code.
 
 If the file object was created by :modbus:func:`create_pipe <BrickRED.create_pipe>` then it has no seek
 position and the error code *InvalidSeek* is returned.
 
.. modbus:function:: BrickRED.set_file_events

 :functionid: 28
 :request file_id: uint16
 :request events: uint16

 :response error_code: uint8

 
.. modbus:function:: BrickRED.get_file_events

 :functionid: 29
 :request file_id: uint16

 :response error_code: uint8
 :response events: uint16

 
.. modbus:function:: BrickRED.open_directory

 :functionid: 33
 :request name_string_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response directory_id: uint16

 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.
 
.. modbus:function:: BrickRED.get_directory_name

 :functionid: 34
 :request directory_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response name_string_id: uint16

 Returns the name of a directory object, as passed to :modbus:func:`open_directory <BrickRED.open_directory>`, and
 the resulting error code.
 
.. modbus:function:: BrickRED.get_next_directory_entry

 :functionid: 35
 :request directory_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response name_string_id: uint16
 :response type: uint8

 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 :modbus:func:`rewind_directory <BrickRED.rewind_directory>`.
 
 Possible directory entry types are:
 
 * Unknown = 0
 * Regular = 1
 * Directory = 2
 * Character = 3
 * Block = 4
 * FIFO = 5
 * Symlink = 6
 * Socket = 7
 
.. modbus:function:: BrickRED.rewind_directory

 :functionid: 36
 :request directory_id: uint16

 :response error_code: uint8

 Rewinds a directory object and returns the resulting error code.
 
.. modbus:function:: BrickRED.create_directory

 :functionid: 37
 :request name_string_id: uint16
 :request flags: uint32
 :request permissions: uint16
 :request uid: uint32
 :request gid: uint32

 :response error_code: uint8

 FIXME: name has to be absolute
 
.. modbus:function:: BrickRED.get_processes

 :functionid: 38
 :request session_id: uint16

 :response error_code: uint8
 :response processes_list_id: uint16

 
.. modbus:function:: BrickRED.spawn_process

 :functionid: 39
 :request executable_string_id: uint16
 :request arguments_list_id: uint16
 :request environment_list_id: uint16
 :request working_directory_string_id: uint16
 :request uid: uint32
 :request gid: uint32
 :request stdin_file_id: uint16
 :request stdout_file_id: uint16
 :request stderr_file_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response process_id: uint16

 
.. modbus:function:: BrickRED.kill_process

 :functionid: 40
 :request process_id: uint16
 :request signal: uint8

 :response error_code: uint8

 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
 
.. modbus:function:: BrickRED.get_process_command

 :functionid: 41
 :request process_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response executable_string_id: uint16
 :response arguments_list_id: uint16
 :response environment_list_id: uint16
 :response working_directory_string_id: uint16

 Returns the executable, arguments, environment and working directory used to
 spawn a process object, as passed to :modbus:func:`spawn_process <BrickRED.spawn_process>`, and the resulting
 error code.
 
.. modbus:function:: BrickRED.get_process_identity

 :functionid: 42
 :request process_id: uint16

 :response error_code: uint8
 :response pid: uint32
 :response uid: uint32
 :response gid: uint32

 Returns the process ID and the user and group ID used to spawn a process object,
 as passed to :modbus:func:`spawn_process <BrickRED.spawn_process>`, and the resulting error code.
 
 The process ID is only valid if the state is *Running* or *Stopped*, see
 :modbus:func:`get_process_state <BrickRED.get_process_state>`.
 
.. modbus:function:: BrickRED.get_process_stdio

 :functionid: 43
 :request process_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response stdin_file_id: uint16
 :response stdout_file_id: uint16
 :response stderr_file_id: uint16

 Returns the stdin, stdout and stderr files used to spawn a process object, as
 passed to :modbus:func:`spawn_process <BrickRED.spawn_process>`, and the resulting error code.
 
.. modbus:function:: BrickRED.get_process_state

 :functionid: 44
 :request process_id: uint16

 :response error_code: uint8
 :response state: uint8
 :response timestamp: uint64
 :response exit_code: uint8

 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.
 
.. modbus:function:: BrickRED.get_programs

 :functionid: 46
 :request session_id: uint16

 :response error_code: uint8
 :response programs_list_id: uint16

 
.. modbus:function:: BrickRED.define_program

 :functionid: 47
 :request identifier_string_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response program_id: uint16

 
.. modbus:function:: BrickRED.purge_program

 :functionid: 48
 :request program_id: uint16
 :request cookie: uint32

 :response error_code: uint8

 
.. modbus:function:: BrickRED.get_program_identifier

 :functionid: 49
 :request program_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response identifier_string_id: uint16

 
.. modbus:function:: BrickRED.get_program_root_directory

 :functionid: 50
 :request program_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response root_directory_string_id: uint16

 FIXME: root directory is absolute: <home>/programs/<identifier>
 
.. modbus:function:: BrickRED.set_program_command

 :functionid: 51
 :request program_id: uint16
 :request executable_string_id: uint16
 :request arguments_list_id: uint16
 :request environment_list_id: uint16
 :request working_directory_string_id: uint16

 :response error_code: uint8

 FIXME: working directory is relative to <home>/programs/<identifier>/bin
 
.. modbus:function:: BrickRED.get_program_command

 :functionid: 52
 :request program_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response executable_string_id: uint16
 :response arguments_list_id: uint16
 :response environment_list_id: uint16
 :response working_directory_string_id: uint16

 FIXME: working directory is relative to <home>/programs/<identifier>/bin
 
.. modbus:function:: BrickRED.set_program_stdio_redirection

 :functionid: 53
 :request program_id: uint16
 :request stdin_redirection: uint8
 :request stdin_file_name_string_id: uint16
 :request stdout_redirection: uint8
 :request stdout_file_name_string_id: uint16
 :request stderr_redirection: uint8
 :request stderr_file_name_string_id: uint16

 :response error_code: uint8

 FIXME: stdio file names are relative to <home>/programs/<identifier>/bin
 
.. modbus:function:: BrickRED.get_program_stdio_redirection

 :functionid: 54
 :request program_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response stdin_redirection: uint8
 :response stdin_file_name_string_id: uint16
 :response stdout_redirection: uint8
 :response stdout_file_name_string_id: uint16
 :response stderr_redirection: uint8
 :response stderr_file_name_string_id: uint16

 FIXME: stdio file names are relative to <home>/programs/<identifier>/bin
 
.. modbus:function:: BrickRED.set_program_schedule

 :functionid: 55
 :request program_id: uint16
 :request start_mode: uint8
 :request continue_after_error: bool
 :request start_interval: uint32
 :request start_fields_string_id: uint16

 :response error_code: uint8

 
.. modbus:function:: BrickRED.get_program_schedule

 :functionid: 56
 :request program_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response start_mode: uint8
 :response continue_after_error: bool
 :response start_interval: uint32
 :response start_fields_string_id: uint16

 
.. modbus:function:: BrickRED.get_program_scheduler_state

 :functionid: 57
 :request program_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response state: uint8
 :response timestamp: uint64
 :response message_string_id: uint16

 FIXME: message is currently valid in error-occurred state only
 
.. modbus:function:: BrickRED.continue_program_schedule

 :functionid: 58
 :request program_id: uint16

 :response error_code: uint8

 
.. modbus:function:: BrickRED.start_program

 :functionid: 59
 :request program_id: uint16

 :response error_code: uint8

 
.. modbus:function:: BrickRED.get_last_spawned_program_process

 :functionid: 60
 :request program_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response process_id: uint16
 :response timestamp: uint64

 
.. modbus:function:: BrickRED.get_custom_program_option_names

 :functionid: 61
 :request program_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response names_list_id: uint16

 
.. modbus:function:: BrickRED.set_custom_program_option_value

 :functionid: 62
 :request program_id: uint16
 :request name_string_id: uint16
 :request value_string_id: uint16

 :response error_code: uint8

 
.. modbus:function:: BrickRED.get_custom_program_option_value

 :functionid: 63
 :request program_id: uint16
 :request name_string_id: uint16
 :request session_id: uint16

 :response error_code: uint8
 :response value_string_id: uint16

 
.. modbus:function:: BrickRED.remove_custom_program_option

 :functionid: 64
 :request program_id: uint16
 :request name_string_id: uint16

 :response error_code: uint8

 
.. modbus:function:: BrickRED.get_identity

 :functionid: 255
 :emptyrequest: empty payload

 :response uid: char[8]
 :response connected_uid: char[8]
 :response position: char
 :response hardware_version: uint8[3]
 :response firmware_version: uint8[3]
 :response device_identifier: uint16

 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_modbus_callbacks:

Callbacks
^^^^^^^^^

.. modbus:function:: BrickRED.CALLBACK_ASYNC_FILE_READ

 :functionid: 30

 :response file_id: uint16
 :response error_code: uint8
 :response buffer: uint8[60]
 :response length_read: uint8


 This callback reports the result of a call to the :modbus:func:`read_file_async <BrickRED.read_file_async>`
 function.
 
.. modbus:function:: BrickRED.CALLBACK_ASYNC_FILE_WRITE

 :functionid: 31

 :response file_id: uint16
 :response error_code: uint8
 :response length_written: uint8


 This callback reports the result of a call to the :modbus:func:`write_file_async <BrickRED.write_file_async>`
 function.
 
.. modbus:function:: BrickRED.CALLBACK_FILE_EVENTS_OCCURRED

 :functionid: 32

 :response file_id: uint16
 :response events: uint16


 
.. modbus:function:: BrickRED.CALLBACK_PROCESS_STATE_CHANGED

 :functionid: 45

 :response process_id: uint16
 :response state: uint8
 :response timestamp: uint64
 :response exit_code: uint8


 
.. modbus:function:: BrickRED.CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED

 :functionid: 65

 :response program_id: uint16


 
.. modbus:function:: BrickRED.CALLBACK_PROGRAM_PROCESS_SPAWNED

 :functionid: 66

 :response program_id: uint16


 


