Deutsch
English
Menu
Spezifikationen / Modbus Protokoll / API / Bricks / RED Brick

Modbus - RED Brick

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

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Bemerkung

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

Fortgeschrittene Funktionen

BrickRED.create_session
Funktions-ID:
  • 1
Anfrage:
  • lifetime – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.expire_session
Funktions-ID:
  • 2
Anfrage:
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.expire_session_unchecked
Funktions-ID:
  • 3
Anfrage:
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort
BrickRED.keep_session_alive
Funktions-ID:
  • 4
Anfrage:
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • lifetime – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.release_object
Funktions-ID:
  • 5
Anfrage:
  • object_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.release_object_unchecked
Funktions-ID:
  • 6
Anfrage:
  • object_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort
BrickRED.allocate_string
Funktions-ID:
  • 7
Anfrage:
  • length_to_reserve – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • buffer – Typ: char[58]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.truncate_string
Funktions-ID:
  • 8
Anfrage:
  • string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • length – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_string_length
Funktions-ID:
  • 9
Anfrage:
  • string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • length – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.set_string_chunk
Funktions-ID:
  • 10
Anfrage:
  • string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • buffer – Typ: char[58]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_string_chunk
Funktions-ID:
  • 11
Anfrage:
  • string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • buffer – Typ: char[63]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.allocate_list
Funktions-ID:
  • 12
Anfrage:
  • length_to_reserve – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_list_length
Funktions-ID:
  • 13
Anfrage:
  • list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • length – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_list_item
Funktions-ID:
  • 14
Anfrage:
  • list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • index – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • item_object_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • type – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files

Für type:

  • 0 = String
  • 1 = List
  • 2 = File
  • 3 = Directory
  • 4 = Process
  • 5 = Program
BrickRED.append_to_list
Funktions-ID:
  • 15
Anfrage:
  • list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • item_object_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.remove_from_list
Funktions-ID:
  • 16
Anfrage:
  • list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • index – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.open_file
Funktions-ID:
  • 17
Anfrage:
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: uint32, Wertebereich: Siehe Bedeutungen
  • permissions – Typ: uint16, Wertebereich: Siehe Bedeutungen
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für flags:

  • 1 = Read Only
  • 2 = Write Only
  • 4 = Read Write
  • 8 = Append
  • 16 = Create
  • 32 = Exclusive
  • 64 = Non Blocking
  • 128 = Truncate
  • 256 = Temporary
  • 512 = Replace

Für permissions:

  • 448 = User All
  • 256 = User Read
  • 128 = User Write
  • 64 = User Execute
  • 56 = Group All
  • 32 = Group Read
  • 16 = Group Write
  • 8 = Group Execute
  • 7 = Others All
  • 4 = Others Read
  • 2 = Others Write
  • 1 = Others Execute

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.create_pipe
Funktions-ID:
  • 18
Anfrage:
  • flags – Typ: uint32, Wertebereich: Siehe Bedeutungen
  • length – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für flags:

  • 1 = Non Blocking Read
  • 2 = Non Blocking Write

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_file_info
Funktions-ID:
  • 19
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • type – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: uint32, Wertebereich: Siehe Bedeutungen
  • permissions – Typ: uint16, Wertebereich: Siehe Bedeutungen
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • length – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
  • access_timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • modification_timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • status_change_timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files

Für type:

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

Für flags:

  • 1 = Read Only
  • 2 = Write Only
  • 4 = Read Write
  • 8 = Append
  • 16 = Create
  • 32 = Exclusive
  • 64 = Non Blocking
  • 128 = Truncate
  • 256 = Temporary
  • 512 = Replace

Für permissions:

  • 448 = User All
  • 256 = User Read
  • 128 = User Write
  • 64 = User Execute
  • 56 = Group All
  • 32 = Group Read
  • 16 = Group Write
  • 8 = Group Execute
  • 7 = Others All
  • 4 = Others Read
  • 2 = Others Write
  • 1 = Others Execute
BrickRED.read_file
Funktions-ID:
  • 20
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • length_to_read – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • buffer – Typ: uint8[62], Wertebereich: [0 bis 255]
  • length_read – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.read_file_async
Funktions-ID:
  • 21
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • length_to_read – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]
Antwort:
  • keine Antwort
BrickRED.abort_async_file_read
Funktions-ID:
  • 22
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.write_file
Funktions-ID:
  • 23
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: uint8[61], Wertebereich: [0 bis 255]
  • length_to_write – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • length_written – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.write_file_unchecked
Funktions-ID:
  • 24
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: uint8[61], Wertebereich: [0 bis 255]
  • length_to_write – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort
