Python - RED Brick

Dies ist die Beschreibung der Python API Bindings für den RED Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RED Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Start Program

Download (example_start_program.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your RED Brick
PROGRAM = 'test' # Change to your program identifier

from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_red import BrickRED

def check_error(error_code, *args):
    if error_code != 0:
        print('RED Brick error occurred: {0}'.format(error_code))
        exit(1)

    if len(args) == 1:
        return args[0]

    return args

def start_program(red, identifier):
    # Create session and get program list
    session_id = check_error(*red.create_session(10))
    program_list_id = check_error(*red.get_programs(session_id))

    # Iterate program list to find the one to start
    started = False

    for i in range(check_error(*red.get_list_length(program_list_id))):
        program_id, _ = check_error(*red.get_list_item(program_list_id, i, session_id))

        # Get program identifier string
        string_id = check_error(*red.get_program_identifier(program_id, session_id))
        string_length = check_error(*red.get_string_length(string_id))
        string_data = ''

        while len(string_data) < string_length:
            string_data += check_error(*red.get_string_chunk(string_id, len(string_data)))

        check_error(red.release_object(string_id, session_id))

        # Check if this is the program to be started
        if string_data.decode('utf-8') == identifier:
            check_error(red.start_program(program_id))
            started = True

        check_error(red.release_object(program_id, session_id))

        if started:
            break

    check_error(red.release_object(program_list_id, session_id))
    check_error(red.expire_session(session_id))

    return started

if __name__ == '__main__':
    ipcon = IPConnection() # Create IP connection
    red = BrickRED(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    if start_program(red, PROGRAM):
        print('Started RED Brick program: {0}'.format(PROGRAM))
    else:
        print('RED Brick program not found: {0}'.format(PROGRAM))

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Read File

Download (example_read_file.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your RED Brick
REMOTE_PATH = '/home/tf/foobar.txt' # Change to your remote path
LOCAL_PATH = 'foobar.txt' # Change to your local path

import sys
from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_red import BrickRED

def check_error(error_code, *args):
    if error_code != 0:
        raise Exception('RED Brick error occurred: {0}'.format(error_code))

    if len(args) == 1:
        return args[0]

    return args

def allocate_string(red, string, session_id):
    string_id = check_error(*red.allocate_string(len(string), string[:58], session_id))

    for offset in range(58, len(string), 58):
        check_error(red.set_string_chunk(string_id, offset, string[offset:offset + 58]))

    return string_id

def read_file(red, remote_path, local_path):
    # Create session
    session_id = check_error(*red.create_session(60))

    # Create remote non-executable file for writing as user/group tf
    remote_path_id = allocate_string(red, remote_path, session_id)
    remote_file_id = check_error(*red.open_file(remote_path_id,
                                                BrickRED.FILE_FLAG_READ_ONLY |
                                                BrickRED.FILE_FLAG_NON_BLOCKING,
                                                0, 0, 0, session_id))

    check_error(red.release_object(remote_path_id, session_id))

    # Open local file for writing
    local_file = open(local_path, 'wb')

    # Read remote file and write to local file
    transferred = 0

    while True:
        data, length_read = check_error(*red.read_file(remote_file_id, 61))
        data = data[:length_read]

        if len(data) == 0:
            break

        if sys.version_info[0] > 2:
            local_file.write(bytes(data))
        else:
            local_file.write(''.join(map(chr, data)))

        check_error(red.keep_session_alive(session_id, 30))

        transferred += length_read

    # Close local file
    local_file.close()

    # Close remote file
    check_error(red.release_object(remote_file_id, session_id))

    # Expire session
    check_error(red.expire_session(session_id))

    print('{0} bytes transferred'.format(transferred))

if __name__ == '__main__':
    ipcon = IPConnection() # Create IP connection
    red = BrickRED(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    read_file(red, REMOTE_PATH, LOCAL_PATH)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Write File

Download (example_write_file.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your RED Brick
LOCAL_PATH = 'foobar.txt' # Change to your local path
REMOTE_PATH = '/home/tf/foobar.txt' # Change to your remote path

import sys
from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_red import BrickRED

def check_error(error_code, *args):
    if error_code != 0:
        raise Exception('RED Brick error occurred: {0}'.format(error_code))

    if len(args) == 1:
        return args[0]

    return args

def allocate_string(red, string, session_id):
    string_id = check_error(*red.allocate_string(len(string), string[:58], session_id))

    for offset in range(58, len(string), 58):
        check_error(red.set_string_chunk(string_id, offset, string[offset:offset + 58]))

    return string_id

def write_file(red, local_path, remote_path):
    # Open local file for reading
    local_file = open(local_path, 'rb')

    # Create session
    session_id = check_error(*red.create_session(60))

    # Create remote non-executable file for writing as user/group tf
    remote_path_id = allocate_string(red, remote_path, session_id)
    remote_file_id = check_error(*red.open_file(remote_path_id,
                                                BrickRED.FILE_FLAG_WRITE_ONLY |
                                                BrickRED.FILE_FLAG_CREATE |
                                                BrickRED.FILE_FLAG_TRUNCATE |
                                                BrickRED.FILE_FLAG_NON_BLOCKING,
                                                0o644, 1000, 1000, session_id))

    check_error(red.release_object(remote_path_id, session_id))

    # Read local file and write to remote file
    transferred = 0

    while True:
        data = list(local_file.read(61))

        if sys.version_info[0] < 3:
            data = map(ord, data)

        if len(data) == 0:
            break

        length_to_write = len(data)
        data += [0] * (61 - length_to_write)
        length_written = check_error(*red.write_file(remote_file_id, data, length_to_write))

        if length_written != length_to_write:
            print('Short write')
            exit(1)

        check_error(red.keep_session_alive(session_id, 30))

        transferred += length_written

    # Close remote file
    check_error(red.release_object(remote_file_id, session_id))

    # Close local file
    local_file.close()

    # Expire session
    check_error(red.expire_session(session_id))

    print('{0} bytes transferred'.format(transferred))

if __name__ == '__main__':
    ipcon = IPConnection() # Create IP connection
    red = BrickRED(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    write_file(red, LOCAL_PATH, REMOTE_PATH)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

List Directory

Download (example_list_directory.py)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your RED Brick
DIRECTORY_PATH = '/home/tf' # Change to your directory path

import sys
from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_red import BrickRED

DIRECTORY_ENTRY_TYPE = {
    BrickRED.DIRECTORY_ENTRY_TYPE_UNKNOWN: 'unknown',
    BrickRED.DIRECTORY_ENTRY_TYPE_REGULAR: 'regular',
    BrickRED.DIRECTORY_ENTRY_TYPE_DIRECTORY: 'directory',
    BrickRED.DIRECTORY_ENTRY_TYPE_CHARACTER: 'character',
    BrickRED.DIRECTORY_ENTRY_TYPE_BLOCK: 'block',
    BrickRED.DIRECTORY_ENTRY_TYPE_FIFO: 'fifo',
    BrickRED.DIRECTORY_ENTRY_TYPE_SYMLINK: 'symlink',
    BrickRED.DIRECTORY_ENTRY_TYPE_SOCKET: 'socket'
}

def check_error(error_code, *args):
    if error_code != 0:
        raise Exception('RED Brick error occurred: {0}'.format(error_code))

    if len(args) == 1:
        return args[0]

    return args

def allocate_string(red, string, session_id):
    string_id = check_error(*red.allocate_string(len(string), string[:58], session_id))

    for offset in range(58, len(string), 58):
        check_error(red.set_string_chunk(string_id, offset, string[offset:offset + 58]))

    return string_id

def get_string(red, string_id):
    length = check_error(*red.get_string_length(string_id))
    string = []

    while len(string) < length:
        chunk = check_error(*red.get_string_chunk(string_id, len(string)))
        string += map(ord, chunk)

    if sys.version_info[0] > 2:
        string = bytes(string)
    else:
        string = ''.join(map(chr, string))

    return string.decode('utf-8')

def list_directory(red, directory_path):
    # Create session
    session_id = check_error(*red.create_session(60))

    # Open directory
    directory_path_id = allocate_string(red, directory_path, session_id)
    directory_id = check_error(*red.open_directory(directory_path_id, session_id))

    check_error(red.release_object(directory_path_id, session_id))

    # Get directory entries
    while True:
        result = red.get_next_directory_entry(directory_id, session_id)

        if result.error_code == BrickRED.ERROR_CODE_NO_MORE_DATA:
            break

        entry_name_id, entry_type = check_error(*result)
        entry_name = get_string(red, entry_name_id)

        check_error(red.release_object(entry_name_id, session_id))

        print('name: {0}, type: {1}'.format(entry_name, DIRECTORY_ENTRY_TYPE[entry_type]))

    # Close directory
    check_error(red.release_object(directory_id, session_id))

    # Expire session
    check_error(red.expire_session(session_id))

if __name__ == '__main__':
    ipcon = IPConnection() # Create IP connection
    red = BrickRED(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    list_directory(red, DIRECTORY_PATH)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

Remove File

Download (example_remove_file.py)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your RED Brick
REMOTE_PATH = '/home/tf/foobar.txt' # Change to your remote path

import sys
import time
from tinkerforge.ip_connection import IPConnection
from tinkerforge.brick_red import BrickRED

def check_error(error_code, *args):
    if error_code != 0:
        raise Exception('RED Brick error occurred: {0}'.format(error_code))

    if len(args) == 1:
        return args[0]

    return args

def allocate_string(red, string, session_id):
    string_id = check_error(*red.allocate_string(len(string), string[:58], session_id))

    for offset in range(58, len(string), 58):
        check_error(red.set_string_chunk(string_id, offset, string[offset:offset + 58]))

    return string_id

def remove_file(red, remote_path):
    # Create session
    session_id = check_error(*red.create_session(60))

    # Prepare spawn-process call
    executable_id = allocate_string(red, '/bin/rm', session_id)

    remote_path_id = allocate_string(red, remote_path, session_id)
    arguments_id = check_error(*red.allocate_list(1, session_id))
    check_error(red.append_to_list(arguments_id, remote_path_id))
    check_error(red.release_object(remote_path_id, session_id))

    environment_id = check_error(*red.allocate_list(0, session_id))

    working_directory_id = allocate_string(red, '/', session_id)

    dev_zero_id = allocate_string(red, '/dev/zero', session_id)
    stdin_id = check_error(*red.open_file(dev_zero_id,
                                          BrickRED.FILE_FLAG_READ_ONLY |
                                          BrickRED.FILE_FLAG_NON_BLOCKING,
                                          0, 1000, 1000, session_id))
    check_error(red.release_object(dev_zero_id, session_id))

    dev_null_id = allocate_string(red, '/dev/null', session_id)
    stdout_id = check_error(*red.open_file(dev_null_id,
                                           BrickRED.FILE_FLAG_WRITE_ONLY |
                                           BrickRED.FILE_FLAG_NON_BLOCKING,
                                           0, 1000, 1000, session_id))
    check_error(red.release_object(dev_null_id, session_id))

    # Spawn rm process to remove remote file
    process_id = check_error(*red.spawn_process(executable_id,
                                                arguments_id,
                                                environment_id,
                                                working_directory_id,
                                                1000, 1000,
                                                stdin_id,
                                                stdout_id,
                                                stdout_id,
                                                session_id))
    check_error(red.release_object(executable_id, session_id))
    check_error(red.release_object(arguments_id, session_id))
    check_error(red.release_object(environment_id, session_id))
    check_error(red.release_object(working_directory_id, session_id))
    check_error(red.release_object(stdin_id, session_id))
    check_error(red.release_object(stdout_id, session_id))

    # Busy wait for rm process to finish
    # FIXME: Could use CALLBACK_PROCESS_STATE_CHANGED instead
    state, timestamp, exit_code = check_error(*red.get_process_state(process_id))

    while state in [BrickRED.PROCESS_STATE_UNKNOWN, BrickRED.PROCESS_STATE_RUNNING]:
        time.sleep(0.1)

        state, timestamp, exit_code = check_error(*red.get_process_state(process_id))

    check_error(red.release_object(process_id, session_id))

    # Expire session
    check_error(red.expire_session(session_id))

    # Report result
    if state == BrickRED.PROCESS_STATE_ERROR:
        print('Removing {0} failed with an internal error'.format(remote_path))
    elif state == BrickRED.PROCESS_STATE_EXITED:
        if exit_code == 0:
            print('Removed {0}'.format(remote_path))
        else:
            # FIXME: Could report stdout/stderr from /bin/rm here
            print('Removing {0} failed with /bin/rm exit code {1}'.format(remote_path, exit_code))
    elif state == BrickRED.PROCESS_STATE_KILLED:
        print('Removing {0} failed with /bin/rm being killed by signal {1}'.format(remote_path, exit_code))
    elif state == BrickRED.PROCESS_STATE_STOPPED:
        print('Removing {0} failed with /bin/rm being stopped')
    else:
        print('Removing {0} failed with an unknown error'.format(remote_path))

if __name__ == '__main__':
    ipcon = IPConnection() # Create IP connection
    red = BrickRED(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    remove_file(red, REMOTE_PATH)

    input("Press key to exit\n") # Use raw_input() in Python 2
    ipcon.disconnect()

API

Prinzipiell kann jede Funktion der Python Bindings tinkerforge.ip_connection.Error Exception werfen, welche ein value und eine description Property hat. value kann verschiende Werte haben:

  • Error.TIMEOUT = -1
  • Error.NOT_ADDED = -6 (seit Python Bindings Version 2.0.0 nicht mehr verwendet)
  • Error.ALREADY_CONNECTED = -7
  • Error.NOT_CONNECTED = -8
  • Error.INVALID_PARAMETER = -9
  • Error.NOT_SUPPORTED = -10
  • Error.UNKNOWN_ERROR_CODE = -11
  • Error.STREAM_OUT_OF_SYNC = -12
  • Error.INVALID_UID = -13
  • Error.NON_ASCII_CHAR_IN_SECRET = -14
  • Error.WRONG_DEVICE_TYPE = -15
  • Error.DEVICE_REPLACED = -16
  • Error.WRONG_RESPONSE_LENGTH = -17

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Bemerkung

Die API Dokumentation für den RED Brick ist noch nicht vollständig.

Fortgeschrittene Funktionen

BrickRED.create_session(lifetime)
Parameter:
  • lifetime – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.expire_session(session_id)
Parameter:
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.expire_session_unchecked(session_id)
Parameter:
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • None
BrickRED.keep_session_alive(session_id, lifetime)
Parameter:
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • lifetime – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.release_object(object_id, session_id)
Parameter:
  • object_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.release_object_unchecked(object_id, session_id)
Parameter:
  • object_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • None
BrickRED.allocate_string(length_to_reserve, buffer, session_id)
Parameter:
  • length_to_reserve – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • buffer – Typ: str, Länge: bis zu 58
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.truncate_string(string_id, length)
Parameter:
  • string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_string_length(string_id)
Parameter:
  • string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.set_string_chunk(string_id, offset, buffer)
Parameter:
  • string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • buffer – Typ: str, Länge: bis zu 58
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_string_chunk(string_id, offset)
Parameter:
  • string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • buffer – Typ: str, Länge: bis zu 63

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.allocate_list(length_to_reserve, session_id)
Parameter:
  • length_to_reserve – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • list_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_list_length(list_id)
Parameter:
  • list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • length – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_list_item(list_id, index, session_id)
Parameter:
  • list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • index – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • item_object_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • type – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für type:

  • BrickRED.OBJECT_TYPE_STRING = 0
  • BrickRED.OBJECT_TYPE_LIST = 1
  • BrickRED.OBJECT_TYPE_FILE = 2
  • BrickRED.OBJECT_TYPE_DIRECTORY = 3
  • BrickRED.OBJECT_TYPE_PROCESS = 4
  • BrickRED.OBJECT_TYPE_PROGRAM = 5
BrickRED.append_to_list(list_id, item_object_id)
Parameter:
  • list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • item_object_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.remove_from_list(list_id, index)
Parameter:
  • list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • index – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.open_file(name_string_id, flags, permissions, uid, gid, session_id)
Parameter:
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: int, Wertebereich: Siehe Konstanten
  • permissions – Typ: int, Wertebereich: Siehe Konstanten
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für flags:

  • BrickRED.FILE_FLAG_READ_ONLY = 1
  • BrickRED.FILE_FLAG_WRITE_ONLY = 2
  • BrickRED.FILE_FLAG_READ_WRITE = 4
  • BrickRED.FILE_FLAG_APPEND = 8
  • BrickRED.FILE_FLAG_CREATE = 16
  • BrickRED.FILE_FLAG_EXCLUSIVE = 32
  • BrickRED.FILE_FLAG_NON_BLOCKING = 64
  • BrickRED.FILE_FLAG_TRUNCATE = 128
  • BrickRED.FILE_FLAG_TEMPORARY = 256
  • BrickRED.FILE_FLAG_REPLACE = 512

Für permissions:

  • BrickRED.FILE_PERMISSION_USER_ALL = 448
  • BrickRED.FILE_PERMISSION_USER_READ = 256
  • BrickRED.FILE_PERMISSION_USER_WRITE = 128
  • BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
  • BrickRED.FILE_PERMISSION_GROUP_ALL = 56
  • BrickRED.FILE_PERMISSION_GROUP_READ = 32
  • BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
  • BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
  • BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
  • BrickRED.FILE_PERMISSION_OTHERS_READ = 4
  • BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
  • BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.create_pipe(flags, length, session_id)
Parameter:
  • flags – Typ: int, Wertebereich: Siehe Konstanten
  • length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für flags:

  • BrickRED.PIPE_FLAG_NON_BLOCKING_READ = 1
  • BrickRED.PIPE_FLAG_NON_BLOCKING_WRITE = 2

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_file_info(file_id, session_id)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • type – Typ: int, Wertebereich: Siehe Konstanten
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: int, Wertebereich: Siehe Konstanten
  • permissions – Typ: int, Wertebereich: Siehe Konstanten
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • access_timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • modification_timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • status_change_timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für type:

  • BrickRED.FILE_TYPE_UNKNOWN = 0
  • BrickRED.FILE_TYPE_REGULAR = 1
  • BrickRED.FILE_TYPE_DIRECTORY = 2
  • BrickRED.FILE_TYPE_CHARACTER = 3
  • BrickRED.FILE_TYPE_BLOCK = 4
  • BrickRED.FILE_TYPE_FIFO = 5
  • BrickRED.FILE_TYPE_SYMLINK = 6
  • BrickRED.FILE_TYPE_SOCKET = 7
  • BrickRED.FILE_TYPE_PIPE = 8

Für flags:

  • BrickRED.FILE_FLAG_READ_ONLY = 1
  • BrickRED.FILE_FLAG_WRITE_ONLY = 2
  • BrickRED.FILE_FLAG_READ_WRITE = 4
  • BrickRED.FILE_FLAG_APPEND = 8
  • BrickRED.FILE_FLAG_CREATE = 16
  • BrickRED.FILE_FLAG_EXCLUSIVE = 32
  • BrickRED.FILE_FLAG_NON_BLOCKING = 64
  • BrickRED.FILE_FLAG_TRUNCATE = 128
  • BrickRED.FILE_FLAG_TEMPORARY = 256
  • BrickRED.FILE_FLAG_REPLACE = 512

Für permissions:

  • BrickRED.FILE_PERMISSION_USER_ALL = 448
  • BrickRED.FILE_PERMISSION_USER_READ = 256
  • BrickRED.FILE_PERMISSION_USER_WRITE = 128
  • BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
  • BrickRED.FILE_PERMISSION_GROUP_ALL = 56
  • BrickRED.FILE_PERMISSION_GROUP_READ = 32
  • BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
  • BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
  • BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
  • BrickRED.FILE_PERMISSION_OTHERS_READ = 4
  • BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
  • BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1
BrickRED.read_file(file_id, length_to_read)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • length_to_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • buffer – Typ: [int, ...], Länge: 62, Wertebereich: [0 bis 255]
  • length_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.read_file_async(file_id, length_to_read)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • length_to_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
Rückgabe:
  • None
BrickRED.abort_async_file_read(file_id)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.write_file(file_id, buffer, length_to_write)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255]
  • length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • length_written – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.write_file_unchecked(file_id, buffer, length_to_write)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255]
  • length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • None
BrickRED.write_file_async(file_id, buffer, length_to_write)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: [int, ...], Länge: 61, Wertebereich: [0 bis 255]
  • length_to_write – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]
Rückgabe:
  • None
BrickRED.set_file_position(file_id, offset, origin)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: int, Einheit: 1 B, Wertebereich: [-263 bis 263 - 1]
  • origin – Typ: int, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • position – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für origin:

  • BrickRED.FILE_ORIGIN_BEGINNING = 0
  • BrickRED.FILE_ORIGIN_CURRENT = 1
  • BrickRED.FILE_ORIGIN_END = 2

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_file_position(file_id)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • position – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.set_file_events(file_id, events)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • events – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für events:

  • BrickRED.FILE_EVENT_READABLE = 1
  • BrickRED.FILE_EVENT_WRITABLE = 2

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_file_events(file_id)
Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • events – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für events:

  • BrickRED.FILE_EVENT_READABLE = 1
  • BrickRED.FILE_EVENT_WRITABLE = 2
BrickRED.open_directory(name_string_id, session_id)
Parameter:
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • directory_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_directory_name(directory_id, session_id)
Parameter:
  • directory_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_next_directory_entry(directory_id, session_id)
Parameter:
  • directory_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • type – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für type:

  • BrickRED.DIRECTORY_ENTRY_TYPE_UNKNOWN = 0
  • BrickRED.DIRECTORY_ENTRY_TYPE_REGULAR = 1
  • BrickRED.DIRECTORY_ENTRY_TYPE_DIRECTORY = 2
  • BrickRED.DIRECTORY_ENTRY_TYPE_CHARACTER = 3
  • BrickRED.DIRECTORY_ENTRY_TYPE_BLOCK = 4
  • BrickRED.DIRECTORY_ENTRY_TYPE_FIFO = 5
  • BrickRED.DIRECTORY_ENTRY_TYPE_SYMLINK = 6
  • BrickRED.DIRECTORY_ENTRY_TYPE_SOCKET = 7
BrickRED.rewind_directory(directory_id)
Parameter:
  • directory_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.create_directory(name_string_id, flags, permissions, uid, gid)
Parameter:
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: int, Wertebereich: Siehe Konstanten
  • permissions – Typ: int, Wertebereich: Siehe Konstanten
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für flags:

  • BrickRED.DIRECTORY_FLAG_RECURSIVE = 1
  • BrickRED.DIRECTORY_FLAG_EXCLUSIVE = 2

Für permissions:

  • BrickRED.FILE_PERMISSION_USER_ALL = 448
  • BrickRED.FILE_PERMISSION_USER_READ = 256
  • BrickRED.FILE_PERMISSION_USER_WRITE = 128
  • BrickRED.FILE_PERMISSION_USER_EXECUTE = 64
  • BrickRED.FILE_PERMISSION_GROUP_ALL = 56
  • BrickRED.FILE_PERMISSION_GROUP_READ = 32
  • BrickRED.FILE_PERMISSION_GROUP_WRITE = 16
  • BrickRED.FILE_PERMISSION_GROUP_EXECUTE = 8
  • BrickRED.FILE_PERMISSION_OTHERS_ALL = 7
  • BrickRED.FILE_PERMISSION_OTHERS_READ = 4
  • BrickRED.FILE_PERMISSION_OTHERS_WRITE = 2
  • BrickRED.FILE_PERMISSION_OTHERS_EXECUTE = 1

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_processes(session_id)
Parameter:
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • processes_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.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)
Parameter:
  • executable_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • arguments_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • environment_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • working_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • stdin_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stdout_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stderr_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • process_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.kill_process(process_id, signal)
Parameter:
  • process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • signal – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für signal:

  • BrickRED.PROCESS_SIGNAL_INTERRUPT = 2
  • BrickRED.PROCESS_SIGNAL_QUIT = 3
  • BrickRED.PROCESS_SIGNAL_ABORT = 6
  • BrickRED.PROCESS_SIGNAL_KILL = 9
  • BrickRED.PROCESS_SIGNAL_USER1 = 10
  • BrickRED.PROCESS_SIGNAL_USER2 = 12
  • BrickRED.PROCESS_SIGNAL_TERMINATE = 15
  • BrickRED.PROCESS_SIGNAL_CONTINUE = 18
  • BrickRED.PROCESS_SIGNAL_STOP = 19

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_process_command(process_id, session_id)
Parameter:
  • process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • executable_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • arguments_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • environment_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • working_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_process_identity(process_id)
Parameter:
  • process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • pid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: int, Wertebereich: [0 bis 232 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_process_stdio(process_id, session_id)
Parameter:
  • process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • stdin_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stdout_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stderr_file_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_process_state(process_id)
Parameter:
  • process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • state – Typ: int, Wertebereich: Siehe Konstanten
  • timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • exit_code – Typ: int, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für state:

  • BrickRED.PROCESS_STATE_UNKNOWN = 0
  • BrickRED.PROCESS_STATE_RUNNING = 1
  • BrickRED.PROCESS_STATE_ERROR = 2
  • BrickRED.PROCESS_STATE_EXITED = 3
  • BrickRED.PROCESS_STATE_KILLED = 4
  • BrickRED.PROCESS_STATE_STOPPED = 5
BrickRED.get_programs(session_id)
Parameter:
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • programs_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.define_program(identifier_string_id, session_id)
Parameter:
  • identifier_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.purge_program(program_id, cookie)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • cookie – Typ: int, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_program_identifier(program_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • identifier_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_program_root_directory(program_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • root_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.set_program_command(program_id, executable_string_id, arguments_list_id, environment_list_id, working_directory_string_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • executable_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • arguments_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • environment_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • working_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_program_command(program_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • executable_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • arguments_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • environment_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • working_directory_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.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)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stdin_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stdout_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stderr_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für stdin_redirection:

  • BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
  • BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
  • BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
  • BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
  • BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
  • BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stdout_redirection:

  • BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
  • BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
  • BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
  • BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
  • BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
  • BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stderr_redirection:

  • BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
  • BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
  • BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
  • BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
  • BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
  • BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_program_stdio_redirection(program_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • stdin_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • stdin_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stdout_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • stdout_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • stderr_redirection – Typ: int, Wertebereich: Siehe Konstanten
  • stderr_file_name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für stdin_redirection:

  • BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
  • BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
  • BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
  • BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
  • BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
  • BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stdout_redirection:

  • BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
  • BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
  • BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
  • BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
  • BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
  • BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5

Für stderr_redirection:

  • BrickRED.PROGRAM_STDIO_REDIRECTION_DEV_NULL = 0
  • BrickRED.PROGRAM_STDIO_REDIRECTION_PIPE = 1
  • BrickRED.PROGRAM_STDIO_REDIRECTION_FILE = 2
  • BrickRED.PROGRAM_STDIO_REDIRECTION_INDIVIDUAL_LOG = 3
  • BrickRED.PROGRAM_STDIO_REDIRECTION_CONTINUOUS_LOG = 4
  • BrickRED.PROGRAM_STDIO_REDIRECTION_STDOUT = 5
BrickRED.set_program_schedule(program_id, start_mode, continue_after_error, start_interval, start_fields_string_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • start_mode – Typ: int, Wertebereich: Siehe Konstanten
  • continue_after_error – Typ: bool
  • start_interval – Typ: int, Wertebereich: [0 bis 232 - 1]
  • start_fields_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für start_mode:

  • BrickRED.PROGRAM_START_MODE_NEVER = 0
  • BrickRED.PROGRAM_START_MODE_ALWAYS = 1
  • BrickRED.PROGRAM_START_MODE_INTERVAL = 2
  • BrickRED.PROGRAM_START_MODE_CRON = 3

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_program_schedule(program_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • start_mode – Typ: int, Wertebereich: Siehe Konstanten
  • continue_after_error – Typ: bool
  • start_interval – Typ: int, Wertebereich: [0 bis 232 - 1]
  • start_fields_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für start_mode:

  • BrickRED.PROGRAM_START_MODE_NEVER = 0
  • BrickRED.PROGRAM_START_MODE_ALWAYS = 1
  • BrickRED.PROGRAM_START_MODE_INTERVAL = 2
  • BrickRED.PROGRAM_START_MODE_CRON = 3
BrickRED.get_program_scheduler_state(program_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • state – Typ: int, Wertebereich: Siehe Konstanten
  • timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • message_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144

Für state:

  • BrickRED.PROGRAM_SCHEDULER_STATE_STOPPED = 0
  • BrickRED.PROGRAM_SCHEDULER_STATE_RUNNING = 1
BrickRED.continue_program_schedule(program_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.start_program(program_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_last_spawned_program_process(program_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_custom_program_option_names(program_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • names_list_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.set_custom_program_option_value(program_id, name_string_id, value_string_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • value_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_custom_program_option_value(program_id, name_string_id, session_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabeobjekt:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • value_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.remove_custom_program_option(program_id, name_string_id)
Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • name_string_id – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.get_identity()
Rückgabeobjekt:
  • uid – Typ: str, Länge: bis zu 8
  • connected_uid – Typ: str, Länge: bis zu 8
  • position – Typ: chr, Wertebereich: ["0" bis "8"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricks.

Konfigurationsfunktionen für Callbacks

BrickRED.register_callback(callback_id, function)
Parameter:
  • callback_id – Typ: int
  • function – Typ: callable
Rückgabe:
  • None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

red.register_callback(BrickRED.CALLBACK_EXAMPLE, my_callback)

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickRED.CALLBACK_ASYNC_FILE_READ
Callback-Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • buffer – Typ: [int, ...], Länge: 60, Wertebereich: [0 bis 255]
  • length_read – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.CALLBACK_ASYNC_FILE_WRITE
Callback-Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • error_code – Typ: int, Wertebereich: Siehe Konstanten
  • length_written – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für error_code:

  • BrickRED.ERROR_CODE_SUCCESS = 0
  • BrickRED.ERROR_CODE_UNKNOWN_ERROR = 1
  • BrickRED.ERROR_CODE_INVALID_OPERATION = 2
  • BrickRED.ERROR_CODE_OPERATION_ABORTED = 3
  • BrickRED.ERROR_CODE_INTERNAL_ERROR = 4
  • BrickRED.ERROR_CODE_UNKNOWN_SESSION_ID = 5
  • BrickRED.ERROR_CODE_NO_FREE_SESSION_ID = 6
  • BrickRED.ERROR_CODE_UNKNOWN_OBJECT_ID = 7
  • BrickRED.ERROR_CODE_NO_FREE_OBJECT_ID = 8
  • BrickRED.ERROR_CODE_OBJECT_IS_LOCKED = 9
  • BrickRED.ERROR_CODE_NO_MORE_DATA = 10
  • BrickRED.ERROR_CODE_WRONG_LIST_ITEM_TYPE = 11
  • BrickRED.ERROR_CODE_PROGRAM_IS_PURGED = 12
  • BrickRED.ERROR_CODE_INVALID_PARAMETER = 128
  • BrickRED.ERROR_CODE_NO_FREE_MEMORY = 129
  • BrickRED.ERROR_CODE_NO_FREE_SPACE = 130
  • BrickRED.ERROR_CODE_ACCESS_DENIED = 121
  • BrickRED.ERROR_CODE_ALREADY_EXISTS = 132
  • BrickRED.ERROR_CODE_DOES_NOT_EXIST = 133
  • BrickRED.ERROR_CODE_INTERRUPTED = 134
  • BrickRED.ERROR_CODE_IS_DIRECTORY = 135
  • BrickRED.ERROR_CODE_NOT_A_DIRECTORY = 136
  • BrickRED.ERROR_CODE_WOULD_BLOCK = 137
  • BrickRED.ERROR_CODE_OVERFLOW = 138
  • BrickRED.ERROR_CODE_BAD_FILE_DESCRIPTOR = 139
  • BrickRED.ERROR_CODE_OUT_OF_RANGE = 140
  • BrickRED.ERROR_CODE_NAME_TOO_LONG = 141
  • BrickRED.ERROR_CODE_INVALID_SEEK = 142
  • BrickRED.ERROR_CODE_NOT_SUPPORTED = 143
  • BrickRED.ERROR_CODE_TOO_MANY_OPEN_FILES = 144
BrickRED.CALLBACK_FILE_EVENTS_OCCURRED
Callback-Parameter:
  • file_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • events – Typ: int, Wertebereich: Siehe Konstanten

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für events:

  • BrickRED.FILE_EVENT_READABLE = 1
  • BrickRED.FILE_EVENT_WRITABLE = 2
BrickRED.CALLBACK_PROCESS_STATE_CHANGED
Callback-Parameter:
  • process_id – Typ: int, Wertebereich: [0 bis 216 - 1]
  • state – Typ: int, Wertebereich: Siehe Konstanten
  • timestamp – Typ: int, Wertebereich: [0 bis 264 - 1]
  • exit_code – Typ: int, Wertebereich: [0 bis 255]

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für state:

  • BrickRED.PROCESS_STATE_UNKNOWN = 0
  • BrickRED.PROCESS_STATE_RUNNING = 1
  • BrickRED.PROCESS_STATE_ERROR = 2
  • BrickRED.PROCESS_STATE_EXITED = 3
  • BrickRED.PROCESS_STATE_KILLED = 4
  • BrickRED.PROCESS_STATE_STOPPED = 5
BrickRED.CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED
Callback-Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]
BrickRED.CALLBACK_PROGRAM_PROCESS_SPAWNED
Callback-Parameter:
  • program_id – Typ: int, Wertebereich: [0 bis 216 - 1]

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickRED.get_api_version()
Rückgabeobjekt:
  • api_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickRED.get_response_expected(function_id)
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • BrickRED.FUNCTION_EXPIRE_SESSION_UNCHECKED = 3
  • BrickRED.FUNCTION_RELEASE_OBJECT_UNCHECKED = 6
  • BrickRED.FUNCTION_READ_FILE_ASYNC = 21
  • BrickRED.FUNCTION_WRITE_FILE_UNCHECKED = 24
  • BrickRED.FUNCTION_WRITE_FILE_ASYNC = 25
BrickRED.set_response_expected(function_id, response_expected)
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • None

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

  • BrickRED.FUNCTION_EXPIRE_SESSION_UNCHECKED = 3
  • BrickRED.FUNCTION_RELEASE_OBJECT_UNCHECKED = 6
  • BrickRED.FUNCTION_READ_FILE_ASYNC = 21
  • BrickRED.FUNCTION_WRITE_FILE_UNCHECKED = 24
  • BrickRED.FUNCTION_WRITE_FILE_ASYNC = 25
BrickRED.set_response_expected_all(response_expected)
Parameter:
  • response_expected – Typ: bool
Rückgabe:
  • None

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

BrickRED.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen RED Brick zu identifizieren.

Die get_identity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickRED.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RED Brick dar.