Overview

RSLogger documentation

RSLogger records cameras, audio, eye tracking, the DRT, the occlusion goggles, GPS and notes in one session, and stamps every record from one host clock.

RSLogger is free software from Red Scientific. It runs on Windows, macOS and Linux, and on a Raspberry Pi from source. Each recording module runs in its own process and writes CSV files, and every row carries two timestamps from the host computer, so records from different modules can be lined up after the session. These pages describe version 0.2.16.

Modules

Supported hardware

DeviceConnectionModule
USB webcams (UVC)USBCameras
Raspberry Pi camera modules, including the IMX296 global-shutter camera (Raspberry Pi only)CSICameras
USB microphonesUSBAudio
Pupil Labs NeonWiFi, through the Companion phoneEye tracker
Detection response task, wiredUSB serialDetection response task
Detection response task, wirelessXBee radio with a USB coordinatorDetection response task
Visual occlusion goggles, wiredUSB serialVisual occlusion goggles
Visual occlusion goggles, wirelessXBee radio with a USB coordinatorVisual occlusion goggles
OzzMaker BerryGPS (Raspberry Pi only)UARTGPS
Red Scientific hardware

The detection response task and the visual occlusion goggles are Red Scientific instruments. The products page has their specifications.

Workflow

  1. Enable modulesCheck the modules you need in the Modules menu. Each starts in its own process and lists its devices in the Devices panel.
  2. Start a sessionClick Start under Session and choose a folder. RSLogger creates session_YYYYMMDD_HHMMSS inside it.
  3. Record a trialClick Record under Trial. Every enabled module records until you click Pause.
  4. RepeatRecord and Pause for each further trial. The trial number advances each time.
  5. Stop the sessionClick Stop under Session.

Where the data goes

Every module writes into its own subfolder of the session folder. Cameras, audio, the eye tracker and notes write a file set per trial. The DRT, the goggles and GPS write one file per device for the whole session, with the trial number in each row. A control file at the top level records when each button was pressed.

session_YYYYMMDD_HHMMSS/
├── YYYYMMDD_HHMMSS_CONTROL.csv
├── Cameras/
│   └── <camera id>/
│       ├── YYYYMMDD_HHMMSS_CAM_trial001_<camera>.mp4
│       └── YYYYMMDD_HHMMSS_CAM_trial001_<camera>_timing.csv
├── Audio/
│   ├── YYYYMMDD_HHMMSS_AUD_trial001_MIC<n>_<microphone>.wav
│   └── YYYYMMDD_HHMMSS_AUD_trial001_MIC<n>_<microphone>_timing.csv
├── EyeTracker-Neon/
│   ├── YYYYMMDD_HHMMSS_ET_trial001_WORLD_1280x720_10fps.mp4
│   ├── YYYYMMDD_HHMMSS_ET_trial001_GAZE.csv
│   ├── YYYYMMDD_HHMMSS_ET_trial001_EVENTS.csv
│   └── YYYYMMDD_HHMMSS_ET_trial001_IMU.csv
├── DRT/
│   └── YYYYMMDD_HHMMSS_DRT_<device>.csv
├── VOG/
│   └── YYYYMMDD_HHMMSS_VOG_<port>.csv
├── GPS/
│   └── YYYYMMDD_HHMMSS_GPS_<device>.csv
└── Notes/
  └── YYYYMMDD_HHMMSS_NTS_trial001_notes.csv

Data output lists every column. Synchronization explains the timestamps.

System requirements

PlatformRequirement
WindowsWindows 10 or later, 64-bit
macOSmacOS 14 (Sonoma) or later on Apple silicon
Linuxx86_64 with glibc 2.38 or newer, for example Ubuntu 24.04 or later
Raspberry PiFrom source, supplied on request

There is nothing to install on Windows, macOS or Linux: download, extract and run. Getting started has the steps for each platform.

Raspberry Pi only

The GPS module and CSI cameras work only on the Raspberry Pi. Every other module works on every platform.