LabVIEW - RED Brick – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
          - DC Brick
          - IMU Brick
          - Master Brick
          - RED Brick
            - Examples
            - API
              - Advanced Functions
              - Callbacks
              - Constants
          - Servo Brick
          - Stepper Brick
        - Bricklets
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# LabVIEW - RED Brick

This is the description of the LabVIEW API bindings for the RED Brick. General information and technical specifications for the RED Brick are summarized in its hardware description.

An installation guide for the LabVIEW API bindings is part of their general description.

## Examples

The example code below is Public Domain (CC0 1.0).

## API

Generally, every method of the LabVIEW bindings that outputs a value can report a `Tinkerforge.TimeoutException`. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is `Tinkerforge.*`.

The RED Brick API is meant to be used by the Brick Viewer to implement the offered functionality (getting status information, managing programs etc.). Normal users will not need to use this API, it may only be interesting for power users.

FIXME: explain sessions

The RED Brick API operates on reference counted objects (strings, lists, files, directories, processes and programs) that are identified by their 16bit object ID. Functions that allocate or return an object ID (e.g. `AllocateString()` and `GetNextDirectoryEntry()`) increase the reference count of the returned object. If the object is no longer needed then `ReleaseObject()` has to be called to decrease the reference count of the object again. In contrast to allocation and getter functions, the reference count for an object returned by a callback is not increased and `ReleaseObject()` must not be called for such an object in response to a callback.

There are functions (e.g. `GetFileInfo()`) that only return valid objects under certain conditions. This conditions are documented for the specific functions. For invalid objects `ReleaseObject()` must not be called.

There are also function (e.g. `SetProgramStdioRedirection()`) that have conditionally unused object parameters. Under which conditions an object parameter is unused is documented for the specific functions. For unused object parameters 0 has to be passed as object ID.

The RED Brick API is more complex then the typical Brick API and requires more elaborate error reporting than the TCP/IP protocol can provide with its 2bit error code. Therefore, almost all functions of the RED Brick API return an 8bit error code. Possible error codes are:

- Success = 0
- UnknownError = 1
- InvalidOperation = 2
- OperationAborted = 3
- InternalError = 4
- UnknownSessionID = 5
- NoFreeSessionID = 6
- UnknownObjectID = 7
- NoFreeObjectID = 8
- ObjectIsLocked = 9
- NoMoreData = 10
- WrongListItemType = 11
- ProgramIsPurged = 12
- InvalidParameter = 128 (EINVAL)
- NoFreeMemory = 129 (ENOMEM)
- NoFreeSpace = 130 (ENOSPC)
- AccessDenied = 131 (EACCES)
- AlreadyExists = 132 (EEXIST)
- DoesNotExist = 133 (ENOENT)
- Interrupted = 134 (EINTR)
- IsDirectory = 135 (EISDIR)
- NotADirectory = 136 (ENOTDIR)
- WouldBlock = 137 (EWOULDBLOCK)
- Overflow = 138 (EOVERFLOW)
- BadFileDescriptor = 139 (EBADF)
- OutOfRange = 140 (ERANGE)
- NameTooLong = 141 (ENAMETOOLONG)
- InvalidSeek = 142 (ESPIPE)
- NotSupported = 143 (ENOTSUP)
- TooManyOpenFiles = 144 (EMFILE)

If a function returns an error code other than Success then its other return values (if any) are invalid and must not be used.

The error code InvalidOperation is returned if the requested operation cannot be performed because the current state of the object does not allow it. For example, trying to append an item to a full list object or trying to undefine an already undefined program.

The error code NotSupported is returned if the requested operation can never be performed. For example, trying to append a list object to itself, trying to get the name of a file object with type Pipe or trying to create a directory non-recursively with more than the last part of the directory name referring to non-existing directories.

String objects store UTF-8 encoded data.

### Advanced Functions

`BrickRED.``CreateSession`(lifetime) → errorCode, sessionId

  Input:

  - lifetime -- Int64

  Output:

  - errorCode -- Byte
  - sessionId -- Int32

`BrickRED.``ExpireSession`(sessionId) → errorCode

  Input:

  - sessionId -- Int32

  Output:

  - errorCode -- Byte

`BrickRED.``ExpireSessionUnchecked`(sessionId)

  Input:

  - sessionId -- Int32

