File Reader

Node ID: fileReader · Role: Source · Realtime config: no

Description

Replays recorded sensor data from JSON line files. Supports rate control and all data types. Useful for offline analysis and testing.

Inputs / Outputs

Inputs: (none)
Outputs: Any

Config aliases

FileReader, fileReader, filereader

Properties

Each row shows the setting’s label in the node’s Properties panel and, in code, its key in the node’s settings object in the config file. A setting omitted from the config file uses the default shown here.

Property	Type	Default	Description
File Path `filename`	filepath	`""`	Path to the JSON-lines log file to replay.
Real-Time Playback `realTime`	boolean	`true`	Pace playback so wall-clock advances at the same rate as data timestamps. Disable to use Playback Interval instead (for deterministic test harnesses).
Loop Playback `loop`	boolean	`true`
Playback Interval (s) `playbackInterval`	number	`0.0`	Used only when Real-Time Playback is off. Fixed sleep between emitted samples in seconds (0 = no sleep, max speed).
Exit Process On End `exitOnEnd`	boolean	`false`	Exit the process when playback reaches end-of-file (used by deterministic test harnesses).

Example node definition

A minimal entry in config.json looks like the block below. Paste it under the sources key, keyed by an instance name of your choice. All settings are optional: anything not listed under settings uses the default from the Properties table above. See The configuration file for how the sections and endpoint wiring work.

{
  "sources": {
    "fileReader": {
      "outEndpoint": "inproc://fileReader_data",
      "settings": {}
    }
  }
}

Loading documentation…