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
Cameras
USB webcams on every platform, CSI cameras on the Raspberry Pi. H.264 video with a timing file that has one row per frame.
Audio
One USB microphone per module instance. 16-bit mono WAV with a timing file that has one row per chunk.
Eye tracker
Pupil Labs Neon over WiFi. Gaze, eye events, head motion, scene video and eye video.
Detection response task
Wired and wireless DRT units. One row per stimulus, with the reaction time measured on the device.
Visual occlusion goggles
Wired and wireless goggles. Total shutter open and closed time per trial, timed on the controller.
GPS (Raspberry Pi only)
BerryGPS receiver on the Pi's UART. Position, speed and heading, with the raw NMEA sentence in every row.
Notes
Annotations typed during a session, each with a timestamp.
Supported hardware
| Device | Connection | Module |
|---|---|---|
| USB webcams (UVC) | USB | Cameras |
| Raspberry Pi camera modules, including the IMX296 global-shutter camera (Raspberry Pi only) | CSI | Cameras |
| USB microphones | USB | Audio |
| Pupil Labs Neon | WiFi, through the Companion phone | Eye tracker |
| Detection response task, wired | USB serial | Detection response task |
| Detection response task, wireless | XBee radio with a USB coordinator | Detection response task |
| Visual occlusion goggles, wired | USB serial | Visual occlusion goggles |
| Visual occlusion goggles, wireless | XBee radio with a USB coordinator | Visual occlusion goggles |
| OzzMaker BerryGPS (Raspberry Pi only) | UART | GPS |
The detection response task and the visual occlusion goggles are Red Scientific instruments. The products page has their specifications.
Workflow
- Enable modulesCheck the modules you need in the Modules menu. Each starts in its own process and lists its devices in the Devices panel.
- Start a sessionClick Start under Session and choose a folder. RSLogger creates
session_YYYYMMDD_HHMMSSinside it. - Record a trialClick Record under Trial. Every enabled module records until you click Pause.
- RepeatRecord and Pause for each further trial. The trial number advances each time.
- 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
| Platform | Requirement |
|---|---|
| Windows | Windows 10 or later, 64-bit |
| macOS | macOS 14 (Sonoma) or later on Apple silicon |
| Linux | x86_64 with glibc 2.38 or newer, for example Ubuntu 24.04 or later |
| Raspberry Pi | From 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.
The GPS module and CSI cameras work only on the Raspberry Pi. Every other module works on every platform.