`BrickRED.``KeepSessionAlive`(sessionId, lifetime) → errorCode

  Input:

  - sessionId -- Int32
  - lifetime -- Int64

  Output:

  - errorCode -- Byte

`BrickRED.``ReleaseObject`(objectId, sessionId) → errorCode

  Input:

  - objectId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte

  Decreases the reference count of an object by one and returns the resulting error code. If the reference count reaches zero the object gets destroyed.

`BrickRED.``ReleaseObjectUnchecked`(objectId, sessionId)

  Input:

  - objectId -- Int32
  - sessionId -- Int32

`BrickRED.``AllocateString`(lengthToReserve, buffer, sessionId) → errorCode, stringId

  Input:

  - lengthToReserve -- Int64
  - buffer -- String
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - stringId -- Int32

  Allocates a new string object, reserves `length_to_reserve` bytes memory for it and sets up to the first 60 bytes. Set `length_to_reserve` to the length of the string that should be stored in the string object.

  Returns the object ID of the new string object and the resulting error code.

`BrickRED.``TruncateString`(stringId, length) → errorCode

  Input:

  - stringId -- Int32
  - length -- Int64

  Output:

  - errorCode -- Byte

  Truncates a string object to `length` bytes and returns the resulting error code.

`BrickRED.``GetStringLength`(stringId) → errorCode, length

  Input:

  - stringId -- Int32

  Output:

  - errorCode -- Byte
  - length -- Int64

  Returns the length of a string object in bytes and the resulting error code.

`BrickRED.``SetStringChunk`(stringId, offset, buffer) → errorCode

  Input:

  - stringId -- Int32
  - offset -- Int64
  - buffer -- String

  Output:

  - errorCode -- Byte

  Sets a chunk of up to 58 bytes in a string object beginning at `offset`.

  Returns the resulting error code.

`BrickRED.``GetStringChunk`(stringId, offset) → errorCode, buffer

  Input:

  - stringId -- Int32
  - offset -- Int64

  Output:

  - errorCode -- Byte
  - buffer -- String

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

`BrickRED.``AllocateList`(lengthToReserve, sessionId) → errorCode, listId

  Input:

  - lengthToReserve -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - listId -- Int32

  Allocates a new list object and reserves memory for `length_to_reserve` items. Set `length_to_reserve` to the number of items that should be stored in the list object.

  Returns the object ID of the new list object and the resulting error code.

  When a list object gets destroyed then the reference count of each object in the list object is decreased by one.

`BrickRED.``GetListLength`(listId) → errorCode, length

  Input:

  - listId -- Int32

  Output:

  - errorCode -- Byte
  - length -- Int32

  Returns the length of a list object in items and the resulting error code.