BrickRED.write_file_async
Funktions-ID:
  • 25
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • buffer – Typ: uint8[61], Wertebereich: [0 bis 255]
  • length_to_write – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort
BrickRED.set_file_position
Funktions-ID:
  • 26
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • offset – Typ: int64, Einheit: 1 B, Wertebereich: [-263 bis 263 - 1]
  • origin – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • position – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für origin:

  • 0 = Beginning
  • 1 = Current
  • 2 = End

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_file_position
Funktions-ID:
  • 27
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • position – Typ: uint64, Einheit: 1 B, Wertebereich: [0 bis 264 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.set_file_events
Funktions-ID:
  • 28
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • events – Typ: uint16, Wertebereich: Siehe Bedeutungen
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für events:

  • 1 = Readable
  • 2 = Writable

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_file_events
Funktions-ID:
  • 29
Anfrage:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • events – Typ: uint16, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files

Für events:

  • 1 = Readable
  • 2 = Writable
BrickRED.open_directory
Funktions-ID:
  • 33
Anfrage:
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • directory_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_directory_name
Funktions-ID:
  • 34
Anfrage:
  • directory_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_next_directory_entry
Funktions-ID:
  • 35
Anfrage:
  • directory_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • type – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files

Für type:

  • 0 = Unknown
  • 1 = Regular
  • 2 = Directory
  • 3 = Character
  • 4 = Block
  • 5 = FIFO
  • 6 = Symlink
  • 7 = Socket
BrickRED.rewind_directory
Funktions-ID:
  • 36
Anfrage:
  • directory_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.create_directory
Funktions-ID:
  • 37
Anfrage:
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • flags – Typ: uint32, Wertebereich: Siehe Bedeutungen
  • permissions – Typ: uint16, Wertebereich: Siehe Bedeutungen
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für flags:

  • 1 = Recursive
  • 2 = Exclusive

Für permissions:

  • 448 = User All
  • 256 = User Read
  • 128 = User Write
  • 64 = User Execute
  • 56 = Group All
  • 32 = Group Read
  • 16 = Group Write
  • 8 = Group Execute
  • 7 = Others All
  • 4 = Others Read
  • 2 = Others Write
  • 1 = Others Execute

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_processes
Funktions-ID:
  • 38
Anfrage:
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • processes_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.spawn_process
Funktions-ID:
  • 39
Anfrage:
  • executable_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • arguments_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • environment_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • working_directory_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • stdin_file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdout_file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stderr_file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • process_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.kill_process
Funktions-ID:
  • 40
Anfrage:
  • process_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • signal – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für signal:

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

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_process_command
Funktions-ID:
  • 41
Anfrage:
  • process_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • executable_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • arguments_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • environment_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • working_directory_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_process_identity
Funktions-ID:
  • 42
Anfrage:
  • process_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • pid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • gid – Typ: uint32, Wertebereich: [0 bis 232 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_process_stdio
Funktions-ID:
  • 43
Anfrage:
  • process_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stdin_file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdout_file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stderr_file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_process_state
Funktions-ID:
  • 44
Anfrage:
  • process_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • state – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • exit_code – Typ: uint8, Wertebereich: [0 bis 255]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files

Für state:

  • 0 = Unknown
  • 1 = Running
  • 2 = Error
  • 3 = Exited
  • 4 = Killed
  • 5 = Stopped
BrickRED.get_programs
Funktions-ID:
  • 46
Anfrage:
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • programs_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.define_program
Funktions-ID:
  • 47
Anfrage:
  • identifier_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.purge_program
Funktions-ID:
  • 48
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • cookie – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_program_identifier
Funktions-ID:
  • 49
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • identifier_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_program_root_directory
Funktions-ID:
  • 50
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • root_directory_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.set_program_command
Funktions-ID:
  • 51
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • executable_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • arguments_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • environment_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • working_directory_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_program_command
Funktions-ID:
  • 52
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • executable_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • arguments_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • environment_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • working_directory_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.set_program_stdio_redirection
Funktions-ID:
  • 53
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdin_redirection – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stdin_file_name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdout_redirection – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stdout_file_name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stderr_redirection – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stderr_file_name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für stdin_redirection:

  • 0 = Dev Null
  • 1 = Pipe
  • 2 = File
  • 3 = Individual Log
  • 4 = Continuous Log
  • 5 = Stdout

Für stdout_redirection:

  • 0 = Dev Null
  • 1 = Pipe
  • 2 = File
  • 3 = Individual Log
  • 4 = Continuous Log
  • 5 = Stdout

Für stderr_redirection:

  • 0 = Dev Null
  • 1 = Pipe
  • 2 = File
  • 3 = Individual Log
  • 4 = Continuous Log
  • 5 = Stdout

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_program_stdio_redirection
Funktions-ID:
  • 54
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stdin_redirection – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stdin_file_name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stdout_redirection – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stdout_file_name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • stderr_redirection – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • stderr_file_name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files

Für stdin_redirection:

  • 0 = Dev Null
  • 1 = Pipe
  • 2 = File
  • 3 = Individual Log
  • 4 = Continuous Log
  • 5 = Stdout

Für stdout_redirection:

  • 0 = Dev Null
  • 1 = Pipe
  • 2 = File
  • 3 = Individual Log
  • 4 = Continuous Log
  • 5 = Stdout

Für stderr_redirection:

  • 0 = Dev Null
  • 1 = Pipe
  • 2 = File
  • 3 = Individual Log
  • 4 = Continuous Log
  • 5 = Stdout
BrickRED.set_program_schedule
Funktions-ID:
  • 55
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • start_mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • continue_after_error – Typ: bool
  • start_interval – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • start_fields_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für start_mode:

  • 0 = Never
  • 1 = Always
  • 2 = Interval
  • 3 = Cron

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_program_schedule
Funktions-ID:
  • 56
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • start_mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • continue_after_error – Typ: bool
  • start_interval – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • start_fields_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files

Für start_mode:

  • 0 = Never
  • 1 = Always
  • 2 = Interval
  • 3 = Cron
BrickRED.get_program_scheduler_state
Funktions-ID:
  • 57
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • state – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • message_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files

Für state:

  • 0 = Stopped
  • 1 = Running
BrickRED.continue_program_schedule
Funktions-ID:
  • 58
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.start_program
Funktions-ID:
  • 59
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_last_spawned_program_process
Funktions-ID:
  • 60
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • process_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_custom_program_option_names
Funktions-ID:
  • 61
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • names_list_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.set_custom_program_option_value
Funktions-ID:
  • 62
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • value_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_custom_program_option_value
Funktions-ID:
  • 63
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • session_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • value_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.remove_custom_program_option
Funktions-ID:
  • 64
Anfrage:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • name_string_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Antwort:
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['0' bis '8']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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. 

Callbacks

BrickRED.CALLBACK_ASYNC_FILE_READ
Funktions-ID:
  • 30
Antwort:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • buffer – Typ: uint8[60], Wertebereich: [0 bis 255]
  • length_read – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.CALLBACK_ASYNC_FILE_WRITE
Funktions-ID:
  • 31
Antwort:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • error_code – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • length_written – Typ: uint8, Einheit: 1 B, Wertebereich: [0 bis 255]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für error_code:

  • 0 = Success
  • 1 = Unknown Error
  • 2 = Invalid Operation
  • 3 = Operation Aborted
  • 4 = Internal Error
  • 5 = Unknown Session Id
  • 6 = No Free Session Id
  • 7 = Unknown Object Id
  • 8 = No Free Object Id
  • 9 = Object Is Locked
  • 10 = No More Data
  • 11 = Wrong List Item Type
  • 12 = Program Is Purged
  • 128 = Invalid Parameter
  • 129 = No Free Memory
  • 130 = No Free Space
  • 121 = Access Denied
  • 132 = Already Exists
  • 133 = Does Not Exist
  • 134 = Interrupted
  • 135 = Is Directory
  • 136 = Not A Directory
  • 137 = Would Block
  • 138 = Overflow
  • 139 = Bad File Descriptor
  • 140 = Out Of Range
  • 141 = Name Too Long
  • 142 = Invalid Seek
  • 143 = Not Supported
  • 144 = Too Many Open Files
BrickRED.CALLBACK_FILE_EVENTS_OCCURRED
Funktions-ID:
  • 32
Antwort:
  • file_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • events – Typ: uint16, Wertebereich: Siehe Bedeutungen

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für events:

  • 1 = Readable
  • 2 = Writable
BrickRED.CALLBACK_PROCESS_STATE_CHANGED
Funktions-ID:
  • 45
Antwort:
  • process_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • state – Typ: uint8, Wertebereich: Siehe Bedeutungen
  • timestamp – Typ: uint64, Wertebereich: [0 bis 264 - 1]
  • exit_code – Typ: uint8, Wertebereich: [0 bis 255]

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für state:

  • 0 = Unknown
  • 1 = Running
  • 2 = Error
  • 3 = Exited
  • 4 = Killed
  • 5 = Stopped
BrickRED.CALLBACK_PROGRAM_SCHEDULER_STATE_CHANGED
Funktions-ID:
  • 65
Antwort:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]
BrickRED.CALLBACK_PROGRAM_PROCESS_SPAWNED
Funktions-ID:
  • 66
Antwort:
  • program_id – Typ: uint16, Wertebereich: [0 bis 216 - 1]