tinkerforge 2.1.3 → 2.1.4

data/lib/tinkerforge/brick_dc.rb

@@ -2,7 +2,7 @@
 #############################################################
 # This file was automatically generated on 2014-12-10.      #
 #                                                           #
-# Bindings Version 2.1.3                                    #
+# Bindings Version 2.1.4                                    #
 #                                                           #
 # 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  #

data/lib/tinkerforge/brick_imu.rb

@@ -2,7 +2,7 @@
 #############################################################
 # This file was automatically generated on 2014-12-10.      #
 #                                                           #
-# Bindings Version 2.1.3                                    #
+# Bindings Version 2.1.4                                    #
 #                                                           #
 # 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  #

data/lib/tinkerforge/brick_master.rb

@@ -2,7 +2,7 @@
 #############################################################
 # This file was automatically generated on 2014-12-10.      #
 #                                                           #
-# Bindings Version 2.1.3                                    #
+# Bindings Version 2.1.4                                    #
 #                                                           #
 # 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  #

data/lib/tinkerforge/brick_red.rb

@@ -0,0 +1,821 @@
+# -*- ruby encoding: utf-8 -*-
+#############################################################
+# This file was automatically generated on 2014-12-10.      #
+#                                                           #
+# Bindings Version 2.1.4                                    #
+#                                                           #
+# 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 generator git on tinkerforge.com                   #
+#############################################################
+
+module Tinkerforge
+  # Device for running user programs standalone on the stack
+  class BrickRED < Device
+    DEVICE_IDENTIFIER = 17 # :nodoc:
+
+    # This callback reports the result of a call to the BrickRED#read_file_async
+    # function.
+    CALLBACK_ASYNC_FILE_READ = 30
+
+    # This callback reports the result of a call to the BrickRED#write_file_async
+    # function.
+    CALLBACK_ASYNC_FILE_WRITE = 31
+
+    # 
+    CALLBACK_FILE_EVENTS_OCCURRED = 32
+
+    # 
+    CALLBACK_PROCESS_STATE_CHANGED = 45
+
+    # 
+    CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED = 65
+
+    # 
+    CALLBACK_PROGRAM_PROCESS_SPAWNED = 66
+
+    FUNCTION_CREATE_SESSION = 1 # :nodoc:
+    FUNCTION_EXPIRE_SESSION = 2 # :nodoc:
+    FUNCTION_EXPIRE_SESSION_UNCHECKED = 3 # :nodoc:
+    FUNCTION_KEEP_SESSION_ALIVE = 4 # :nodoc:
+    FUNCTION_RELEASE_OBJECT = 5 # :nodoc:
+    FUNCTION_RELEASE_OBJECT_UNCHECKED = 6 # :nodoc:
+    FUNCTION_ALLOCATE_STRING = 7 # :nodoc:
+    FUNCTION_TRUNCATE_STRING = 8 # :nodoc:
+    FUNCTION_GET_STRING_LENGTH = 9 # :nodoc:
+    FUNCTION_SET_STRING_CHUNK = 10 # :nodoc:
+    FUNCTION_GET_STRING_CHUNK = 11 # :nodoc:
+    FUNCTION_ALLOCATE_LIST = 12 # :nodoc:
+    FUNCTION_GET_LIST_LENGTH = 13 # :nodoc:
+    FUNCTION_GET_LIST_ITEM = 14 # :nodoc:
+    FUNCTION_APPEND_TO_LIST = 15 # :nodoc:
+    FUNCTION_REMOVE_FROM_LIST = 16 # :nodoc:
+    FUNCTION_OPEN_FILE = 17 # :nodoc:
+    FUNCTION_CREATE_PIPE = 18 # :nodoc:
+    FUNCTION_GET_FILE_INFO = 19 # :nodoc:
+    FUNCTION_READ_FILE = 20 # :nodoc:
+    FUNCTION_READ_FILE_ASYNC = 21 # :nodoc:
+    FUNCTION_ABORT_ASYNC_FILE_READ = 22 # :nodoc:
+    FUNCTION_WRITE_FILE = 23 # :nodoc:
+    FUNCTION_WRITE_FILE_UNCHECKED = 24 # :nodoc:
+    FUNCTION_WRITE_FILE_ASYNC = 25 # :nodoc:
+    FUNCTION_SET_FILE_POSITION = 26 # :nodoc:
+    FUNCTION_GET_FILE_POSITION = 27 # :nodoc:
+    FUNCTION_SET_FILE_EVENTS = 28 # :nodoc:
+    FUNCTION_GET_FILE_EVENTS = 29 # :nodoc:
+    FUNCTION_OPEN_DIRECTORY = 33 # :nodoc:
+    FUNCTION_GET_DIRECTORY_NAME = 34 # :nodoc:
+    FUNCTION_GET_NEXT_DIRECTORY_ENTRY = 35 # :nodoc:
+    FUNCTION_REWIND_DIRECTORY = 36 # :nodoc:
+    FUNCTION_CREATE_DIRECTORY = 37 # :nodoc:
+    FUNCTION_GET_PROCESSES = 38 # :nodoc:
+    FUNCTION_SPAWN_PROCESS = 39 # :nodoc:
+    FUNCTION_KILL_PROCESS = 40 # :nodoc:
+    FUNCTION_GET_PROCESS_COMMAND = 41 # :nodoc:
+    FUNCTION_GET_PROCESS_IDENTITY = 42 # :nodoc:
+    FUNCTION_GET_PROCESS_STDIO = 43 # :nodoc:
+    FUNCTION_GET_PROCESS_STATE = 44 # :nodoc:
+    FUNCTION_GET_PROGRAMS = 46 # :nodoc:
+    FUNCTION_DEFINE_PROGRAM = 47 # :nodoc:
+    FUNCTION_PURGE_PROGRAM = 48 # :nodoc:
+    FUNCTION_GET_PROGRAM_IDENTIFIER = 49 # :nodoc:
+    FUNCTION_GET_PROGRAM_ROOT_DIRECTORY = 50 # :nodoc:
+    FUNCTION_SET_PROGRAM_COMMAND = 51 # :nodoc:
+    FUNCTION_GET_PROGRAM_COMMAND = 52 # :nodoc:
+    FUNCTION_SET_PROGRAM_STDIO_REDIRECTION = 53 # :nodoc:
+    FUNCTION_GET_PROGRAM_STDIO_REDIRECTION = 54 # :nodoc:
+    FUNCTION_SET_PROGRAM_SCHEDULE = 55 # :nodoc:
+    FUNCTION_GET_PROGRAM_SCHEDULE = 56 # :nodoc:
+    FUNCTION_GET_PROGRAM_SCHEDULER_STATE = 57 # :nodoc:
+    FUNCTION_CONTINUE_PROGRAM_SCHEDULE = 58 # :nodoc:
+    FUNCTION_START_PROGRAM = 59 # :nodoc:
+    FUNCTION_GET_LAST_SPAWNED_PROGRAM_PROCESS = 60 # :nodoc:
+    FUNCTION_GET_CUSTOM_PROGRAM_OPTION_NAMES = 61 # :nodoc:
+    FUNCTION_SET_CUSTOM_PROGRAM_OPTION_VALUE = 62 # :nodoc:
+    FUNCTION_GET_CUSTOM_PROGRAM_OPTION_VALUE = 63 # :nodoc:
+    FUNCTION_REMOVE_CUSTOM_PROGRAM_OPTION = 64 # :nodoc:
+    FUNCTION_GET_IDENTITY = 255 # :nodoc:
+
+    OBJECT_TYPE_STRING = 0 # :nodoc:
+    OBJECT_TYPE_LIST = 1 # :nodoc:
+    OBJECT_TYPE_FILE = 2 # :nodoc:
+    OBJECT_TYPE_DIRECTORY = 3 # :nodoc:
+    OBJECT_TYPE_PROCESS = 4 # :nodoc:
+    OBJECT_TYPE_PROGRAM = 5 # :nodoc:
+    FILE_FLAG_READ_ONLY = 1 # :nodoc:
+    FILE_FLAG_WRITE_ONLY = 2 # :nodoc:
+    FILE_FLAG_READ_WRITE = 4 # :nodoc:
+    FILE_FLAG_APPEND = 8 # :nodoc:
+    FILE_FLAG_CREATE = 16 # :nodoc:
+    FILE_FLAG_EXCLUSIVE = 32 # :nodoc:
+    FILE_FLAG_NON_BLOCKING = 64 # :nodoc:
+    FILE_FLAG_TRUNCATE = 128 # :nodoc:
+    FILE_FLAG_TEMPORARY = 256 # :nodoc:
+    FILE_FLAG_REPLACE = 512 # :nodoc:
+    FILE_PERMISSION_USER_ALL = 448 # :nodoc:
+    FILE_PERMISSION_USER_READ = 256 # :nodoc:
+    FILE_PERMISSION_USER_WRITE = 128 # :nodoc:
+    FILE_PERMISSION_USER_EXECUTE = 64 # :nodoc:
+    FILE_PERMISSION_GROUP_ALL = 56 # :nodoc:
+    FILE_PERMISSION_GROUP_READ = 32 # :nodoc:
+    FILE_PERMISSION_GROUP_WRITE = 16 # :nodoc:
+    FILE_PERMISSION_GROUP_EXECUTE = 8 # :nodoc:
+    FILE_PERMISSION_OTHERS_ALL = 7 # :nodoc:
+    FILE_PERMISSION_OTHERS_READ = 4 # :nodoc:
+    FILE_PERMISSION_OTHERS_WRITE = 2 # :nodoc:
+    FILE_PERMISSION_OTHERS_EXECUTE = 1 # :nodoc:
+    PIPE_FLAG_NON_BLOCKING_READ = 1 # :nodoc:
+    PIPE_FLAG_NON_BLOCKING_WRITE = 2 # :nodoc:
+    FILE_TYPE_UNKNOWN = 0 # :nodoc:
+    FILE_TYPE_REGULAR = 1 # :nodoc:
+    FILE_TYPE_DIRECTORY = 2 # :nodoc:
+    FILE_TYPE_CHARACTER = 3 # :nodoc:
+    FILE_TYPE_BLOCK = 4 # :nodoc:
+    FILE_TYPE_FIFO = 5 # :nodoc:
+    FILE_TYPE_SYMLINK = 6 # :nodoc:
+    FILE_TYPE_SOCKET = 7 # :nodoc:
+    FILE_TYPE_PIPE = 8 # :nodoc:
+    FILE_ORIGIN_BEGINNING = 0 # :nodoc:
+    FILE_ORIGIN_CURRENT = 1 # :nodoc:
+    FILE_ORIGIN_END = 2 # :nodoc:
+    FILE_EVENT_READABLE = 1 # :nodoc:
+    FILE_EVENT_WRITABLE = 2 # :nodoc:
+    DIRECTORY_ENTRY_TYPE_UNKNOWN = 0 # :nodoc:
+    DIRECTORY_ENTRY_TYPE_REGULAR = 1 # :nodoc:
+    DIRECTORY_ENTRY_TYPE_DIRECTORY = 2 # :nodoc:
+    DIRECTORY_ENTRY_TYPE_CHARACTER = 3 # :nodoc:
+    DIRECTORY_ENTRY_TYPE_BLOCK = 4 # :nodoc:
+    DIRECTORY_ENTRY_TYPE_FIFO = 5 # :nodoc:
+    DIRECTORY_ENTRY_TYPE_SYMLINK = 6 # :nodoc:
+    DIRECTORY_ENTRY_TYPE_SOCKET = 7 # :nodoc:
+    DIRECTORY_FLAG_RECURSIVE = 1 # :nodoc:
+    DIRECTORY_FLAG_EXCLUSIVE = 2 # :nodoc:
+    PROCESS_SIGNAL_INTERRUPT = 2 # :nodoc:
+    PROCESS_SIGNAL_QUIT = 3 # :nodoc:
+    PROCESS_SIGNAL_ABORT = 6 # :nodoc:
+    PROCESS_SIGNAL_KILL = 9 # :nodoc:
+    PROCESS_SIGNAL_USER1 = 10 # :nodoc:
+    PROCESS_SIGNAL_USER2 = 12 # :nodoc:
+    PROCESS_SIGNAL_TERMINATE = 15 # :nodoc:
+    PROCESS_SIGNAL_CONTINUE = 18 # :nodoc:
+    PROCESS_SIGNAL_STOP = 19 # :nodoc:
+    PROCESS_STATE_UNKNOWN = 0 # :nodoc:
+    PROCESS_STATE_RUNNING = 1 # :nodoc:
+    PROCESS_STATE_ERROR = 2 # :nodoc:
+    PROCESS_STATE_EXITED = 3 # :nodoc:
+    PROCESS_STATE_KILLED = 4 # :nodoc:
+    PROCESS_STATE_STOPPED = 5 # :nodoc:
+    PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0 # :nodoc:
+    PROGRAM_STDIO_REDIRECTION_PIPE = 1 # :nodoc:
+    PROGRAM_STDIO_REDIRECTION_FILE = 2 # :nodoc:
+    PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3 # :nodoc:
+    PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4 # :nodoc:
+    PROGRAM_STDIO_REDIRECTION_STDOUT = 5 # :nodoc:
+    PROGRAM_START_MODE_NEVER = 0 # :nodoc:
+    PROGRAM_START_MODE_ALWAYS = 1 # :nodoc:
+    PROGRAM_START_MODE_INTERVAL = 2 # :nodoc:
+    PROGRAM_START_MODE_CRON = 3 # :nodoc:
+    PROGRAM_SCHEDULER_STATE_STOPPED = 0 # :nodoc:
+    PROGRAM_SCHEDULER_STATE_RUNNING = 1 # :nodoc:
+
+    # Creates an object with the unique device ID <tt>uid</tt> and adds it to
+    # the IP Connection <tt>ipcon</tt>.
+    def initialize(uid, ipcon)
+      super uid, ipcon
+
+      @api_version = [2, 0, 0]
+
+      @response_expected[FUNCTION_CREATE_SESSION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_EXPIRE_SESSION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_EXPIRE_SESSION_UNCHECKED] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_KEEP_SESSION_ALIVE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_RELEASE_OBJECT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_RELEASE_OBJECT_UNCHECKED] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_ALLOCATE_STRING] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_TRUNCATE_STRING] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_STRING_LENGTH] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_STRING_CHUNK] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_STRING_CHUNK] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_ALLOCATE_LIST] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_LIST_LENGTH] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_LIST_ITEM] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_APPEND_TO_LIST] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_REMOVE_FROM_LIST] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_OPEN_FILE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_CREATE_PIPE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_FILE_INFO] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_READ_FILE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_READ_FILE_ASYNC] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_ABORT_ASYNC_FILE_READ] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_WRITE_FILE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_WRITE_FILE_UNCHECKED] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_WRITE_FILE_ASYNC] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_SET_FILE_POSITION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_FILE_POSITION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_FILE_EVENTS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_FILE_EVENTS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_ASYNC_FILE_READ] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_ASYNC_FILE_WRITE] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_FILE_EVENTS_OCCURRED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_OPEN_DIRECTORY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_DIRECTORY_NAME] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_NEXT_DIRECTORY_ENTRY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_REWIND_DIRECTORY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_CREATE_DIRECTORY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROCESSES] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SPAWN_PROCESS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_KILL_PROCESS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROCESS_COMMAND] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROCESS_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROCESS_STDIO] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROCESS_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_PROCESS_STATE_CHANGED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_PROGRAMS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_DEFINE_PROGRAM] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_PURGE_PROGRAM] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROGRAM_IDENTIFIER] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROGRAM_ROOT_DIRECTORY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_PROGRAM_COMMAND] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROGRAM_COMMAND] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_PROGRAM_STDIO_REDIRECTION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROGRAM_STDIO_REDIRECTION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_PROGRAM_SCHEDULE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROGRAM_SCHEDULE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_PROGRAM_SCHEDULER_STATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_CONTINUE_PROGRAM_SCHEDULE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_START_PROGRAM] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_LAST_SPAWNED_PROGRAM_PROCESS] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_CUSTOM_PROGRAM_OPTION_NAMES] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_CUSTOM_PROGRAM_OPTION_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_CUSTOM_PROGRAM_OPTION_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_REMOVE_CUSTOM_PROGRAM_OPTION] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[CALLBACK_PROGRAM_PROCESS_SPAWNED] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
+
+      @callback_formats[CALLBACK_ASYNC_FILE_READ] = 'S C C60 C'
+      @callback_formats[CALLBACK_ASYNC_FILE_WRITE] = 'S C C'
+      @callback_formats[CALLBACK_FILE_EVENTS_OCCURRED] = 'S S'
+      @callback_formats[CALLBACK_PROCESS_STATE_CHANGED] = 'S C Q C'
+      @callback_formats[CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED] = 'S'
+      @callback_formats[CALLBACK_PROGRAM_PROCESS_SPAWNED] = 'S'
+    end
+
+    # 
+    def create_session(lifetime)
+      send_request(FUNCTION_CREATE_SESSION, [lifetime], 'L', 3, 'C S')
+    end
+
+    # 
+    def expire_session(session_id)
+      send_request(FUNCTION_EXPIRE_SESSION, [session_id], 'S', 1, 'C')
+    end
+
+    # 
+    def expire_session_unchecked(session_id)
+      send_request(FUNCTION_EXPIRE_SESSION_UNCHECKED, [session_id], 'S', 0, '')
+    end
+
+    # 
+    def keep_session_alive(session_id, lifetime)
+      send_request(FUNCTION_KEEP_SESSION_ALIVE, [session_id, lifetime], 'S L', 1, 'C')
+    end
+
+    # 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.
+    def release_object(object_id, session_id)
+      send_request(FUNCTION_RELEASE_OBJECT, [object_id, session_id], 'S S', 1, 'C')
+    end
+
+    # 
+    def release_object_unchecked(object_id, session_id)
+      send_request(FUNCTION_RELEASE_OBJECT_UNCHECKED, [object_id, session_id], 'S S', 0, '')
+    end
+
+    # 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.
+    def allocate_string(length_to_reserve, buffer, session_id)
+      send_request(FUNCTION_ALLOCATE_STRING, [length_to_reserve, buffer, session_id], 'L Z58 S', 3, 'C S')
+    end
+
+    # Truncates a string object to ``length`` bytes and returns the resulting
+    # error code.
+    def truncate_string(string_id, length)
+      send_request(FUNCTION_TRUNCATE_STRING, [string_id, length], 'S L', 1, 'C')
+    end
+
+    # Returns the length of a string object in bytes and the resulting error code.
+    def get_string_length(string_id)
+      send_request(FUNCTION_GET_STRING_LENGTH, [string_id], 'S', 5, 'C L')
+    end
+
+    # Sets a chunk of up to 58 bytes in a string object beginning at ``offset``.
+    # 
+    # Returns the resulting error code.
+    def set_string_chunk(string_id, offset, buffer)
+      send_request(FUNCTION_SET_STRING_CHUNK, [string_id, offset, buffer], 'S L Z58', 1, 'C')
+    end
+
+    # Returns a chunk up to 63 bytes from a string object beginning at ``offset`` and
+    # returns the resulting error code.
+    def get_string_chunk(string_id, offset)
+      send_request(FUNCTION_GET_STRING_CHUNK, [string_id, offset], 'S L', 64, 'C Z63')
+    end
+
+    # 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.
+    def allocate_list(length_to_reserve, session_id)
+      send_request(FUNCTION_ALLOCATE_LIST, [length_to_reserve, session_id], 'S S', 3, 'C S')
+    end
+
+    # Returns the length of a list object in items and the resulting error code.
+    def get_list_length(list_id)
+      send_request(FUNCTION_GET_LIST_LENGTH, [list_id], 'S', 3, 'C S')
+    end
+
+    # 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
+    def get_list_item(list_id, index, session_id)
+      send_request(FUNCTION_GET_LIST_ITEM, [list_id, index, session_id], 'S S S', 4, 'C S C')
+    end
+
+    # Appends an object to a list object and increases the reference count of the
+    # appended object by one.
+    # 
+    # Returns the resulting error code.
+    def append_to_list(list_id, item_object_id)
+      send_request(FUNCTION_APPEND_TO_LIST, [list_id, item_object_id], 'S S', 1, 'C')
+    end
+
+    # 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.
+    def remove_from_list(list_id, index)
+      send_request(FUNCTION_REMOVE_FROM_LIST, [list_id, index], 'S S', 1, 'C')
+    end
+
+    # 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.
+    def open_file(name_string_id, flags, permissions, uid, gid, session_id)
+      send_request(FUNCTION_OPEN_FILE, [name_string_id, flags, permissions, uid, gid, session_id], 'S L S L L S', 3, 'C S')
+    end
+
+    # 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.
+    def create_pipe(flags, length, session_id)
+      send_request(FUNCTION_CREATE_PIPE, [flags, length, session_id], 'L Q S', 3, 'C S')
+    end
+
+    # 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 BrickRED#open_file.
+    # 
+    # The returned flags were used to open or create the file object, as passed to
+    # BrickRED#open_file or 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*
+    def get_file_info(file_id, session_id)
+      send_request(FUNCTION_GET_FILE_INFO, [file_id, session_id], 'S S', 50, 'C C S L S L L Q Q Q Q')
+    end
+
+    # 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 BrickRED#open_file without the *NonBlocking*
+    # flag or by BrickRED#create_pipe without the *NonBlockingRead* flag then the
+    # error code *NotSupported* is returned.
+    def read_file(file_id, length_to_read)
+      send_request(FUNCTION_READ_FILE, [file_id, length_to_read], 'S C', 64, 'C C62 C')
+    end
+
+    # 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 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 BrickRED#open_file without the *NonBlocking*
+    # flag or by BrickRED#create_pipe without the *NonBlockingRead* flag then the error
+    # code *NotSupported* is reported via the CALLBACK_ASYNC_FILE_READ callback.
+    def read_file_async(file_id, length_to_read)
+      send_request(FUNCTION_READ_FILE_ASYNC, [file_id, length_to_read], 'S Q', 0, '')
+    end
+
+    # Aborts a BrickRED#read_file_async operation in progress.
+    # 
+    # Returns the resulting error code.
+    # 
+    # On success the CALLBACK_ASYNC_FILE_READ callback will report *OperationAborted*.
+    def abort_async_file_read(file_id)
+      send_request(FUNCTION_ABORT_ASYNC_FILE_READ, [file_id], 'S', 1, 'C')
+    end
+
+    # 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 BrickRED#open_file without the *NonBlocking*
+    # flag or by BrickRED#create_pipe without the *NonBlockingWrite* flag then the
+    # error code *NotSupported* is returned.
+    def write_file(file_id, buffer, length_to_write)
+      send_request(FUNCTION_WRITE_FILE, [file_id, buffer, length_to_write], 'S C61 C', 2, 'C C')
+    end
+
+    # 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 BrickRED#open_file without the *NonBlocking*
+    # flag or by BrickRED#create_pipe without the *NonBlockingWrite* flag then the
+    # write operation will fail silently.
+    def write_file_unchecked(file_id, buffer, length_to_write)
+      send_request(FUNCTION_WRITE_FILE_UNCHECKED, [file_id, buffer, length_to_write], 'S C61 C', 0, '')
+    end
+
+    # Writes up to 61 bytes to a file object.
+    # 
+    # Reports the actual number of bytes written and the resulting error code via the
+    # CALLBACK_ASYNC_FILE_WRITE callback.
+    # 
+    # If the file object was created by BrickRED#open_file without the *NonBlocking*
+    # flag or by BrickRED#create_pipe without the *NonBlockingWrite* flag then the
+    # error code *NotSupported* is reported via the CALLBACK_ASYNC_FILE_WRITE callback.
+    def write_file_async(file_id, buffer, length_to_write)
+      send_request(FUNCTION_WRITE_FILE_ASYNC, [file_id, buffer, length_to_write], 'S C61 C', 0, '')
+    end
+
+    # 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 BrickRED#create_pipe then it has no seek
+    # position and the error code *InvalidSeek* is returned.
+    def set_file_position(file_id, offset, origin)
+      send_request(FUNCTION_SET_FILE_POSITION, [file_id, offset, origin], 'S q C', 9, 'C Q')
+    end
+
+    # Returns the current seek position of a file object in bytes and returns the
+    # resulting error code.
+    # 
+    # If the file object was created by BrickRED#create_pipe then it has no seek
+    # position and the error code *InvalidSeek* is returned.
+    def get_file_position(file_id)
+      send_request(FUNCTION_GET_FILE_POSITION, [file_id], 'S', 9, 'C Q')
+    end
+
+    # 
+    def set_file_events(file_id, events)
+      send_request(FUNCTION_SET_FILE_EVENTS, [file_id, events], 'S S', 1, 'C')
+    end
+
+    # 
+    def get_file_events(file_id)
+      send_request(FUNCTION_GET_FILE_EVENTS, [file_id], 'S', 3, 'C S')
+    end
+
+    # 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.
+    def open_directory(name_string_id, session_id)
+      send_request(FUNCTION_OPEN_DIRECTORY, [name_string_id, session_id], 'S S', 3, 'C S')
+    end
+
+    # Returns the name of a directory object, as passed to BrickRED#open_directory, and
+    # the resulting error code.
+    def get_directory_name(directory_id, session_id)
+      send_request(FUNCTION_GET_DIRECTORY_NAME, [directory_id, session_id], 'S S', 3, 'C S')
+    end
+
+    # 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 BrickRED#rewind_directory.
+    # 
+    # Possible directory entry types are:
+    # 
+    # * Unknown = 0
+    # * Regular = 1
+    # * Directory = 2
+    # * Character = 3
+    # * Block = 4
+    # * FIFO = 5
+    # * Symlink = 6
+    # * Socket = 7
+    def get_next_directory_entry(directory_id, session_id)
+      send_request(FUNCTION_GET_NEXT_DIRECTORY_ENTRY, [directory_id, session_id], 'S S', 4, 'C S C')
+    end
+
+    # Rewinds a directory object and returns the resulting error code.
+    def rewind_directory(directory_id)
+      send_request(FUNCTION_REWIND_DIRECTORY, [directory_id], 'S', 1, 'C')
+    end
+
+    # FIXME: name has to be absolute
+    def create_directory(name_string_id, flags, permissions, uid, gid)
+      send_request(FUNCTION_CREATE_DIRECTORY, [name_string_id, flags, permissions, uid, gid], 'S L S L L', 1, 'C')
+    end
+
+    # 
+    def get_processes(session_id)
+      send_request(FUNCTION_GET_PROCESSES, [session_id], 'S', 3, 'C S')
+    end
+
+    # 
+    def 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)
+      send_request(FUNCTION_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], 'S S S S L L S S S S', 3, 'C S')
+    end
+
+    # 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
+    def kill_process(process_id, signal)
+      send_request(FUNCTION_KILL_PROCESS, [process_id, signal], 'S C', 1, 'C')
+    end
+
+    # Returns the executable, arguments, environment and working directory used to
+    # spawn a process object, as passed to BrickRED#spawn_process, and the resulting
+    # error code.
+    def get_process_command(process_id, session_id)
+      send_request(FUNCTION_GET_PROCESS_COMMAND, [process_id, session_id], 'S S', 9, 'C S S S S')
+    end
+
+    # Returns the process ID and the user and group ID used to spawn a process object,
+    # as passed to BrickRED#spawn_process, and the resulting error code.
+    # 
+    # The process ID is only valid if the state is *Running* or *Stopped*, see
+    # BrickRED#get_process_state.
+    def get_process_identity(process_id)
+      send_request(FUNCTION_GET_PROCESS_IDENTITY, [process_id], 'S', 13, 'C L L L')
+    end
+
+    # Returns the stdin, stdout and stderr files used to spawn a process object, as
+    # passed to BrickRED#spawn_process, and the resulting error code.
+    def get_process_stdio(process_id, session_id)
+      send_request(FUNCTION_GET_PROCESS_STDIO, [process_id, session_id], 'S S', 7, 'C S S S')
+    end
+
+    # 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.
+    def get_process_state(process_id)
+      send_request(FUNCTION_GET_PROCESS_STATE, [process_id], 'S', 11, 'C C Q C')
+    end
+
+    # 
+    def get_programs(session_id)
+      send_request(FUNCTION_GET_PROGRAMS, [session_id], 'S', 3, 'C S')
+    end
+
+    # 
+    def define_program(identifier_string_id, session_id)
+      send_request(FUNCTION_DEFINE_PROGRAM, [identifier_string_id, session_id], 'S S', 3, 'C S')
+    end
+
+    # 
+    def purge_program(program_id, cookie)
+      send_request(FUNCTION_PURGE_PROGRAM, [program_id, cookie], 'S L', 1, 'C')
+    end
+
+    # 
+    def get_program_identifier(program_id, session_id)
+      send_request(FUNCTION_GET_PROGRAM_IDENTIFIER, [program_id, session_id], 'S S', 3, 'C S')
+    end
+
+    # FIXME: root directory is absolute: <home>/programs/<identifier>
+    def get_program_root_directory(program_id, session_id)
+      send_request(FUNCTION_GET_PROGRAM_ROOT_DIRECTORY, [program_id, session_id], 'S S', 3, 'C S')
+    end
+
+    # FIXME: working directory is relative to <home>/programs/<identifier>/bin
+    def set_program_command(program_id, executable_string_id, arguments_list_id, environment_list_id, working_directory_string_id)
+      send_request(FUNCTION_SET_PROGRAM_COMMAND, [program_id, executable_string_id, arguments_list_id, environment_list_id, working_directory_string_id], 'S S S S S', 1, 'C')
+    end
+
+    # FIXME: working directory is relative to <home>/programs/<identifier>/bin
+    def get_program_command(program_id, session_id)
+      send_request(FUNCTION_GET_PROGRAM_COMMAND, [program_id, session_id], 'S S', 9, 'C S S S S')
+    end
+
+    # FIXME: stdio file names are relative to <home>/programs/<identifier>/bin
+    def 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)
+      send_request(FUNCTION_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], 'S C S C S C S', 1, 'C')
+    end
+
+    # FIXME: stdio file names are relative to <home>/programs/<identifier>/bin
+    def get_program_stdio_redirection(program_id, session_id)
+      send_request(FUNCTION_GET_PROGRAM_STDIO_REDIRECTION, [program_id, session_id], 'S S', 10, 'C C S C S C S')
+    end
+
+    # 
+    def set_program_schedule(program_id, start_mode, continue_after_error, start_interval, start_fields_string_id)
+      send_request(FUNCTION_SET_PROGRAM_SCHEDULE, [program_id, start_mode, continue_after_error, start_interval, start_fields_string_id], 'S C ? L S', 1, 'C')
+    end
+
+    # 
+    def get_program_schedule(program_id, session_id)
+      send_request(FUNCTION_GET_PROGRAM_SCHEDULE, [program_id, session_id], 'S S', 9, 'C C ? L S')
+    end
+
+    # FIXME: message is currently vaild in error-occurred state only
+    def get_program_scheduler_state(program_id, session_id)
+      send_request(FUNCTION_GET_PROGRAM_SCHEDULER_STATE, [program_id, session_id], 'S S', 12, 'C C Q S')
+    end
+
+    # 
+    def continue_program_schedule(program_id)
+      send_request(FUNCTION_CONTINUE_PROGRAM_SCHEDULE, [program_id], 'S', 1, 'C')
+    end
+
+    # 
+    def start_program(program_id)
+      send_request(FUNCTION_START_PROGRAM, [program_id], 'S', 1, 'C')
+    end
+
+    # 
+    def get_last_spawned_program_process(program_id, session_id)
+      send_request(FUNCTION_GET_LAST_SPAWNED_PROGRAM_PROCESS, [program_id, session_id], 'S S', 11, 'C S Q')
+    end
+
+    # 
+    def get_custom_program_option_names(program_id, session_id)
+      send_request(FUNCTION_GET_CUSTOM_PROGRAM_OPTION_NAMES, [program_id, session_id], 'S S', 3, 'C S')
+    end
+
+    # 
+    def set_custom_program_option_value(program_id, name_string_id, value_string_id)
+      send_request(FUNCTION_SET_CUSTOM_PROGRAM_OPTION_VALUE, [program_id, name_string_id, value_string_id], 'S S S', 1, 'C')
+    end
+
+    # 
+    def get_custom_program_option_value(program_id, name_string_id, session_id)
+      send_request(FUNCTION_GET_CUSTOM_PROGRAM_OPTION_VALUE, [program_id, name_string_id, session_id], 'S S S', 3, 'C S')
+    end
+
+    # 
+    def remove_custom_program_option(program_id, name_string_id)
+      send_request(FUNCTION_REMOVE_CUSTOM_PROGRAM_OPTION, [program_id, name_string_id], 'S S', 1, 'C')
+    end
+
+    # 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|
+    def get_identity
+      send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
+    end
+
+    # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.
+    def register_callback(id, &block)
+      callback = block
+      @registered_callbacks[id] = callback
+    end
+  end
+end