`BrickRED.``GetListItem`(listId, index, sessionId) → errorCode, itemObjectId, type

  Input:

  - listId -- Int32
  - index -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - itemObjectId -- Int32
  - type -- Byte

  Returns the object ID and type of the object stored at `index` in a list object and returns the resulting error code.

  Possible object types are:

  - String = 0
  - List = 1
  - File = 2
  - Directory = 3
  - Process = 4
  - Program = 5

  The following constants are available for this function:

  - 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.``AppendToList`(listId, itemObjectId) → errorCode

  Input:

  - listId -- Int32
  - itemObjectId -- Int32

  Output:

  - errorCode -- Byte

  Appends an object to a list object and increases the reference count of the appended object by one.

  Returns the resulting error code.

`BrickRED.``RemoveFromList`(listId, index) → errorCode

  Input:

  - listId -- Int32
  - index -- Int32

  Output:

  - errorCode -- Byte

  Removes the object stored at `index` from a list object and decreases the reference count of the removed object by one.

  Returns the resulting error code.

`BrickRED.``OpenFile`(nameStringId, flags, permissions, uid, gid, sessionId) → errorCode, fileId

  Input:

  - nameStringId -- Int32
  - flags -- Int64
  - permissions -- Int32
  - uid -- Int64
  - gid -- Int64
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - fileId -- Int32

  Opens an existing file or creates a new file and allocates a new file object for it.

  FIXME: name has to be absolute

  The reference count of the name string object is increased by one. When the file object gets destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the file object holds a reference to it.

  The `flags` parameter takes a ORed combination of the following possible file flags (in hexadecimal notation):

  - ReadOnly = 0x0001 (O_RDONLY)
  - WriteOnly = 0x0002 (O_WRONLY)
  - ReadWrite = 0x0004 (O_RDWR)
  - Append = 0x0008 (O_APPEND)
  - Create = 0x0010 (O_CREAT)
  - Exclusive = 0x0020 (O_EXCL)
  - NonBlocking = 0x0040 (O_NONBLOCK)
  - Truncate = 0x0080 (O_TRUNC)
  - Temporary = 0x0100
  - Replace = 0x0200

  FIXME: explain Temporary and Replace flag

  The `permissions` parameter takes a ORed combination of the following possible file permissions (in octal notation) that match the common UNIX permission bits:

  - UserRead = 00400
  - UserWrite = 00200
  - UserExecute = 00100
  - GroupRead = 00040
  - GroupWrite = 00020
  - GroupExecute = 00010
  - OthersRead = 00004
  - OthersWrite = 00002
  - OthersExecute = 00001

  Returns the object ID of the new file object and the resulting error code.

  The following constants are available for this function:

  - 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
  - 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.``CreatePipe`(flags, length, sessionId) → errorCode, fileId

  Input:

  - flags -- Int64
  - length -- Int64
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - fileId -- Int32

  Creates a new pipe and allocates a new file object for it.

  The `flags` parameter takes a ORed combination of the following possible pipe flags (in hexadecimal notation):

  - NonBlockingRead = 0x0001
  - NonBlockingWrite = 0x0002

  The length of the pipe buffer can be specified with the `length` parameter in bytes. If length is set to zero, then the default pipe buffer length is used.

  Returns the object ID of the new file object and the resulting error code.

  The following constants are available for this function:

  - BrickRED.PIPE_FLAG_NON_BLOCKING_READ = 1
  - BrickRED.PIPE_FLAG_NON_BLOCKING_WRITE = 2

