Skip to main content

File Reader

BRICKS TOOLS avatar
Written by BRICKS TOOLS
Updated over a week ago

The File Reader can be used as a processor for reading string-type files. It imports the file content and applies it as a string-format variable within the application.


  • Local Sync Section

RunMode

one of


List


When a display device has Local Sync enabled in the DEVICE settings, and multiple devices are running the same application on the same local network, you can configure how this processor is executed:

  • all: All devices execute the processor when triggered.

  • main-only: Only the device with the highest priority in Local Sync executes the processor when triggered.

  • minor-only: Only the device with the lowest priority in Local Sync executes the processor when triggered.


  • Properties Section

File Path

String (File/ URL)


Text string (file path / URL)

The file path of the file (URL or files from Media Box).


Configure the file path. You can choose to use a file uploaded to the Media Box, a File URL on the device, or an HTTP file path.

MD5

String


Text string (128-bit hash value)

The checksum of the file.


Automatically generated hash value, used to ensure file consistency and integrity during transmission.

Encoding

String


Text string


Configure the file encoding method (currently only UTF-8 is supported).

Trim Content

Boolean


Boolean value (Yes / No)


Configure whether to trim whitespace and line breaks from the beginning and end of the file content.


  • Outlets Section

Result


Output the result of the file read operation to a variable.

Error


Output the error result to a variable if the file read operation fails.


  • Operation Section

  • Inspect this Generator
    View the relationship flow between this Generator and its connected Events and Property Bank variables.

  • Event Routing
    Displays the flow of triggered events or calculations, showing which Bricks, Generators, or Properties are affected. This helps verify whether there are issues in the event connections between processors and components.

  • Parent Call
    Displays which Bricks, Generators, or Property Calculations triggered or are linked to this Generator. Unlike Event Routing, which examines downstream paths, Parent Call examines the upstream sources.

  • Copy
    Duplicate this Generator processor.

  • Remove this Generator
    Delete this Generator processor.

Did this answer your question?