`BrickRED.``GetFileInfo`(fileId, sessionId) → errorCode, type, nameStringId, flags, permissions, uid, gid, length, accessTimestamp, modificationTimestamp, statusChangeTimestamp

  Input:

  - fileId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - type -- Byte
  - nameStringId -- Int32
  - flags -- Int64
  - permissions -- Int32
  - uid -- Int64
  - gid -- Int64
  - length -- Int64
  - accessTimestamp -- Int64
  - modificationTimestamp -- Int64
  - statusChangeTimestamp -- Int64

  Returns various information about a file and the resulting error code.

  Possible file types are:

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

  If the file type is Pipe then the returned name string object is invalid, because a pipe has no name. Otherwise the returned name string object was used to open or create the file object, as passed to `OpenFile()`.

  The returned flags were used to open or create the file object, as passed to `OpenFile()` or `CreatePipe()`. See the respective function for a list of possible file and pipe flags.

  FIXME: everything except flags and length is invalid if file type is Pipe

  The following constants are available for this function:

  - 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
  - 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.``ReadFile`(fileId, lengthToRead) → errorCode, buffer, lengthRead

  Input:

  - fileId -- Int32
  - lengthToRead -- Byte

  Output:

  - errorCode -- Byte
  - buffer -- Byte[62]
  - lengthRead -- Byte

  Reads up to 62 bytes from a file object.

  Returns the bytes read, the actual number of bytes read and the resulting error code.

  If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are returned.

  If the file object was created by `OpenFile()` without the NonBlocking flag or by `CreatePipe()` without the NonBlockingRead flag then the error code NotSupported is returned.

`BrickRED.``ReadFileAsync`(fileId, lengthToRead)

  Input:

  - fileId -- Int32
  - lengthToRead -- Int64

  Reads up to 263 - 1 bytes from a file object asynchronously.

  Reports the bytes read (in 60 byte chunks), the actual number of bytes read and the resulting error code via the `AsyncFileRead` callback.

  If there is not data to be read, either because the file position reached end-of-file or because there is not data in the pipe, then zero bytes are reported.

  If the file object was created by `OpenFile()` without the NonBlocking flag or by `CreatePipe()` without the NonBlockingRead flag then the error code NotSupported is reported via the `AsyncFileRead` callback.

`BrickRED.``AbortAsyncFileRead`(fileId) → errorCode

  Input:

  - fileId -- Int32

  Output:

  - errorCode -- Byte

  Aborts a `ReadFileAsync()` operation in progress.

  Returns the resulting error code.

  On success the `AsyncFileRead` callback will report OperationAborted.

`BrickRED.``WriteFile`(fileId, buffer, lengthToWrite) → errorCode, lengthWritten

  Input:

  - fileId -- Int32
  - buffer -- Byte[61]
  - lengthToWrite -- Byte

  Output:

  - errorCode -- Byte
  - lengthWritten -- Byte

  Writes up to 61 bytes to a file object.

  Returns the actual number of bytes written and the resulting error code.

  If the file object was created by `OpenFile()` without the NonBlocking flag or by `CreatePipe()` without the NonBlockingWrite flag then the error code NotSupported is returned.

`BrickRED.``WriteFileUnchecked`(fileId, buffer, lengthToWrite)

  Input:

  - fileId -- Int32
  - buffer -- Byte[61]
  - lengthToWrite -- Byte

  Writes up to 61 bytes to a file object.

  Does neither report the actual number of bytes written nor the resulting error code.

  If the file object was created by `OpenFile()` without the NonBlocking flag or by `CreatePipe()` without the NonBlockingWrite flag then the write operation will fail silently.

`BrickRED.``WriteFileAsync`(fileId, buffer, lengthToWrite)

  Input:

  - fileId -- Int32
  - buffer -- Byte[61]
  - lengthToWrite -- Byte

  Writes up to 61 bytes to a file object.

  Reports the actual number of bytes written and the resulting error code via the `AsyncFileWrite` callback.

  If the file object was created by `OpenFile()` without the NonBlocking flag or by `CreatePipe()` without the NonBlockingWrite flag then the error code NotSupported is reported via the `AsyncFileWrite` callback.

`BrickRED.``SetFilePosition`(fileId, offset, origin) → errorCode, position

  Input:

  - fileId -- Int32
  - offset -- Int64
  - origin -- Byte

  Output:

  - errorCode -- Byte
  - position -- Int64

  Set the current seek position of a file object in bytes relative to `origin`.

  Possible file origins are:

  - Beginning = 0
  - Current = 1
  - End = 2

  Returns the resulting absolute seek position and error code.

  If the file object was created by `CreatePipe()` then it has no seek position and the error code InvalidSeek is returned.

  The following constants are available for this function:

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

`BrickRED.``GetFilePosition`(fileId) → errorCode, position

  Input:

  - fileId -- Int32

  Output:

  - errorCode -- Byte
  - position -- Int64

  Returns the current seek position of a file object in bytes and returns the resulting error code.

  If the file object was created by `CreatePipe()` then it has no seek position and the error code InvalidSeek is returned.

`BrickRED.``SetFileEvents`(fileId, events) → errorCode

  Input:

  - fileId -- Int32
  - events -- Int32

  Output:

  - errorCode -- Byte

  The following constants are available for this function:

  - BrickRED.FILE_EVENT_READABLE = 1
  - BrickRED.FILE_EVENT_WRITABLE = 2

`BrickRED.``GetFileEvents`(fileId) → errorCode, events

  Input:

  - fileId -- Int32

  Output:

  - errorCode -- Byte
  - events -- Int32

  The following constants are available for this function:

  - BrickRED.FILE_EVENT_READABLE = 1
  - BrickRED.FILE_EVENT_WRITABLE = 2

`BrickRED.``OpenDirectory`(nameStringId, sessionId) → errorCode, directoryId

  Input:

  - nameStringId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - directoryId -- Int32

  Opens an existing directory and allocates a new directory object for it.

  FIXME: name has to be absolute

  The reference count of the name string object is increased by one. When the directory object is destroyed then the reference count of the name string object is decreased by one. Also the name string object is locked and cannot be modified while the directory object holds a reference to it.

  Returns the object ID of the new directory object and the resulting error code.

`BrickRED.``GetDirectoryName`(directoryId, sessionId) → errorCode, nameStringId

  Input:

  - directoryId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - nameStringId -- Int32

  Returns the name of a directory object, as passed to `OpenDirectory()`, and the resulting error code.

`BrickRED.``GetNextDirectoryEntry`(directoryId, sessionId) → errorCode, nameStringId, type

  Input:

  - directoryId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - nameStringId -- Int32
  - type -- Byte

  Returns the next entry in a directory object and the resulting error code.

  If there is not next entry then error code NoMoreData is returned. To rewind a directory object call `RewindDirectory()`.

  Possible directory entry types are:

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

  The following constants are available for this function:

  - 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.``RewindDirectory`(directoryId) → errorCode

  Input:

  - directoryId -- Int32

  Output:

  - errorCode -- Byte

  Rewinds a directory object and returns the resulting error code.

`BrickRED.``CreateDirectory`(nameStringId, flags, permissions, uid, gid) → errorCode

  Input:

  - nameStringId -- Int32
  - flags -- Int64
  - permissions -- Int32
  - uid -- Int64
  - gid -- Int64

  Output:

  - errorCode -- Byte

  FIXME: name has to be absolute

  The following constants are available for this function:

  - BrickRED.DIRECTORY_FLAG_RECURSIVE = 1
  - BrickRED.DIRECTORY_FLAG_EXCLUSIVE = 2
  - 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.``GetProcesses`(sessionId) → errorCode, processesListId

  Input:

  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - processesListId -- Int32

`BrickRED.``SpawnProcess`(executableStringId, argumentsListId, environmentListId, workingDirectoryStringId, uid, gid, stdinFileId, stdoutFileId, stderrFileId, sessionId) → errorCode, processId

  Input:

  - executableStringId -- Int32
  - argumentsListId -- Int32
  - environmentListId -- Int32
  - workingDirectoryStringId -- Int32
  - uid -- Int64
  - gid -- Int64
  - stdinFileId -- Int32
  - stdoutFileId -- Int32
  - stderrFileId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - processId -- Int32

`BrickRED.``KillProcess`(processId, signal) → errorCode

  Input:

  - processId -- Int32
  - signal -- Byte

  Output:

  - errorCode -- Byte

  Sends a UNIX signal to a process object and returns the resulting error code.

  Possible UNIX signals are:

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

  The following constants are available for this function:

  - 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

`BrickRED.``GetProcessCommand`(processId, sessionId) → errorCode, executableStringId, argumentsListId, environmentListId, workingDirectoryStringId

  Input:

  - processId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - executableStringId -- Int32
  - argumentsListId -- Int32
  - environmentListId -- Int32
  - workingDirectoryStringId -- Int32

  Returns the executable, arguments, environment and working directory used to spawn a process object, as passed to `SpawnProcess()`, and the resulting error code.

`BrickRED.``GetProcessIdentity`(processId) → errorCode, pid, uid, gid

  Input:

  - processId -- Int32

  Output:

  - errorCode -- Byte
  - pid -- Int64
  - uid -- Int64
  - gid -- Int64

  Returns the process ID and the user and group ID used to spawn a process object, as passed to `SpawnProcess()`, and the resulting error code.

  The process ID is only valid if the state is Running or Stopped, see `GetProcessState()`.

`BrickRED.``GetProcessStdio`(processId, sessionId) → errorCode, stdinFileId, stdoutFileId, stderrFileId

  Input:

  - processId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - stdinFileId -- Int32
  - stdoutFileId -- Int32
  - stderrFileId -- Int32

  Returns the stdin, stdout and stderr files used to spawn a process object, as passed to `SpawnProcess()`, and the resulting error code.

`BrickRED.``GetProcessState`(processId) → errorCode, state, timestamp, exitCode

  Input:

  - processId -- Int32

  Output:

  - errorCode -- Byte
  - state -- Byte
  - timestamp -- Int64
  - exitCode -- Byte

  Returns the current state, timestamp and exit code of a process object, and the resulting error code.

  Possible process states are:

  - Unknown = 0
  - Running = 1
  - Error = 2
  - Exited = 3
  - Killed = 4
  - Stopped = 5

  The timestamp represents the UNIX time since when the process is in its current state.

  The exit code is only valid if the state is Error, Exited, Killed or Stopped and has different meanings depending on the state:

  - Error: error code for error occurred while spawning the process (see below)
  - Exited: exit status of the process
  - Killed: UNIX signal number used to kill the process
  - Stopped: UNIX signal number used to stop the process

  Possible exit/error codes in Error state are:

  - InternalError = 125
  - CannotExecute = 126
  - DoesNotExist = 127

  The CannotExecute error can be caused by the executable being opened for writing.

  The following constants are available for this function:

  - 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.``GetPrograms`(sessionId) → errorCode, programsListId

  Input:

  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - programsListId -- Int32

`BrickRED.``DefineProgram`(identifierStringId, sessionId) → errorCode, programId

  Input:

  - identifierStringId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - programId -- Int32

`BrickRED.``PurgeProgram`(programId, cookie) → errorCode

  Input:

  - programId -- Int32
  - cookie -- Int64

  Output:

  - errorCode -- Byte

`BrickRED.``GetProgramIdentifier`(programId, sessionId) → errorCode, identifierStringId

  Input:

  - programId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - identifierStringId -- Int32

`BrickRED.``GetProgramRootDirectory`(programId, sessionId) → errorCode, rootDirectoryStringId

  Input:

  - programId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - rootDirectoryStringId -- Int32

  FIXME: root directory is absolute: <home>/programs/<identifier>

`BrickRED.``SetProgramCommand`(programId, executableStringId, argumentsListId, environmentListId, workingDirectoryStringId) → errorCode

  Input:

  - programId -- Int32
  - executableStringId -- Int32
  - argumentsListId -- Int32
  - environmentListId -- Int32
  - workingDirectoryStringId -- Int32

  Output:

  - errorCode -- Byte

  FIXME: working directory is relative to <home>/programs/<identifier>/bin

`BrickRED.``GetProgramCommand`(programId, sessionId) → errorCode, executableStringId, argumentsListId, environmentListId, workingDirectoryStringId

  Input:

  - programId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - executableStringId -- Int32
  - argumentsListId -- Int32
  - environmentListId -- Int32
  - workingDirectoryStringId -- Int32

  FIXME: working directory is relative to <home>/programs/<identifier>/bin

`BrickRED.``SetProgramStdioRedirection`(programId, stdinRedirection, stdinFileNameStringId, stdoutRedirection, stdoutFileNameStringId, stderrRedirection, stderrFileNameStringId) → errorCode

  Input:

  - programId -- Int32
  - stdinRedirection -- Byte
  - stdinFileNameStringId -- Int32
  - stdoutRedirection -- Byte
  - stdoutFileNameStringId -- Int32
  - stderrRedirection -- Byte
  - stderrFileNameStringId -- Int32

  Output:

  - errorCode -- Byte

  FIXME: stdio file names are relative to <home>/programs/<identifier>/bin

  The following constants are available for this function:

  - 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.``GetProgramStdioRedirection`(programId, sessionId) → errorCode, stdinRedirection, stdinFileNameStringId, stdoutRedirection, stdoutFileNameStringId, stderrRedirection, stderrFileNameStringId

  Input:

  - programId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - stdinRedirection -- Byte
  - stdinFileNameStringId -- Int32
  - stdoutRedirection -- Byte
  - stdoutFileNameStringId -- Int32
  - stderrRedirection -- Byte
  - stderrFileNameStringId -- Int32

  FIXME: stdio file names are relative to <home>/programs/<identifier>/bin

  The following constants are available for this function:

  - 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.``SetProgramSchedule`(programId, startMode, continueAfterError, startInterval, startFieldsStringId) → errorCode

  Input:

  - programId -- Int32
  - startMode -- Byte
  - continueAfterError -- Boolean
  - startInterval -- Int64
  - startFieldsStringId -- Int32

  Output:

  - errorCode -- Byte

  The following constants are available for this function:

  - 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.``GetProgramSchedule`(programId, sessionId) → errorCode, startMode, continueAfterError, startInterval, startFieldsStringId

  Input:

  - programId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - startMode -- Byte
  - continueAfterError -- Boolean
  - startInterval -- Int64
  - startFieldsStringId -- Int32

  The following constants are available for this function:

  - 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.``GetProgramSchedulerState`(programId, sessionId) → errorCode, state, timestamp, messageStringId

  Input:

  - programId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - state -- Byte
  - timestamp -- Int64
  - messageStringId -- Int32

  FIXME: message is currently valid in error-occurred state only

  The following constants are available for this function:

  - BrickRED.PROGRAM_SCHEDULER_STATE_STOPPED = 0
  - BrickRED.PROGRAM_SCHEDULER_STATE_RUNNING = 1

`BrickRED.``ContinueProgramSchedule`(programId) → errorCode

  Input:

  - programId -- Int32

  Output:

  - errorCode -- Byte

`BrickRED.``StartProgram`(programId) → errorCode

  Input:

  - programId -- Int32

  Output:

  - errorCode -- Byte

`BrickRED.``GetLastSpawnedProgramProcess`(programId, sessionId) → errorCode, processId, timestamp

  Input:

  - programId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - processId -- Int32
  - timestamp -- Int64

`BrickRED.``GetCustomProgramOptionNames`(programId, sessionId) → errorCode, namesListId

  Input:

  - programId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - namesListId -- Int32

`BrickRED.``SetCustomProgramOptionValue`(programId, nameStringId, valueStringId) → errorCode

  Input:

  - programId -- Int32
  - nameStringId -- Int32
  - valueStringId -- Int32

  Output:

  - errorCode -- Byte

`BrickRED.``GetCustomProgramOptionValue`(programId, nameStringId, sessionId) → errorCode, valueStringId

  Input:

  - programId -- Int32
  - nameStringId -- Int32
  - sessionId -- Int32

  Output:

  - errorCode -- Byte
  - valueStringId -- Int32

`BrickRED.``RemoveCustomProgramOption`(programId, nameStringId) → errorCode

  Input:

  - programId -- Int32
  - nameStringId -- Int32

  Output:

  - errorCode -- Byte

`BrickRED.``GetAPIVersion`() → apiVersion

  Output:

  - apiVersion -- Byte[3]

  Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

`BrickRED.``GetResponseExpected`(functionId) → responseExpected

  Input:

  - functionId -- Byte

  Output:

  - responseExpected -- Boolean

  Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

  For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by `SetResponseExpected()`. For setter functions it is disabled by default and can be enabled.

  Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

  See `SetResponseExpected()` for the list of function ID constants available for this function.

`BrickRED.``SetResponseExpected`(functionId, responseExpected)

  Input:

  - functionId -- Byte
  - responseExpected -- Boolean

  Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled and callbacks it is always disabled.

  Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

  The following function ID constants are available for this function:

  - 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.``SetResponseExpectedAll`(responseExpected)

  Input:

  - responseExpected -- Boolean

  Changes the response expected flag for all setter and callback configuration functions of this device at once.

`BrickRED.``GetIdentity`() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier

  Output:

  - uid -- String
  - connectedUid -- String
  - position -- Char
  - hardwareVersion -- Byte[3]
  - firmwareVersion -- Byte[3]
  - deviceIdentifier -- Int32

  Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

  The position can be '0'-'8' (stack position).

  The device identifier numbers can be found here. There is also a constant for the device identifier of this Brick.

### Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event `BrickRED.``AsyncFileRead`(sender, fileId, errorCode, buffer, lengthRead)

  Input:

  - sender -- .NET Refnum (BrickRED)
  - fileId -- Int32
  - errorCode -- Byte
  - buffer -- Byte[60]
  - lengthRead -- Byte

  This callback reports the result of a call to the `ReadFileAsync()` function.

event `BrickRED.``AsyncFileWrite`(sender, fileId, errorCode, lengthWritten)

  Input:

  - sender -- .NET Refnum (BrickRED)
  - fileId -- Int32
  - errorCode -- Byte
  - lengthWritten -- Byte

  This callback reports the result of a call to the `WriteFileAsync()` function.

event `BrickRED.``FileEventsOccurred`(sender, fileId, events)

  Input:

  - sender -- .NET Refnum (BrickRED)
  - fileId -- Int32
  - events -- Int32

  The following constants are available for this function:

  - BrickRED.FILE_EVENT_READABLE = 1
  - BrickRED.FILE_EVENT_WRITABLE = 2

event `BrickRED.``ProcessStateChanged`(sender, processId, state, timestamp, exitCode)

  Input:

  - sender -- .NET Refnum (BrickRED)
  - processId -- Int32
  - state -- Byte
  - timestamp -- Int64
  - exitCode -- Byte

  The following constants are available for this function:

  - 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

event `BrickRED.``ProgramSchedulerStateChanged`(sender, programId)

  Input:

  - sender -- .NET Refnum (BrickRED)
  - programId -- Int32

event `BrickRED.``ProgramProcessSpawned`(sender, programId)

  Input:

  - sender -- .NET Refnum (BrickRED)
  - programId -- Int32

### Constants

`BrickRED.``DEVICE_IDENTIFIER`

  This constant is used to identify a RED Brick.

  The `GetIdentity()` function and the `EnumerateCallback` callback of the IP Connection have a `deviceIdentifier` parameter to specify the Brick's or Bricklet's type.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.